TypeScript 库启动器教程

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

typescript-lib-starter/
├── .github/
│   └── workflows/
├── .vscode/
├── src/
│   ├── index.ts
│   └── ...
├── tests/
│   └── ...
├── .editorconfig
├── .gitignore
├── .prettierrc
├── jest.config.js
├── LICENSE
├── package.json
├── README.md
├── tsconfig.json
└── tslint.json

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .vscode/: 包含 Visual Studio Code 的配置文件。
• src/: 包含项目的源代码文件。
• tests/: 包含项目的测试文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置。
• .prettierrc: Prettier 代码格式化配置。
• jest.config.js: Jest 测试框架配置。
• LICENSE: 项目许可证。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 编译配置。
• tslint.json: TSLint 代码检查配置。

2. 项目的启动文件介绍

项目的启动文件位于 src/index.ts。这是库的入口文件，通常包含库的主要功能和导出。

// src/index.ts
export function exampleFunction() {
  return "Hello, world!";
}

3. 项目的配置文件介绍

tsconfig.json

TypeScript 编译配置文件，定义了编译选项和编译目标。

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

tslint.json

TSLint 代码检查配置文件，定义了代码风格和检查规则。

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

package.json

项目依赖和脚本配置文件。

{
  "name": "typescript-lib-starter",
  "version": "1.0.0",
  "description": "A starter project for TypeScript libraries",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {},
  "devDependencies": {
    "@types/jest": "^26.0.0",
    "jest": "^26.0.0",
    "ts-jest": "^26.0.0",
    "typescript": "^4.0.0"
  }
}

通过以上配置，您可以开始使用 TypeScript 库启动器来构建和发布您的 TypeScript 库。