Setting description of index mapped keys

[Ririshi]

I am trying to validate a JSON configuration using typescript-json-schema and ajv.
I would like to add a description to every field in the schema. This works for every field, except the [env: string] key, which is grabbing the comment that is written above the source code of PartialDeep<T> (from type-fest), instead of using the supplied description.

export type ConfigJson = {
  /**
   * Schema definition reference
   */
  $schema: string;
  /**
   * Configuration per environment
   */
  environments: {
    /**
     * Specific configuration for this environment
     */
    [env: string]: PartialDeep<Config>;
  };
  /**
   * Global configuration
   */
  global: PartialDeep<Config>;
};

The schema comes out like this:

"definitions": {
        "PartialObjectDeep<Config>": {
            "...": "...",
            "description": "Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.",
            "...": "...",
            },
            "type": "object"
        },
        ...
    },
    "properties": {
        "...": "...",
        "environments": {
            "additionalProperties": {
                "$ref": "#/definitions/PartialObjectDeep<Config>"
            },
            "description": "Configuration per environment",
            "type": "object"
        },
        "...": "...",
    },

[domoritz]

Have you tried https://github.com/vega/ts-json-schema-generator?

[Ririshi]

That's a very quick response, thanks! I'll try it. Isn't it something you would want to fix? Assuming it is a bug and not a feature, of course.

Edit: I tried using ts-json-schema-generator both programmatically and through the node binary, but it doesn't seem to be working for me. It's throwing Cannot find module ... and Cannot find namespace ... errors at me. I think it doesn't like Yarn 2.

[domoritz]

Thanks for trying. I haven't used yarn 2 so it might not work well with it.

I wanted to see whether ts-json-schema-generator works since we could use the generated schema as a test case.

Unfortunately, I don't have the cycles to fix the bug here but I marked this issue as a bug.

[Ririshi]

I'll open a ticket on the other github repo for this issue and see if I can make it work with Yarn 2!

[domoritz]

Looks like ts-json-schema-generator supports your use case.

yarn run run -p test.ts -t ConfigJson
yarn run v1.22.10
$ ts-node ts-json-schema-generator.ts -p test.ts -t ConfigJson
{
  "$ref": "#/definitions/ConfigJson",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "ConfigJson": {
      "additionalProperties": false,
      "properties": {
        "$schema": {
          "description": "Schema definition reference",
          "type": "string"
        },
        "environments": {
          "additionalProperties": {
            "additionalProperties": false,
            "description": "Specific configuration for this environment",
            "type": "object"
          },
          "description": "Configuration per environment",
          "type": "object"
        },
        "global": {
          "additionalProperties": false,
          "description": "Global configuration",
          "type": "object"
        }
      },
      "required": [
        "$schema",
        "environments",
        "global"
      ],
      "type": "object"
    }
  }
}

[Ririshi]

That's reassuring! Just have to figure out how to make it work now.