Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document fix and output behaviour for Node.js API usage #5971

Merged
merged 9 commits into from
Mar 17, 2022
Merged

Document fix and output behaviour for Node.js API usage #5971

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fdea1fe
Document fix and output behaviour for Node.js API usage
jlarmstrongiv Mar 16, 2022
07fccbc
Update docs/user-guide/usage/node-api.md with clearer output description
jlarmstrongiv Mar 17, 2022
eacbcd8
Dedupe `fix` in docs/user-guide/usage/node-api.md
jlarmstrongiv Mar 17, 2022
44655c3
Add example in docs/user-guide/usage/node-api.md
jlarmstrongiv Mar 17, 2022
e2f4808
dedupe fix option
jlarmstrongiv Mar 17, 2022
af395ca
Update formatting in docs/user-guide/usage/node-api.md
jlarmstrongiv Mar 17, 2022
38e932e
Update formatting in docs/user-guide/usage/node-api.md
jlarmstrongiv Mar 17, 2022
ec149c2
Fix markdown docs/user-guide/usage/options.md
jlarmstrongiv Mar 17, 2022
33c476d
Fix markdown docs/user-guide/usage/options.md
jlarmstrongiv Mar 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/user-guide/usage/node-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ Stylelint does not bother looking for a `.stylelintrc` file if you use this opti

A string to lint.

### `fix`

Boolean. If `true`, the autofixed code is available as the value of the output property in the returned object.

jlarmstrongiv marked this conversation as resolved.
Show resolved Hide resolved
### `cwd`

The directory from which Stylelint will look for files. Defaults to the current working directory returned by `process.cwd()`.
Expand Down Expand Up @@ -58,6 +62,8 @@ Boolean. If `true`, at least one rule with an "error"-level severity registered

A string displaying the formatted problems (using the default formatter or whichever you passed).

If the `fix` option is set to `true`, a string displaying the autofixed code.

jlarmstrongiv marked this conversation as resolved.
Show resolved Hide resolved
### `postcssResults`

An array containing all the accumulated [PostCSS LazyResults](https://api.postcss.org/LazyResult.html).
Expand Down