typeof-jsonc 將 JSONC/JSON 轉換爲 TypeScript 聲明

一、TypeScript 帶來的好處

TypeScript 提供了靜態類型檢查，帶來了以下好處：

• 質量：靜態類型檢查，規避類型錯誤
• 高效：結合編輯器，智能提示，加快開發速度和保證代碼質量
• 重構：靜態類型檢查，重構低風險
• 可讀：類型聲明使代碼更可讀

二、開發中存在的類型聲明成本

開發過程當中須要更多的類型，以讓 TypeScript 的效果更好，特別是先後端協做時，將接口文檔信息轉換爲 TypeScript 類型聲明，來保證項目質量。 可是手動的根據後端接口文檔進行編輯，帶來很高的編輯成本。

三、下降接口文檔到 TS 聲明成本的方案

typeof-jsonc lib 庫支持將 jsonc 字符串轉換爲 TS 聲明

待轉換接口示例

{
  "code": 0,
  "data": {
        // this is name
        "name": "hello",
        // this is age
        "age": 18
  },
  "msg": "success"
}
複製代碼

typeof-jsonc 轉換結果

export interface IResponseData {
    code: number;
    data: IData;
    msg: string;
}

export interface IData {
    /** * this is name */
    name: string;
    /** * this is age */
    age: number;
}

複製代碼

線上工具截圖

四、typeof-jsonc 特性

• 支持基本類型
• 支持數組類型合併
• 支持註釋解析
• 自定義類型名
• 支持 jsonc、json、非標準的 jsonc/json 格式