ts-transformer-keys 项目教程

ts-transformer-keys 项目教程

ts-transformer-keysA TypeScript custom transformer which enables to obtain keys of given type项目地址:https://gitcode.com/gh_mirrors/ts/ts-transformer-keys

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

ts-transformer-keys/
├── src/
│   ├── index.ts
│   ├── transformer.ts
│   └── util.ts
├── package.json
├── tsconfig.json
└── README.md

• src/：包含项目的主要源代码文件。
  • index.ts：项目的入口文件。
  • transformer.ts：实现 TypeScript 转换器的主要逻辑。
  • util.ts：包含一些辅助函数。
• package.json：项目的依赖和脚本配置文件。
• tsconfig.json：TypeScript 编译配置文件。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts。这个文件是整个项目的入口点，负责导出项目的主要功能和接口。

// src/index.ts
export { default as keys } from './transformer';

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "ts-transformer-keys",
  "version": "0.4.4",
  "description": "A TypeScript custom transformer which enables to obtain keys of given type",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "author": "kimamula",
  "license": "MIT",
  "devDependencies": {
    "@types/jest": "^26.0.15",
    "jest": "^26.6.3",
    "ts-jest": "^26.4.4",
    "typescript": "^4.0.5"
  }
}

tsconfig.json

tsconfig.json 文件定义了 TypeScript 编译器的配置选项。

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

以上是 ts-transformer-keys 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

ts-transformer-keysA TypeScript custom transformer which enables to obtain keys of given type项目地址:https://gitcode.com/gh_mirrors/ts/ts-transformer-keys