Svelte Material UI 项目教程
1. 项目的目录结构及介绍
Svelte Material UI 项目的目录结构如下:
svelte-material-ui/
├── .github/
├── packages/
│ ├── button/
│ ├── card/
│ ├── ...
│ └── typography/
├── .gitignore
├── .prettierignore
├── .prettierrc
├── CHANGELOG.md
├── CONTRIBUTING.md
├── INSTALL.md
├── LICENSE
├── MIGRATING.md
├── README.md
├── REPL.md
├── SVELTEKIT.md
├── THEMING.md
├── TYPOGRAPHY.md
├── commitlint.config.js
├── lerna.json
├── package-lock.json
├── package-sh.sh
├── package.json
└── ...
目录结构介绍
.github/
: 包含 GitHub 相关的配置文件。packages/
: 包含各个 Material UI 组件的源代码。.gitignore
: 指定 Git 忽略的文件和目录。.prettierignore
: 指定 Prettier 忽略的文件和目录。.prettierrc
: Prettier 配置文件。CHANGELOG.md
: 项目更新日志。CONTRIBUTING.md
: 贡献指南。INSTALL.md
: 安装指南。LICENSE
: 项目许可证。MIGRATING.md
: 迁移指南。README.md
: 项目介绍和使用说明。REPL.md
: Svelte REPL 相关说明。SVELTEKIT.md
: SvelteKit 相关说明。THEMING.md
: 主题定制说明。TYPOGRAPHY.md
: 排版相关说明。commitlint.config.js
: commitlint 配置文件。lerna.json
: Lerna 配置文件。package-lock.json
: npm 依赖锁定文件。package-sh.sh
: 打包脚本。package.json
: 项目依赖和脚本配置。
2. 项目的启动文件介绍
Svelte Material UI 项目的启动文件主要是 package.json
中的脚本配置。以下是一些常用的脚本:
{
"scripts": {
"build": "lerna run build",
"dev": "lerna run dev",
"test": "lerna run test",
"lint": "lerna run lint",
"format": "prettier --write \"packages/**/*.{js,ts,svelte}\""
}
}
启动文件介绍
build
: 构建所有组件。dev
: 启动开发服务器。test
: 运行测试。lint
: 代码检查。format
: 代码格式化。
3. 项目的配置文件介绍
Svelte Material UI 项目的配置文件主要包括以下几个:
.prettierrc
: Prettier 格式化配置。lerna.json
: Lerna 多包管理配置。commitlint.config.js
: commitlint 提交信息检查配置。package.json
: 项目依赖和脚本配置。
配置文件介绍
.prettierrc
{
"singleQuote": true,
"trailingComma": "all",
"printWidth": 80
}
singleQuote
: 使用单引号。trailingComma
: 所有支持尾随逗号的地方都使用。printWidth
: 每行最大字符数。
lerna.json
{
"packages": [
"packages/*"
],
"version": "independent"
}
packages
: 指定包的目录。version
: 独立版本管理。
commitlint.config.js
module.exports = {
extends: ['@commitlint/config-conventional']
};
extends
: 使用@commitlint/config-conventional
配置。
package.json
{
"name": "svel