Skip to content

Support for defining custom tag syntax #366

Open

Description

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.

Activity

  1. braebo commented on Oct 8, 2023

    @braebo

    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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions