1. 程式人生 > >TypeScript 型別定義檔案(*.d.ts)自動生成工具

TypeScript 型別定義檔案(*.d.ts)自動生成工具

在開發ts時,有時會遇到沒有d.ts檔案的庫,同時在老專案遷移到ts專案時也會遇到一些檔案需要自己編寫宣告檔案,但是在需要的宣告檔案比較多的情況,就需要自動生產宣告檔案。用過幾個庫。今天簡單記錄一下。自己怎麼編寫有很多教程和文件,那裡就不介紹了。

1、為整個包新增宣告檔案

使用微軟的dts-gen

簡單使用

npm install -g dts-gen   // 先全域性安裝dts-gen
npm install -g yargs     // 然後在全域性安裝你需要生產宣告檔案的庫
dts-gen -m yargs         // 執行命令生成檔案

在你執行的檔案的路徑下(一般是專案的根目錄)生成了yargs.d.ts

其他引數和功能自行參考文件

2、為單個檔案生產宣告檔案

使用dtsmake

簡單使用

npm i dtsmake -g   // 先全域性安裝dtsmake

dtsmake -s ./path/to/sourcefile.js  // 在對應的檔案生產檔案

說明:

  • 生成的檔案一般都會有一些問題,需要自己稍微修改一下,如果不想寫型別直接用any
  • 執行的時候可能會報錯tern沒有按裝,就需要在安裝一下,在專案目錄 npm i tern --save-dev

其他引數和功能自行參考文件

其他

  • dtsgenerator
     - d.ts file generator tool, for only JSON Schema files.
  • js2tsd - d.ts file generator tool, no type inferrence.
  • JS2TSD d.ts file generator GUI tool app. Not CLI.

1、為整個包新增宣告檔案

使用微軟的dts-gen

簡單使用

npm install -g dts-gen   // 先全域性安裝dts-gen
npm install -g yargs     // 然後在全域性安裝你需要生產宣告檔案的庫
dts-gen -m yargs         // 執行命令生成檔案

在你執行的檔案的路徑下(一般是專案的根目錄)生成了yargs.d.ts

其他引數和功能自行參考文件

2、為單個檔案生產宣告檔案

使用dtsmake

簡單使用

npm i dtsmake -g   // 先全域性安裝dtsmake

dtsmake -s ./path/to/sourcefile.js  // 在對應的檔案生產檔案

說明:

  • 生成的檔案一般都會有一些問題,需要自己稍微修改一下,如果不想寫型別直接用any
  • 執行的時候可能會報錯tern沒有按裝,就需要在安裝一下,在專案目錄 npm i tern --save-dev

其他引數和功能自行參考文件

其他

  • dtsgenerator - d.ts file generator tool, for only JSON Schema files.
  • js2tsd - d.ts file generator tool, no type inferrence.
  • JS2TSD d.ts file generator GUI tool app. Not CLI.