typeof-jsonc将JSONC转换为TypeScript接口

typeof-jsonc 的类型生成能力挺实用的,尤其适合你在用 JSON 或 JSONC 当配置文件时想直接推导成 TypeScript 接口的场景。它支持注释、支持嵌套结构自动合并,连数组类型也能识别得比较准确,省了不少手写 interface 的功夫。平时我一些配置文件,直接贴进去,生成出来的接口就能拿来用,响应也快,代码也清晰。

支持的类型挺全面的,基本类型、数组、嵌套对象都能搞定。像下面这种带注释的 JSONC:

{
  "barr": [ // aaa
    "aaa",
    "bbb"
  ],
  "name": "lanfeng", // this name
  /** this arr */
  "arr": [],
  "demo": {
    "hello": "world"
  }
}
生成的接口注释也会一并带上,等于自动给代码加了注解,写文档都省了。

安装也简单,直接来一句npm install typeof-jsonc -S或者yarn add typeof-jsonc -S就行,没什么门槛。哦对了,它对命名也挺智能,字段多了也不容易混。jsdoc 风格的注释它也能,和你配合jsdoc-tsimport-plugin这种插件一起用效果更好。

如果你平时会从 JSON 配置自动生成接口,或者想给文档注释自动化加点效率,那typeof-jsonc蛮值得一试。还有类似的工具可以参考一下,比如Tongoosejsdoc-tsimport-plugin这些也都挺配套的。

zip 文件大小:78.54KB