Package Exports
- prettier-plugin-jsdoc
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (prettier-plugin-jsdoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
prettier-plugin-jsdoc
Prettier plugin for format jsdoc and convert to standard Match with Visual studio and other IDE which support jsdoc
TOC
Installation
- Install and configure Prettier as usual
npm i prettier-plugin-jsdoc --saveyarn add prettier-plugin-jsdoc- Set "parser" value in Prettier options to "jsdoc-parser"
Options
| Key | type | Default |
|---|---|---|
| jsdocSpaces | Number | 1 |
| jsdocDescriptionWithDot | Boolean | false |
| jsdocDescriptionTag | Boolean | false |
| jsdocVerticalAlignment | Boolean | false |
| jsdocKeepUnParseAbleExampleIndent | Boolean | true |
Full up to date list and description of options can be found in Prettier help. First install plugin then run Prettier with "--help" option.
$ prettier --help # global installation
$ ./node_modules/.bin/prettier --help # local installation