blob: ed8ba1fb15eaee7ab38d40f488b9ae578848c27b [file] [log] [blame]
'use strict';
const hasBlock = require('../../utils/hasBlock');
const optionsMatches = require('../../utils/optionsMatches');
const report = require('../../utils/report');
const ruleMessages = require('../../utils/ruleMessages');
const validateOptions = require('../../utils/validateOptions');
const ruleName = 'declaration-block-trailing-semicolon';
const messages = ruleMessages(ruleName, {
expected: 'Expected a trailing semicolon',
rejected: 'Unexpected trailing semicolon',
});
/** @type {import('stylelint').Rule} */
const rule = (primary, secondaryOptions, context) => {
return (root, result) => {
const validOptions = validateOptions(
result,
ruleName,
{
actual: primary,
possible: ['always', 'never'],
},
{
actual: secondaryOptions,
possible: {
ignore: ['single-declaration'],
},
optional: true,
},
);
if (!validOptions) {
return;
}
root.walkAtRules((atRule) => {
if (!atRule.parent) throw new Error('A parent node must be present');
if (atRule.parent === root) {
return;
}
if (atRule !== atRule.parent.last) {
return;
}
if (hasBlock(atRule)) {
return;
}
checkLastNode(atRule);
});
root.walkDecls((decl) => {
if (!decl.parent) throw new Error('A parent node must be present');
if (decl.parent.type === 'object') {
return;
}
if (decl !== decl.parent.last) {
return;
}
checkLastNode(decl);
});
/**
* @param {import('postcss').Node} node
*/
function checkLastNode(node) {
if (!node.parent) throw new Error('A parent node must be present');
const hasSemicolon = node.parent.raws.semicolon;
const ignoreSingleDeclaration = optionsMatches(
secondaryOptions,
'ignore',
'single-declaration',
);
if (ignoreSingleDeclaration && node.parent.first === node) {
return;
}
let message;
if (primary === 'always') {
if (hasSemicolon) {
return;
}
// auto-fix
if (context.fix) {
node.parent.raws.semicolon = true;
if (node.type === 'atrule') {
node.raws.between = '';
node.parent.raws.after = ' ';
}
return;
}
message = messages.expected;
} else if (primary === 'never') {
if (!hasSemicolon) {
return;
}
// auto-fix
if (context.fix) {
node.parent.raws.semicolon = false;
return;
}
message = messages.rejected;
} else {
throw new Error(`Unexpected primary option: "${primary}"`);
}
report({
message,
node,
index: node.toString().trim().length - 1,
result,
ruleName,
});
}
};
};
rule.ruleName = ruleName;
rule.messages = messages;
module.exports = rule;