123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121 |
- 'use strict';
- const isStandardSyntaxRule = require('../../utils/isStandardSyntaxRule');
- const report = require('../../utils/report');
- const ruleMessages = require('../../utils/ruleMessages');
- const styleSearch = require('style-search');
- const validateOptions = require('../../utils/validateOptions');
- const whitespaceChecker = require('../../utils/whitespaceChecker');
- const ruleName = 'selector-list-comma-newline-after';
- const messages = ruleMessages(ruleName, {
- expectedAfter: () => 'Expected newline after ","',
- expectedAfterMultiLine: () => 'Expected newline after "," in a multi-line list',
- rejectedAfterMultiLine: () => 'Unexpected whitespace after "," in a multi-line list',
- });
- const meta = {
- url: 'https://stylelint.io/user-guide/rules/list/selector-list-comma-newline-after',
- fixable: true,
- };
- /** @type {import('stylelint').Rule} */
- const rule = (primary, _secondaryOptions, context) => {
- const checker = whitespaceChecker('newline', primary, messages);
- return (root, result) => {
- const validOptions = validateOptions(result, ruleName, {
- actual: primary,
- possible: ['always', 'always-multi-line', 'never-multi-line'],
- });
- if (!validOptions) {
- return;
- }
- root.walkRules((ruleNode) => {
- if (!isStandardSyntaxRule(ruleNode)) {
- return;
- }
- // Get raw selector so we can allow end-of-line comments, e.g.
- // a, /* comment */
- // b {}
- const selector = ruleNode.raws.selector ? ruleNode.raws.selector.raw : ruleNode.selector;
- /** @type {number[]} */
- const fixIndices = [];
- styleSearch(
- {
- source: selector,
- target: ',',
- functionArguments: 'skip',
- },
- (match) => {
- const nextChars = selector.slice(match.endIndex);
- // If there's a // comment, that means there has to be a newline
- // ending the comment so we're fine
- if (/^\s+\/\//.test(nextChars)) {
- return;
- }
- // If there are spaces and then a comment begins, look for the newline
- const indextoCheckAfter = /^\s+\/\*/.test(nextChars)
- ? selector.indexOf('*/', match.endIndex) + 1
- : match.startIndex;
- checker.afterOneOnly({
- source: selector,
- index: indextoCheckAfter,
- err: (m) => {
- if (context.fix) {
- fixIndices.push(indextoCheckAfter + 1);
- return;
- }
- report({
- message: m,
- node: ruleNode,
- index: match.startIndex,
- result,
- ruleName,
- });
- },
- });
- },
- );
- if (fixIndices.length) {
- let fixedSelector = selector;
- for (const index of fixIndices.sort((a, b) => b - a)) {
- const beforeSelector = fixedSelector.slice(0, index);
- let afterSelector = fixedSelector.slice(index);
- if (primary.startsWith('always')) {
- afterSelector = context.newline + afterSelector;
- } else if (primary.startsWith('never-multi-line')) {
- afterSelector = afterSelector.replace(/^\s*/, '');
- }
- fixedSelector = beforeSelector + afterSelector;
- }
- if (ruleNode.raws.selector) {
- ruleNode.raws.selector.raw = fixedSelector;
- } else {
- ruleNode.selector = fixedSelector;
- }
- }
- });
- };
- };
- rule.ruleName = ruleName;
- rule.messages = messages;
- rule.meta = meta;
- module.exports = rule;
|