Support of Schema properties in ts-to-core-types

[pomgui]

Before anything: Great work! I'm using typeconv in some of my projects and I found it extremely useful.

However, AFAIU, the ts-to-core-types.ts module only supports a few schema properties when converting from jsDoc comment tags (e.g. example, see, default).

It would be great if it can also support all of the properties defined in OpenAPI3 Schema Object.

Example:

interface WorkingPerson {
  /**
   * @format uuid
   */
  uuid: string;
  /**
   * @format int32
   * @maximum 70
   * @minimum 5
   * @deprecated true
   */
  age: number;
}

As an exercise, I altered this project allowing the use of unlimited "custom" jsDoc tags, however I stopped when I realized that the allowed properties are kind a hard coded in other projects too (i.e. core-types interface CoreTypeAnnotations).

So my question is: Is there a reason for this?

[grantila]

I'm not sure how other systems would treat unknown such tags, so I limited it to what is known (e.g. jsdoc: https://jsdoc.app/). If there's a standard out there for annotating schema constraints (format, maximum, etc as you described) in jsdoc, I'm happy to add it.

Your example, in typescript; it would be fine to create such an object with age = 80, no editor/linter/compiler would pick that up and complain that age is above maximum, since that tag is not standard but "made up".

@deprecated in your case, should probably not have a value true but (if anything) an explanation, see https://jsdoc.app/tags-deprecated.html

I'm not against this, will just need to consider if there is previous work around this topic to piggy-back on (aligning json schema constraints with jsdoc tags specifically).