TypeScript JSDoc Tag Completions Plugin

This plugin provides jsdoc tag completion and completion details. (with document of tag

• In the Preset API, by defining documentation and syntax for each tag,
  it will be displayed in the completion detail.

How to try?

$ npm install --save-dev typescript typescript-jsdoctag-completions-plugin

next, configure plugin to tsconfig.json.

{
  "compilerOptions": {
    "target": "es2019",
    "module": "esnext",
    "strict": true,
    // In TypeScript 5.x, compilerOptions/locale was removed,
    // so Moved locale to plugin settings.
    // however, for older versions of ts,
    // this value is still referenced as before from this plugin.
    // "locale": "ja",
    "plugins": [
      {
        "name": "typescript-jsdoctag-completions-plugin",
        // Plugin specific configuration
        // builtin preset is "default" and "closure".
        // If you want to use a jsdoc tag preset that you have defined yourself based on the preset API,
        // specify the path of that module.
        "preset": "closure",
        "verbose": true,     // enable/disable plugin logging
        // plugin refers to the value of `@compilerOptions/plugins[@name=typescript-jsdoctag-completions-plugin]/locale`
        // If not set, use the OS locale
        "locale": "ja"
      }
    ]
  }
}

then launch Visula Studio Code, etc

About JSDoc Tag Preset

• plugin builtin

Preset name	Details
default	TypeScript builtin JSDoc Tags with Inline JSDoc Tags
closure	Closure Compiler JSDoc Tags

• external defined preset

  • To create your own preset, implement TJSDocTagRawPreset as defined in preset-api.d.ts

Locale priority

• The priority to which the locale applies

  • #1 ts project (tsconfig.json etc)

    • #1-2 vscode setting (vscode extension vscode-typescript-jsdoctag-completions)

  • #2 OS native

License

This project is licensed under the MIT License - see the LICENSE file for details