Clean Code TypeScript 项目教程

Clean Code TypeScript 项目教程

clean-code-typescriptClean Code concepts adapted for TypeScript项目地址:https://gitcode.com/gh_mirrors/cl/clean-code-typescript

1. 项目的目录结构及介绍

Clean Code TypeScript 项目的目录结构如下：

clean-code-typescript/
├── README.md
├── book
│   ├── SUMMARY.md
│   ├── chapter-1.md
│   ├── chapter-2.md
│   ├── chapter-3.md
│   └── ...
├── code-examples
│   ├── example1.ts
│   ├── example2.ts
│   └── ...
└── .gitignore

目录结构介绍

• README.md: 项目的主介绍文件，包含项目的基本信息和使用说明。
• book/: 存放项目文档的目录，每个章节对应一个 .md 文件。
  • SUMMARY.md: 文档的目录结构文件，列出了所有章节及其链接。
  • chapter-1.md, chapter-2.md, ...: 各个章节的详细内容。
• code-examples/: 存放代码示例的目录，每个示例对应一个 .ts 文件。
• .gitignore: 指定 Git 忽略的文件和目录。

2. 项目的启动文件介绍

Clean Code TypeScript 项目没有传统的启动文件，因为它主要是一个文档和代码示例的集合。如果需要运行代码示例，可以直接使用 TypeScript 编译器（tsc）编译并运行 .ts 文件。

3. 项目的配置文件介绍

Clean Code TypeScript 项目没有特定的配置文件，因为它不包含需要配置的应用程序或服务。如果需要编译 TypeScript 代码，可以使用 TypeScript 的默认配置或自定义 tsconfig.json 文件。

示例 tsconfig.json 文件

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["code-examples/**/*.ts"]
}

这个配置文件指定了编译选项和包含的文件路径，可以将 TypeScript 代码编译到 dist 目录中。

clean-code-typescriptClean Code concepts adapted for TypeScript项目地址:https://gitcode.com/gh_mirrors/cl/clean-code-typescript