testea/test-repo
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add CLI flag for debugging comment attachment issues (#10124)

Browse Source
This commit is contained in:
Georgii Dolzhykov authored and GitHub committed 2021-01-27 12:30:10 +02:00
1 parent 63a771db55
commit 79d2f4a295
14 files changed
+169 -18
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/plugins.md
+2
View File
@@ -351,6 +351,8 @@ Nodes with comments are expected to have a `comments` property containing an arr
The example above uses `util.addTrailingComment`, which automatically sets `comment.leading`/`trailing`/`printed` to appropriate values and adds the comment to the AST node's `comments` array.
The `--debug-print-comments` CLI flag can help with debugging comment attachment issues. It prints a detailed list of comments, which includes information on how every comment was classified (`ownLine`/`endOfLine`/`remaining`, `leading`/`trailing`/`dangling`) and to which node it was attached. For Prettier’s built-in languages, this information is also available on the Playground (the 'show comments' checkbox in the Debug section).
### `options`
`options` is an object containing the custom options your plugin supports.