Generate JSON Schema from TypeScript

[azu]

textlint-script build can generate JSON Schema of rule options from TypeScript type definition.

It allows textlint to introduce option validation and help us to create dynamic option UI.

• YousefED/typescript-json-schema: Generate json-schema from your Typescript sources

mport * as TJS from "typescript-json-schema";
import path from "path";

    const settings: TJS.PartialArgs = {
        required: true
    };
    const compilerOptions: TJS.CompilerOptions = {
        strictNullChecks: true
    };
    const basePath = path.join(__dirname, "fixtures");
    const program = TJS.getProgramFromFiles(
        [path.join(__dirname, "fixtures/rule.ts")],
        compilerOptions,
        basePath
    );
    const schema = TJS.generateSchema(program, "Options", settings);
    console.log(schema);

input

import type { TextlintRuleModule } from "@textlint/types";

export type Options = {
    k1: string;
    k2: number;
    k3: {
        k3a: string;
    }
}
const reporter: TextlintRuleModule<Options> = (_context) => {
    return {};
};
export default {
    linter: reporter,
    fixer: reporter
};

output

{
  type: 'object',
  properties: {
    k1: { type: 'string' },
    k2: { type: 'number' },
    k3: { type: 'object', properties: [Object], required: [Array] }
  },
  required: [ 'k1', 'k2', 'k3' ],
  '$schema': 'http://json-schema.org/draft-07/schema#'
}