ts-prune 项目教程

ts-prune 项目教程

ts-pruneFind unused exports in a typescript project. 🛀项目地址:https://gitcode.com/gh_mirrors/ts/ts-prune

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

ts-prune 项目的目录结构如下：

ts-prune/
├── integration/
│   └── src/
│       ├── eslintignore
│       ├── eslintrc.json
│       ├── gitignore
│       ├── README.md
│       ├── jest.config.js
│       ├── package.json
│       ├── tsconfig.json
│       └── yarn.lock
├── README.md
├── jest.config.js
├── package.json
├── tsconfig.json
└── yarn.lock

目录结构介绍：

• integration/: 包含集成测试相关的源代码。
  • src/: 集成测试的源代码目录。
    • eslintignore: ESLint 忽略文件。
    • eslintrc.json: ESLint 配置文件。
    • gitignore: Git 忽略文件。
    • README.md: 项目说明文件。
    • jest.config.js: Jest 测试配置文件。
    • package.json: 项目依赖配置文件。
    • tsconfig.json: TypeScript 配置文件。
    • yarn.lock: Yarn 锁定文件。
• README.md: 项目的主说明文件。
• jest.config.js: 主项目的 Jest 测试配置文件。
• package.json: 主项目的依赖配置文件。
• tsconfig.json: 主项目的 TypeScript 配置文件。
• yarn.lock: 主项目的 Yarn 锁定文件。

2. 项目的启动文件介绍

ts-prune 项目没有明确的启动文件，因为它是一个命令行工具。项目的入口点是通过 package.json 中的 bin 字段定义的。

在 package.json 中，你可以找到如下配置：

{
  "bin": {
    "ts-prune": "bin/ts-prune"
  }
}

这意味着当你安装并运行 ts-prune 命令时，实际上是执行 bin/ts-prune 文件。

3. 项目的配置文件介绍

3.1 tsconfig.json

tsconfig.json 是 TypeScript 项目的配置文件，定义了 TypeScript 编译器的选项。以下是 tsconfig.json 的一个示例：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"]
}

3.2 package.json

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

{
  "name": "ts-prune",
  "version": "1.0.0",
  "description": "Find unused exports in your Typescript project with zero configuration",
  "main": "index.js",
  "bin": {
    "ts-prune": "bin/ts-prune"
  },
  "scripts": {
    "find-deadcode": "ts-prune"
  },
  "dependencies": {
    "typescript": "^4.0.0"
  },
  "devDependencies": {
    "jest": "^26.0.0"
  }
}

3.3 jest.config.js

jest.config.js 是 Jest 测试框架的配置文件，定义了测试的选项和行为。以下是 jest.config.js 的一个示例：

module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  testMatch: ['**/?(*.)+(spec|test).[tj]s?(x)'],
  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
};

通过以上配置文件，你可以了解如何配置和使用 ts-prune 项目。

ts-pruneFind unused exports in a typescript project. 🛀项目地址:https://gitcode.com/gh_mirrors/ts/ts-prune