linter-bundle/stylelint/plugins/stylelint-15.11.0-stylistic/rules/block-closing-brace-newline-before/index.mjs

Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.

// @ts-nocheck

import stylelint from 'stylelint';
import blockString from 'stylelint/lib/utils/blockString.mjs';
import hasBlock from 'stylelint/lib/utils/hasBlock.mjs';
import isSingleLineString from 'stylelint/lib/utils/isSingleLineString.mjs';
import report from 'stylelint/lib/utils/report.mjs';
import ruleMessages from 'stylelint/lib/utils/ruleMessages.mjs';
import validateOptions from 'stylelint/lib/utils/validateOptions.mjs';

import hasEmptyBlock from '../../utils/hasEmptyBlock.mjs';

const ruleName = 'plugin/block-closing-brace-newline-before';

const messages = ruleMessages(ruleName, {
	expectedBefore: 'Expected newline before "}"',
	expectedBeforeMultiLine: 'Expected newline before "}" of a multi-line block',
	rejectedBeforeMultiLine: 'Unexpected whitespace before "}" of a multi-line block'
});

const meta = {
	url: 'https://github.com/jens-duttke/linter-bundle/blob/main/stylelint/plugins/stylelint-15.11.0-stylistic/rules/block-closing-brace-newline-before/README.md',
	fixable: true
};

/** @type {import('stylelint').Rule} */
const rule = (primary, _secondaryOptions, context) => (root, result) => {
	const validOptions = validateOptions(result, ruleName, {
		actual: primary,
		possible: ['always', 'always-multi-line', 'never-multi-line']
	});

	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;
		}

		// Ignore extra semicolon
		const after = (statement.raws.after || '').replace(/;+/u, '');

		if (after === undefined) {
			return;
		}

		const blockIsMultiLine = !isSingleLineString(blockString(statement));
		const statementString = statement.toString();

		let index = statementString.length - 2;

		if (statementString[index - 1] === '\r') {
			index -= 1;
		}

		// We're really just checking whether a
		// newline *starts* the block's final space -- between
		// the last declaration and the closing brace. We can
		// ignore any other whitespace between them, because that
		// will be checked by the indentation rule.
		if (!after.startsWith('\n') && !after.startsWith('\r\n')) {
			if (primary === 'always') {
				complain(messages.expectedBefore);
			}
			else if (blockIsMultiLine && primary === 'always-multi-line') {
				complain(messages.expectedBeforeMultiLine);
			}
		}

		if (after !== '' && blockIsMultiLine && primary === 'never-multi-line') {
			complain(messages.rejectedBeforeMultiLine);
		}

		/**
		 * @param {string} message
		 */
		function complain (message) {
			report({
				message,
				result,
				ruleName,
				node: statement,
				index,
				endIndex: index,
				fix: () => {
					const statementRaws = statement.raws;

					if (typeof statementRaws.after !== 'string') { return; }

					if (primary.startsWith('always')) {
						const firstWhitespaceIndex = statementRaws.after.search(/\s/u);
						const newlineBefore =
								firstWhitespaceIndex >= 0 ?
									statementRaws.after.slice(0, firstWhitespaceIndex)
									: statementRaws.after;
						const newlineAfter =
								firstWhitespaceIndex >= 0 ? statementRaws.after.slice(firstWhitespaceIndex) : '';
						const newlineIndex = newlineAfter.search(/\r?\n/u);

						statementRaws.after =
								newlineIndex >= 0 ?
									newlineBefore + newlineAfter.slice(newlineIndex)
									: newlineBefore + context.newline + newlineAfter;

						return;
					}

					if (primary === 'never-multi-line') {
						statementRaws.after = statementRaws.after.replace(/\s/gu, '');

						return;
					}
				}
			});
		}
	}
};

rule.ruleName = ruleName;
rule.messages = messages;
rule.meta = meta;
export default stylelint.createPlugin(ruleName, rule);