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,
    // plugin refers to the value of `@compilerOptions/locale`
    // If not set, use the OS locale
    "locale": "ja",
    "plugins": [
      {
        "name": "typescript-jsdoctag-completions-plugin",
        // Plugin specific configuration
        "preset": "closure", // builtin preset is "default" and "closure"
        "verbose": true      // enable/disable plugin logging
      }
    ]
  }
}

then launch vscode, 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