TypeScript 学习项目教程

TypeScript 学习项目教程

typescript-learnA repo to learn ts.项目地址:https://gitcode.com/gh_mirrors/ty/typescript-learn

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

typescript-learn/
├── src/
│   ├── basics/
│   │   ├── variables.ts
│   │   ├── functions.ts
│   │   └── ...
│   ├── advanced/
│   │   ├── generics.ts
│   │   ├── interfaces.ts
│   │   └── ...
│   └── index.ts
├── tests/
│   ├── basics.test.ts
│   ├── advanced.test.ts
│   └── ...
├── package.json
├── tsconfig.json
└── README.md

目录结构说明

• src/: 包含项目的所有源代码文件。
  • basics/: 包含基础的 TypeScript 示例代码。
  • advanced/: 包含高级的 TypeScript 示例代码。
  • index.ts: 项目的入口文件。
• tests/: 包含项目的测试文件。
• package.json: 项目的依赖和脚本配置文件。
• tsconfig.json: TypeScript 编译配置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

index.ts

index.ts 是项目的入口文件，负责启动整个应用程序。它通常会导入并执行其他模块中的代码。

import { runBasics } from './basics/variables';
import { runAdvanced } from './advanced/generics';

runBasics();
runAdvanced();

启动文件说明

• runBasics(): 执行基础示例代码。
• runAdvanced(): 执行高级示例代码。

3. 项目的配置文件介绍

tsconfig.json

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

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

配置文件说明

• target: 指定编译后的 JavaScript 版本。
• module: 指定模块系统。
• outDir: 指定编译输出目录。
• strict: 启用所有严格类型检查选项。
• esModuleInterop: 允许使用 ES 模块语法导入 CommonJS 模块。
• include: 指定包含的文件和目录。

package.json

package.json 是 Node.js 项目的配置文件，包含项目的依赖、脚本和其他元数据。

{
  "name": "typescript-learn",
  "version": "1.0.0",
  "scripts": {
    "build": "tsc",
    "start": "node dist/index.js",
    "test": "jest"
  },
  "dependencies": {
    "typescript": "^4.0.0"
  },
  "devDependencies": {
    "@types/jest": "^26.0.0",
    "jest": "^26.0.0",
    "ts-jest": "^26.0.0"
  }
}

配置文件说明

• scripts: 定义项目的脚本命令。
  • build: 使用 tsc 编译 TypeScript 代码。
  • start: 启动编译后的 JavaScript 代码。
  • test: 运行测试。
• dependencies: 项目的运行时依赖。
• devDependencies: 开发环境依赖。

以上是 TypeScript 学习项目的教程，涵盖了项目的目录结构、启动文件和配置文件的详细介绍。希望这些内容能帮助你更好地理解和使用该项目。

typescript-learnA repo to learn ts.项目地址:https://gitcode.com/gh_mirrors/ty/typescript-learn