123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127 |
- 'use strict';
- const addEmptyLineAfter = require('../../utils/addEmptyLineAfter');
- const blockString = require('../../utils/blockString');
- const hasBlock = require('../../utils/hasBlock');
- const hasEmptyBlock = require('../../utils/hasEmptyBlock');
- const hasEmptyLine = require('../../utils/hasEmptyLine');
- const isSingleLineString = require('../../utils/isSingleLineString');
- const optionsMatches = require('../../utils/optionsMatches');
- const removeEmptyLinesAfter = require('../../utils/removeEmptyLinesAfter');
- const report = require('../../utils/report');
- const ruleMessages = require('../../utils/ruleMessages');
- const validateOptions = require('../../utils/validateOptions');
- const ruleName = 'block-closing-brace-empty-line-before';
- const messages = ruleMessages(ruleName, {
- expected: 'Expected empty line before closing brace',
- rejected: 'Unexpected empty line before closing brace',
- });
- const meta = {
- url: 'https://stylelint.io/user-guide/rules/list/block-closing-brace-empty-line-before',
- };
- /** @type {import('stylelint').Rule} */
- const rule = (primary, secondaryOptions, context) => {
- return (root, result) => {
- const validOptions = validateOptions(
- result,
- ruleName,
- {
- actual: primary,
- possible: ['always-multi-line', 'never'],
- },
- {
- actual: secondaryOptions,
- possible: {
- except: ['after-closing-brace'],
- },
- optional: true,
- },
- );
- if (!validOptions) {
- return;
- }
- // Check both kinds of statements: rules and at-rules
- root.walkRules(check);
- root.walkAtRules(check);
- /**
- * @param {import('postcss').Rule | import('postcss').AtRule} statement
- */
- function check(statement) {
- // Return early if blockless or has empty block
- if (!hasBlock(statement) || hasEmptyBlock(statement)) {
- return;
- }
- // Get whitespace after ""}", ignoring extra semicolon
- const before = (statement.raws.after || '').replace(/;+/, '');
- // Calculate index
- const statementString = statement.toString();
- let index = statementString.length - 1;
- if (statementString[index - 1] === '\r') {
- index -= 1;
- }
- // Set expectation
- const expectEmptyLineBefore = (() => {
- const childNodeTypes = statement.nodes.map((item) => item.type);
- // Reverse the primary options if `after-closing-brace` is set
- if (
- optionsMatches(secondaryOptions, 'except', 'after-closing-brace') &&
- statement.type === 'atrule' &&
- !childNodeTypes.includes('decl')
- ) {
- return primary === 'never';
- }
- return primary === 'always-multi-line' && !isSingleLineString(blockString(statement));
- })();
- // Check for at least one empty line
- const hasEmptyLineBefore = hasEmptyLine(before);
- // Return if the expectation is met
- if (expectEmptyLineBefore === hasEmptyLineBefore) {
- return;
- }
- if (context.fix) {
- const { newline } = context;
- if (typeof newline !== 'string') return;
- if (expectEmptyLineBefore) {
- addEmptyLineAfter(statement, newline);
- } else {
- removeEmptyLinesAfter(statement, newline);
- }
- return;
- }
- const message = expectEmptyLineBefore ? messages.expected : messages.rejected;
- report({
- message,
- result,
- ruleName,
- node: statement,
- index,
- });
- }
- };
- };
- rule.ruleName = ruleName;
- rule.messages = messages;
- rule.meta = meta;
- module.exports = rule;
|