Basti 项目使用教程
1. 项目的目录结构及介绍
Basti 项目的目录结构如下:
basti-app/basti/
├── docs/
├── packages/
├── .eslintignore
├── .eslintrc.json
├── .gitignore
├── .prettierignore
├── .prettierrc.js
├── .tool-versions
├── LICENSE
├── README.md
├── SECURITY.md
├── jest.config.js
├── package-lock.json
├── package.json
└── tsconfig.json
目录结构介绍
docs/
: 存放项目文档文件。packages/
: 存放项目的主要代码包。.eslintignore
: 配置 ESLint 忽略的文件和目录。.eslintrc.json
: ESLint 配置文件。.gitignore
: Git 忽略的文件和目录。.prettierignore
: Prettier 忽略的文件和目录。.prettierrc.js
: Prettier 配置文件。.tool-versions
: 工具版本配置文件。LICENSE
: 项目许可证文件。README.md
: 项目说明文档。SECURITY.md
: 安全相关文档。jest.config.js
: Jest 测试配置文件。package-lock.json
: npm 依赖锁定文件。package.json
: 项目依赖和脚本配置文件。tsconfig.json
: TypeScript 配置文件。
2. 项目的启动文件介绍
Basti 项目的启动文件主要是 package.json
中的脚本配置。以下是一些关键的启动脚本:
{
"scripts": {
"start": "node index.js",
"build": "tsc",
"test": "jest"
}
}
启动文件介绍
start
: 启动项目的命令,通常指向index.js
文件。build
: 构建项目的命令,使用 TypeScript 编译器tsc
。test
: 运行测试的命令,使用 Jest 测试框架。
3. 项目的配置文件介绍
Basti 项目的主要配置文件包括:
.eslintrc.json
: ESLint 配置文件,用于代码风格和质量检查。.prettierrc.js
: Prettier 配置文件,用于代码格式化。tsconfig.json
: TypeScript 配置文件,用于 TypeScript 编译选项。jest.config.js
: Jest 测试配置文件,用于测试框架的配置。
配置文件介绍
.eslintrc.json
{
"extends": ["eslint:recommended", "prettier"],
"plugins": ["prettier"],
"rules": {
"prettier/prettier": "error"
}
}
extends
: 继承的 ESLint 配置。plugins
: 使用的 ESLint 插件。rules
: 自定义的 ESLint 规则。
.prettierrc.js
module.exports = {
singleQuote: true,
trailingComma: 'all',
printWidth: 80
};
singleQuote
: 使用单引号。trailingComma
: 尾随逗号。printWidth
: 每行最大字符数。
tsconfig.json
{
"compilerOptions": {
"target": "ES6",
"module": "commonjs",
"outDir": "./dist",
"strict": true
},
"include": ["src/**/*"]
}
compilerOptions
: TypeScript 编译选项。target
: 编译目标版本。module
: 模块系统。outDir
: 输出目录。strict
: 严格模式。include
: 包含的文件和目录。
jest.config.js
module.exports = {
testEnvironment: 'node',
testMatch: ['**/*.test.ts'],
transform: {
'^.+\\.ts$': 'ts-jest'