Add customSyntax option to configuration object (#4843)
#5538
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hudochenkov
commented
Sep 14, 2021
| @@ -1,3 +1,3 @@ | |||
| 'use strict'; | |||
|
|
|||
| module.exports = require('postcss-safe-parser/lib/safe-parse'); | |||
| module.exports = require('postcss-safe-parser'); | |||
There was a problem hiding this comment.
Avoid using internals.
hudochenkov
commented
Sep 14, 2021
Comment on lines
+5
to
+8
| module.exports = { | ||
| parse: postcssScss.parse, | ||
| stringify: postcssScss.stringify, | ||
| }; |
There was a problem hiding this comment.
Better represents custom syntax.
hudochenkov
commented
Sep 14, 2021
Comment on lines
+100
to
+144
| it('standalone with custom syntax as npm package name', () => { | ||
| const config = { | ||
| rules: { | ||
| 'block-no-empty': true, | ||
| }, | ||
| }; | ||
|
|
||
| return standalone({ | ||
| config, | ||
| customSyntax: 'postcss-scss', | ||
| code: '$foo: bar; // foo;\nb {}', | ||
| formatter: stringFormatter, | ||
| }).then((linted) => { | ||
| const results = linted.results; | ||
|
|
||
| expect(results).toHaveLength(1); | ||
| expect(results[0].warnings).toHaveLength(1); | ||
| expect(results[0].warnings[0].line).toBe(2); | ||
| expect(results[0].warnings[0].column).toBe(3); | ||
| expect(results[0].warnings[0].rule).toBe('block-no-empty'); | ||
| }); | ||
| }); | ||
|
|
||
| it('standalone with custom syntax as npm package', () => { | ||
| const config = { | ||
| rules: { | ||
| 'block-no-empty': true, | ||
| }, | ||
| }; | ||
|
|
||
| return standalone({ | ||
| config, | ||
| customSyntax: require('postcss-scss'), | ||
| code: '$foo: bar; // foo;\nb {}', | ||
| formatter: stringFormatter, | ||
| }).then((linted) => { | ||
| const results = linted.results; | ||
|
|
||
| expect(results).toHaveLength(1); | ||
| expect(results[0].warnings).toHaveLength(1); | ||
| expect(results[0].warnings[0].line).toBe(2); | ||
| expect(results[0].warnings[0].column).toBe(3); | ||
| expect(results[0].warnings[0].rule).toBe('block-no-empty'); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
We never had these tests, but should have, as it's a documented behavior.
ybiquitous
approved these changes
Sep 15, 2021
jeddy3
approved these changes
Sep 15, 2021
There was a problem hiding this comment.
Excellent stuff, thanks!
Maybe we need to switch overrides and CLI/API order, so CLI/API has highest priority than overrides
It's a good point. I think the current order is OK as I see the CLI flags as setting their respective properties in the config file. For example, a hypothetical overrides flag would work like...
Given:
{
"customSyntax": "postcss-sass",
"rules": {
"block-no-empty": true
},
"overrides": [{
"files": "*.css",
"customSyntax": "postcss-safe-parser"
}]
}And run stylelint like this:
stylelint --custom-syntax "postcss-scss" --overrides "files: ["*.css"], customSyntax: "postcss-less" "style.css"
The executed config would be:
{
"customSyntax": "postcss-scss",
"rules": {
"block-no-empty": true
},
"overrides": [{
"files": "*.css",
"customSyntax": "postcss-safe-parser"
},
{
"files": "*.css",
"customSyntax": "postcss-less"
}]
}Where:
--custom-syntax "postcss-scss"sets the root"customSyntax"property--overrides "files: ["*.css"], customSyntax: "postcss-less"adds an item to theoverridesproperty array.
And so postcss-less is used on the style.css file.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #4843.
It was easier than I though :) Two previous PRs I made recently definitely helped :)
Something that we might need to document somewhere or changes. Probably I had to write this in
overridesPR.It is true for v13 (except
overrides) and for all options which could be specified in config, API, and CLI.Priority of options:
overridesin config.For example, if we have this config:
{ "customSyntax": "postcss-sass", "rules": { "block-no-empty": true }, "overrides": [{ "files": "*.css", "customSyntax": "postcss-safe-parser" }] }And run stylelint like this:
File would be linted with
postcss-safe-parser. If were removeoverridesfile would be linted withpostcss-scss. And finally if we remove--custom-syntaxfile would be linted withpostcss-sass.Maybe we need to switch
overridesand CLI/API order, so CLI/API has highest priority thanoverrides.