TypeScript Library Starter 项目教程

TypeScript Library Starter 项目教程

typescript-library-starterStarter kit with zero-config for building a library in TypeScript, featuring RollupJS, Jest, Prettier, TSLint, Semantic Release, and more!项目地址:https://gitcode.com/gh_mirrors/ty/typescript-library-starter

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

TypeScript Library Starter 项目的目录结构如下：

typescript-library-starter/
├── .github/
│   └── workflows/
│       └── main.yml
├── .vscode/
│   └── settings.json
├── src/
│   ├── index.ts
│   └── ...
├── test/
│   ├── index.test.ts
│   └── ...
├── .editorconfig
├── .gitignore
├── .npmrc
├── .prettierrc
├── LICENSE
├── package.json
├── README.md
├── tsconfig.json
└── tslint.json

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .vscode/: 包含 Visual Studio Code 的设置文件。
• src/: 包含项目的源代码文件。
• test/: 包含项目的测试文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• LICENSE: 项目许可证文件。
• package.json: 项目的 npm 配置文件。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。
• tslint.json: TSLint 配置文件。

2. 项目的启动文件介绍

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

// src/index.ts
export const hello = (name: string) => {
  return `Hello, ${name}!`;
};

3. 项目的配置文件介绍

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，用于配置 TypeScript 编译器的行为。

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

package.json

package.json 是 npm 的配置文件，包含项目的基本信息、依赖项和脚本命令。

{
  "name": "typescript-library-starter",
  "version": "1.0.0",
  "description": "A starter project for TypeScript libraries",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {},
  "devDependencies": {
    "@types/jest": "^26.0.15",
    "jest": "^26.6.3",
    "ts-jest": "^26.4.4",
    "typescript": "^4.0.5"
  }
}

.prettierrc

.prettierrc 是 Prettier 的配置文件，用于格式化代码。

{
  "singleQuote": true,
  "trailingComma": "all"
}

tslint.json

tslint.json 是 TSLint 的配置文件，用于检查 TypeScript 代码的风格。

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

以上是 TypeScript Library Starter 项目的主要配置文件介绍。

typescript-library-starterStarter kit with zero-config for building a library in TypeScript, featuring RollupJS, Jest, Prettier, TSLint, Semantic Release, and more!项目地址:https://gitcode.com/gh_mirrors/ty/typescript-library-starter