Commit 39c82a3c authored by gumen's avatar gumen 🐢

Update README.txt file

parent 3c697cfb
prettier-plugin-jsdoc
PRETTIER PLUGIN JSDOC
Author: @gumen
Contributor: @VectorW
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
TODO
Fill README file with useful informations like description of options
Investigate sorting of over 10 tags - failing test in ./tests/main.js:209
Release first version
Mention plugin in https://github.com/prettier/prettier/issues/5659
Investigate sorting of over 10 tags - failing test in ./tests/main.js:209
* Golden Hour
:LOGBOOK:
CLOCK: [2020-01-30 czw 16:39]--[2020-01-30 czw 17:23] => 0:44
CLOCK: [2020-01-30 czw 15:12]--[2020-01-30 czw 15:54] => 0:42
CLOCK: [2020-01-24 pią 15:54]--[2020-01-24 pią 16:42] => 0:48
CLOCK: [2020-01-24 pią 14:48]--[2020-01-24 pią 15:32] => 0:44
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment