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

Fix incorrect column and escaped colons for selector-pseudo-element-colon-notation rule #5879

Merged
merged 3 commits into from
Feb 6, 2022
Merged

Fix incorrect column and escaped colons for selector-pseudo-element-colon-notation rule #5879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5bce02a
Fix incorrect column and escaped colons for `selector-pseudo-element-…
ybiquitous Feb 4, 2022
15218be
Avoid `replaceAll` and embed cached error into message
ybiquitous Feb 4, 2022
8c2ee0b
More refactorings
ybiquitous Feb 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 19 additions & 9 deletions lib/rules/selector-pseudo-element-colon-notation/__tests__/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ testRule({
{
code: 'a::grammar-error { color: pink; }',
},
{
code: 'a\\:before { color: pink; }',
},
{
code: 'li::marker { font-variant-numeric: tabular-nums; }',
},
Expand Down Expand Up @@ -65,42 +68,49 @@ testRule({
fixed: 'a:before { color: pink; }',
message: messages.expected('single'),
line: 1,
column: 3,
column: 2,
},
{
code: 'a::bEfOrE { color: pink; }',
fixed: 'a:bEfOrE { color: pink; }',
message: messages.expected('single'),
line: 1,
column: 3,
column: 2,
},
{
code: 'a::BEFORE { color: pink; }',
fixed: 'a:BEFORE { color: pink; }',
message: messages.expected('single'),
line: 1,
column: 3,
column: 2,
},
{
code: 'a::after { color: pink; }',
fixed: 'a:after { color: pink; }',
message: messages.expected('single'),
line: 1,
column: 3,
column: 2,
},
{
code: 'a::first-line { color: pink; }',
fixed: 'a:first-line { color: pink; }',
message: messages.expected('single'),
line: 1,
column: 3,
column: 2,
},
{
code: 'a::first-letter { color: pink; }',
fixed: 'a:first-letter { color: pink; }',
message: messages.expected('single'),
line: 1,
column: 3,
column: 2,
},
{
code: 'a\\:before-none::before { color: pink; }',
fixed: 'a\\:before-none:before { color: pink; }',
message: messages.expected('single'),
line: 1,
column: 15,
},
{
code: 'a::before, a::after, a::first-letter { color: pink; }',
Expand All @@ -109,17 +119,17 @@ testRule({
{
message: messages.expected('single'),
line: 1,
column: 3,
column: 2,
},
{
message: messages.expected('single'),
line: 1,
column: 14,
column: 13,
},
{
message: messages.expected('single'),
line: 1,
column: 24,
column: 23,
},
],
},
Expand Down
73 changes: 35 additions & 38 deletions lib/rules/selector-pseudo-element-colon-notation/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

const isStandardSyntaxRule = require('../../utils/isStandardSyntaxRule');
const keywordSets = require('../../reference/keywordSets');
const parseSelector = require('../../utils/parseSelector');
const report = require('../../utils/report');
const ruleMessages = require('../../utils/ruleMessages');
const styleSearch = require('style-search');
const validateOptions = require('../../utils/validateOptions');

const ruleName = 'selector-pseudo-element-colon-notation';
Expand All @@ -29,6 +29,14 @@ const rule = (primary, _secondaryOptions, context) => {
return;
}

let fixedColon = '';

if (primary === 'single') {
fixedColon = ':';
} else if (primary === 'double') {
fixedColon = '::';
}

root.walkRules((ruleNode) => {
if (!isStandardSyntaxRule(ruleNode)) {
return;
Expand All @@ -41,53 +49,42 @@ const rule = (primary, _secondaryOptions, context) => {
return;
}

/** @type {Array<{ ruleNode: import('postcss').Rule, startIndex: number }>} */
const fixPositions = [];
const fixedSelector = parseSelector(selector, result, ruleNode, (selectors) => {
selectors.walkPseudos((pseudo) => {
const pseudoElement = pseudo.value.replace(/:/g, '');

// match only level 1 and 2 pseudo elements
const pseudoElementsWithColons = [...keywordSets.levelOneAndTwoPseudoElements].map(
(x) => `:${x}`,
);
if (!keywordSets.levelOneAndTwoPseudoElements.has(pseudoElement.toLowerCase())) {
return;
}

styleSearch({ source: selector.toLowerCase(), target: pseudoElementsWithColons }, (match) => {
const prevCharIsColon = selector[match.startIndex - 1] === ':';
const isDouble = pseudo.value.startsWith('::');

if (primary === 'single' && !prevCharIsColon) {
return;
}
if (primary === 'single' && !isDouble) {
return;
}

if (primary === 'double' && prevCharIsColon) {
return;
}
if (primary === 'double' && isDouble) {
return;
}

if (context.fix) {
fixPositions.unshift({ ruleNode, startIndex: match.startIndex });
if (context.fix) {
pseudo.replaceWith(pseudo.clone({ value: fixedColon + pseudoElement }));

return;
}
return;
}

report({
message: messages.expected(primary),
node: ruleNode,
index: match.startIndex,
result,
ruleName,
report({
message: messages.expected(primary),
node: ruleNode,
index: pseudo.sourceIndex,
result,
ruleName,
});
});
});

if (fixPositions.length) {
// If expecting : then we found :: so remove one of the colons
// If expecting :: then we found : so add one extra colon
const expectedSingle = primary === 'single';
const offset = expectedSingle ? 1 : 0;
const extraColon = expectedSingle ? '' : ':';

for (const fixPosition of fixPositions) {
ruleNode.selector =
ruleNode.selector.substring(0, fixPosition.startIndex - offset) +
extraColon +
ruleNode.selector.substring(fixPosition.startIndex);
}
if (context.fix && fixedSelector) {
ruleNode.selector = fixedSelector;
}
});
};
Expand Down
4 changes: 2 additions & 2 deletions lib/utils/parseSelector.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const selectorParser = require('postcss-selector-parser');
module.exports = function parseSelector(selector, result, node, callback) {
try {
return selectorParser(callback).processSync(selector);
} catch {
result.warn('Cannot parse selector', { node, stylelintType: 'parseError' });
} catch (err) {
result.warn(`Cannot parse selector (${err})`, { node, stylelintType: 'parseError' });
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[note] It is hard to investigate a raised error in callback unless err.

}
};