-
-
Notifications
You must be signed in to change notification settings - Fork 929
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.
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
Document fix and output behaviour for Node.js API usage #5971
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jlarmstrongiv Thank you for creating the pull request. LGTM 👍🏼
It might be better if we could add an example using the fix
option, but I want to hear @jeddy3's idea.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jlarmstrongiv Thanks for the pull request.
I've requested some changes.
As @ybiquitous suggested, lets add an "Example H". Something along the lines of:
Example H
Using a string and the fix
option:
stylelint
.lint({
code: "a { color: pink; }",
config: { rules: { "hue-degree-notation": "angle" } },
fix: true
})
.then(function () {
/* .. */
});
The autofixed code will be available as the value of the output
property in the returned object.
Co-authored-by: Richard Hallows <jeddy3@users.noreply.github.com>
Co-authored-by: Richard Hallows <jeddy3@users.noreply.github.com>
@jeddy3 great suggestions! I’ve updated the PR accordingly |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jlarmstrongiv Thanks for making those changes.
I've added two minor nits suggestions.
Let's also update the options page as detailed in #5971 (comment)
Co-authored-by: Richard Hallows <jeddy3@users.noreply.github.com>
Co-authored-by: Richard Hallows <jeddy3@users.noreply.github.com>
@jeddy3 thank you! Should be all set 🤞 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making the changes.
Almost there... the markdown is lost when copying and pasting.
Two suggestions are to add the link and backticks back in.
Co-authored-by: Richard Hallows <jeddy3@users.noreply.github.com>
Co-authored-by: Richard Hallows <jeddy3@users.noreply.github.com>
@jeddy3 great catch! Thank you for your patience |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, thanks!
Thank you for your patience
I'm always happy to help a first-time contributor to the project! 😄
Closes #5964
No, it’s documentation related.