mirror of
https://github.com/OliveTin/OliveTin
synced 2025-12-19 04:25:32 +00:00
157 lines
4.4 KiB
JavaScript
157 lines
4.4 KiB
JavaScript
import fixEmptyLinesBefore from '../../utils/fixEmptyLinesBefore.mjs';
|
|
import getPreviousNonSharedLineCommentNode from '../../utils/getPreviousNonSharedLineCommentNode.mjs';
|
|
import hasEmptyLine from '../../utils/hasEmptyLine.mjs';
|
|
import isAfterSingleLineComment from '../../utils/isAfterSingleLineComment.mjs';
|
|
import isFirstNested from '../../utils/isFirstNested.mjs';
|
|
import isFirstNodeOfRoot from '../../utils/isFirstNodeOfRoot.mjs';
|
|
import isSingleLineString from '../../utils/isSingleLineString.mjs';
|
|
import isStandardSyntaxRule from '../../utils/isStandardSyntaxRule.mjs';
|
|
import optionsMatches from '../../utils/optionsMatches.mjs';
|
|
import report from '../../utils/report.mjs';
|
|
import ruleMessages from '../../utils/ruleMessages.mjs';
|
|
import validateOptions from '../../utils/validateOptions.mjs';
|
|
|
|
const ruleName = 'rule-empty-line-before';
|
|
|
|
const messages = ruleMessages(ruleName, {
|
|
expected: 'Expected empty line before rule',
|
|
rejected: 'Unexpected empty line before rule',
|
|
});
|
|
|
|
const meta = {
|
|
url: 'https://stylelint.io/user-guide/rules/rule-empty-line-before',
|
|
fixable: true,
|
|
};
|
|
|
|
/** @type {import('stylelint').CoreRules[ruleName]} */
|
|
const rule = (primary, secondaryOptions, context) => {
|
|
return (root, result) => {
|
|
const validOptions = validateOptions(
|
|
result,
|
|
ruleName,
|
|
{
|
|
actual: primary,
|
|
possible: ['always', 'never', 'always-multi-line', 'never-multi-line'],
|
|
},
|
|
{
|
|
actual: secondaryOptions,
|
|
possible: {
|
|
ignore: ['after-comment', 'first-nested', 'inside-block'],
|
|
except: [
|
|
'after-rule',
|
|
'after-single-line-comment',
|
|
'first-nested',
|
|
'inside-block-and-after-rule',
|
|
'inside-block',
|
|
],
|
|
},
|
|
optional: true,
|
|
},
|
|
);
|
|
|
|
if (!validOptions) {
|
|
return;
|
|
}
|
|
|
|
const expectation = /** @type {string} */ (primary);
|
|
|
|
root.walkRules((ruleNode) => {
|
|
if (!isStandardSyntaxRule(ruleNode)) {
|
|
return;
|
|
}
|
|
|
|
// Ignore the first node
|
|
if (isFirstNodeOfRoot(ruleNode)) {
|
|
return;
|
|
}
|
|
|
|
// Optionally ignore the expectation if a comment precedes this node
|
|
if (optionsMatches(secondaryOptions, 'ignore', 'after-comment')) {
|
|
const prevNode = ruleNode.prev();
|
|
|
|
if (prevNode && prevNode.type === 'comment') {
|
|
return;
|
|
}
|
|
}
|
|
|
|
// Optionally ignore the node if it is the first nested
|
|
if (optionsMatches(secondaryOptions, 'ignore', 'first-nested') && isFirstNested(ruleNode)) {
|
|
return;
|
|
}
|
|
|
|
const isNested = ruleNode.parent && ruleNode.parent.type !== 'root';
|
|
|
|
// Optionally ignore the expectation if inside a block
|
|
if (optionsMatches(secondaryOptions, 'ignore', 'inside-block') && isNested) {
|
|
return;
|
|
}
|
|
|
|
// Ignore if the expectation is for multiple and the rule is single-line
|
|
if (expectation.includes('multi-line') && isSingleLineString(ruleNode.toString())) {
|
|
return;
|
|
}
|
|
|
|
let expectEmptyLineBefore = expectation.includes('always');
|
|
|
|
// Optionally reverse the expectation if any exceptions apply
|
|
if (
|
|
(optionsMatches(secondaryOptions, 'except', 'first-nested') && isFirstNested(ruleNode)) ||
|
|
(optionsMatches(secondaryOptions, 'except', 'after-rule') && isAfterRule(ruleNode)) ||
|
|
(optionsMatches(secondaryOptions, 'except', 'inside-block-and-after-rule') &&
|
|
isNested &&
|
|
isAfterRule(ruleNode)) ||
|
|
(optionsMatches(secondaryOptions, 'except', 'after-single-line-comment') &&
|
|
isAfterSingleLineComment(ruleNode)) ||
|
|
(optionsMatches(secondaryOptions, 'except', 'inside-block') && isNested)
|
|
) {
|
|
expectEmptyLineBefore = !expectEmptyLineBefore;
|
|
}
|
|
|
|
const hasEmptyLineBefore = hasEmptyLine(ruleNode.raws.before);
|
|
|
|
// Return if the expectation is met
|
|
if (expectEmptyLineBefore === hasEmptyLineBefore) {
|
|
return;
|
|
}
|
|
|
|
const message = expectEmptyLineBefore ? messages.expected : messages.rejected;
|
|
const action = expectEmptyLineBefore ? 'add' : 'remove';
|
|
|
|
// Fix
|
|
const fix = () =>
|
|
fixEmptyLinesBefore({
|
|
node: ruleNode,
|
|
newline: context.newline,
|
|
action,
|
|
});
|
|
|
|
report({
|
|
message,
|
|
messageArgs: [],
|
|
node: ruleNode,
|
|
result,
|
|
ruleName,
|
|
fix: {
|
|
apply: fix,
|
|
node: ruleNode.parent,
|
|
},
|
|
});
|
|
});
|
|
};
|
|
};
|
|
|
|
/**
|
|
* @param {import('postcss').Rule} ruleNode
|
|
* @returns {boolean}
|
|
*/
|
|
function isAfterRule(ruleNode) {
|
|
const prevNode = getPreviousNonSharedLineCommentNode(ruleNode);
|
|
|
|
return prevNode != null && prevNode.type === 'rule';
|
|
}
|
|
|
|
rule.ruleName = ruleName;
|
|
rule.messages = messages;
|
|
rule.meta = meta;
|
|
export default rule;
|