TypeScript 库启动模板教程

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

starter-ts/
├── .github/
│   └── workflows/
├── .vscode/
│   └── extensions.json
├── src/
│   ├── index.ts
│   └── lib/
├── .editorconfig
├── .eslintrc.js
├── .gitignore
├── .prettierrc
├── LICENSE
├── package.json
├── README.md
├── tsconfig.json
└── yarn.lock

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .vscode/: 包含 VSCode 的扩展推荐配置。
• src/: 项目的源代码目录，包含主要的 TypeScript 文件。
  • index.ts: 项目的入口文件。
  • lib/: 存放项目的主要功能模块。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .eslintrc.js: ESLint 配置文件，用于代码检查。
• .gitignore: Git 忽略文件配置。
• .prettierrc: Prettier 配置文件，用于代码格式化。
• LICENSE: 项目的开源许可证。
• package.json: 项目的依赖和脚本配置。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 的依赖锁定文件。

2. 项目的启动文件介绍

src/index.ts

index.ts 是项目的入口文件，通常用于初始化项目的主要功能模块。以下是一个简单的示例：

import { someFunction } from './lib/someModule';

console.log('项目启动...');
someFunction();

在这个文件中，你可以导入并调用项目中的其他模块，以启动整个项目。

3. 项目的配置文件介绍

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，用于配置 TypeScript 编译器的行为。以下是一个常见的配置示例：

{
  "compilerOptions": {
    "target": "ESNext",
    "module": "ESNext",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "outDir": "./dist",
    "rootDir": "./src"
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

.eslintrc.js

.eslintrc.js 是 ESLint 的配置文件，用于配置代码检查规则。以下是一个常见的配置示例：

module.exports = {
  root: true,
  parser: '@typescript-eslint/parser',
  plugins: ['@typescript-eslint'],
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
    'prettier',
  ],
  rules: {
    // 自定义规则
  },
};

package.json

package.json 是 Node.js 项目的配置文件，包含了项目的依赖、脚本等信息。以下是一个常见的配置示例：

{
  "name": "starter-ts",
  "version": "1.0.0",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "start": "node dist/index.js",
    "lint": "eslint src/**/*.ts",
    "test": "jest"
  },
  "dependencies": {
    "some-dependency": "^1.0.0"
  },
  "devDependencies": {
    "@types/node": "^14.0.0",
    "typescript": "^4.0.0",
    "eslint": "^7.0.0",
    "jest": "^26.0.0"
  }
}

通过这些配置文件，你可以定制项目的编译、代码检查、测试等行为。