Mort 项目使用教程

1. 项目目录结构及介绍

Mort 项目的目录结构如下：

mort/
├── dist/
├── src/
├── test/
├── .gitignore
├── .travis.yml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── build.sh
├── package.json
├── tsconfig.json
└── tslint.json

目录介绍

• dist/: 存放编译后的文件。
• src/: 存放项目的源代码。
• test/: 存放测试文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• build.sh: 构建脚本。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 配置文件。
• tslint.json: TSLint 配置文件。

2. 项目启动文件介绍

Mort 项目的启动文件是 build.sh。这个脚本用于构建项目，通常在项目开发或部署时使用。

启动步骤

1. 打开终端。
2. 导航到项目根目录。
3. 运行以下命令：

./build.sh

3. 项目配置文件介绍

package.json

package.json 是 Node.js 项目的核心配置文件，包含项目的元数据和依赖项。

{
  "name": "mort",
  "version": "1.0.0",
  "description": "Dead CSS detection",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "joereynolds",
  "license": "MIT",
  "dependencies": {
    "some-dependency": "^1.0.0"
  }
}

tsconfig.json

tsconfig.json 是 TypeScript 项目的配置文件，用于指定编译选项。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true
  }
}

tslint.json

tslint.json 是 TSLint 的配置文件，用于定义代码风格和规则。

{
  "defaultSeverity": "error",
  "extends": [
    "tslint:recommended"
  ],
  "jsRules": {},
  "rules": {
    "no-console": false
  },
  "rulesDirectory": []
}

通过以上配置文件，可以对 Mort 项目进行定制和优化。