JSON

$schema

http://www.ayqy.net/blog/vscode-json-validation/
vscode 支持读取 json schema 对 json 文件进行校验及智能提示补全等。

与 JSON 文件建立关联

有 3 种方式建立 JSON Schema 与 JSON 文件的关联:

  • 用户侧:通过用户设置(Settings)中的json.schemas选项来配置映射关系
  • 数据侧:在 JSON 数据中增加一个$schema字段,指向 JSON Schema
  • 第三方:通过 jsonValidation 扩展点配置映射关系

此处可查看支持的 json schema
https://www.schemastore.org/json/
可以看到存在 .eslintrc.json、prettierrc.json、babelrc.json、tsconfig.json 等常见配置文件

通用型配置确实适合用 json 来编写,这样直接采用 json 的格式发布也省去了还要用 ts 来获得智能提示再编译的麻烦,很不错。
#schema #vscode

TypeScript

typedoc

typedoc use case
https://github.com/TypeStrong/typedoc/blob/v0.22.9/example/src/showcase.ts#L117