JSON Schema file for config

[adamjosefus]

Search Terms

json schema

Problem

Currently, the npm package does not contain a JSON schema file, unlike other popular libraries with JSON configurations. (e.g., BiomeJS, NX, and Turborepo).

Suggested Solution

Adding a JSON schema file to an NPM package increases developer experience (DX). Users will receive instant feedback from their IDE. This reduces frustration and the need to re-read documentation.

Inspiration: https://biomejs.dev/reference/configuration/

[Gerrit0]

TypeDoc publishes the JSON schema for the config at https://typedoc.org/schema.json, you can point your editor at that. If you're using VSCode, it will automatically be picked up due to https://github.com/microsoft/vscode/blob/3a5f69bb29627d8a9e35adbe4b3f6d5a7d2d6b47/extensions/typescript-language-features/package.json#L146-L149

Publishing each version's schema seems like a reasonable thing to do..