microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.68k stars 131 forks source link

Support for defining custom tag syntax #366

Open oliveryasuna opened 11 months ago

oliveryasuna commented 11 months ago

Example:

I want to use supported JSDoc tags with @custom-elements-manifest/analyzer:

/**
 * @prop {string} dir - The directionality of the element.
 * @prop {string} lang - The language of the element.
 */

Problem:

There is no way to define custom tags that support this format.

// tsdoc.json
{
  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
  "extends": ["@microsoft/api-extractor/extends/tsdoc-base.json"],
  "tagDefinitions": [
    {
      "tagName": "@prop",
      "syntaxKind": "modifier",
      "allowMultiple": true
    }
  ],
  "supportForTags": {
    "@prop": true
  }
}

ESLint will not pass.

Proposal:

Support custom tag syntax, perhaps through regex. Further, it would be nice if you could omit specifying the syntax kind, such that the parser would allow the content following the tag to be whatever.

braebo commented 9 months ago

Is this what "noStandardTags": true, is for? I thought it was mean to allow you to disable the default behavior in case you want to override it yourself.