README.txt 1.24 KB
Newer Older
gumen's avatar
gumen committed
1
PRETTIER PLUGIN JSDOC
irekg's avatar
irekg committed
2

gumen's avatar
gumen committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
        Prettire plugin that extends default "babel-flow" parser with
        parser for JSDoc comments.

        Author      : @gumen
        Contributor : @VectorW

INSTALLATION

        1. Install and configure Prettier as usual
        2. Run $ npm i --save-dev https://gitlab.com/gumen/prettier-plugin-jsdoc.git
        3. Set "parser" value in Prettier options to "jsdoc-parser"

OPTIONS

        KEY                                 TYPE     DEFAULT

        jsdocSpaces                         Number   1
        jsdocPrintWidth                     Number   80
        jsdocDescriptionWithDot             Boolean  false
        jsdocDescriptionTag                 Boolean  false
        jsdocVerticalAlignment              Boolean  true
        jsdocUnionTypeParentheses           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


LINKS

        Prettier : https://prettier.io
        JSDoc    : https://jsdoc.app