123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137 |
- 'use strict';
- const beforeBlockString = require('../../utils/beforeBlockString');
- const blockString = require('../../utils/blockString');
- const hasBlock = require('../../utils/hasBlock');
- const hasEmptyBlock = require('../../utils/hasEmptyBlock');
- const optionsMatches = require('../../utils/optionsMatches');
- const report = require('../../utils/report');
- const ruleMessages = require('../../utils/ruleMessages');
- const validateOptions = require('../../utils/validateOptions');
- const whitespaceChecker = require('../../utils/whitespaceChecker');
- const { isRegExp, isString } = require('../../utils/validateTypes');
- const ruleName = 'block-opening-brace-space-before';
- const messages = ruleMessages(ruleName, {
- expectedBefore: () => 'Expected single space before "{"',
- rejectedBefore: () => 'Unexpected whitespace before "{"',
- expectedBeforeSingleLine: () => 'Expected single space before "{" of a single-line block',
- rejectedBeforeSingleLine: () => 'Unexpected whitespace before "{" of a single-line block',
- expectedBeforeMultiLine: () => 'Expected single space before "{" of a multi-line block',
- rejectedBeforeMultiLine: () => 'Unexpected whitespace before "{" of a multi-line block',
- });
- const meta = {
- url: 'https://stylelint.io/user-guide/rules/list/block-opening-brace-space-before',
- };
- /** @type {import('stylelint').Rule} */
- const rule = (primary, secondaryOptions, context) => {
- const checker = whitespaceChecker('space', primary, messages);
- return (root, result) => {
- const validOptions = validateOptions(
- result,
- ruleName,
- {
- actual: primary,
- possible: [
- 'always',
- 'never',
- 'always-single-line',
- 'never-single-line',
- 'always-multi-line',
- 'never-multi-line',
- ],
- },
- {
- actual: secondaryOptions,
- possible: {
- ignoreAtRules: [isString, isRegExp],
- ignoreSelectors: [isString, isRegExp],
- },
- 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 an empty block
- if (!hasBlock(statement) || hasEmptyBlock(statement)) {
- return;
- }
- // Return early if at-rule is to be ignored
- if (
- statement.type === 'atrule' &&
- optionsMatches(secondaryOptions, 'ignoreAtRules', statement.name)
- ) {
- return;
- }
- // Return early if selector is to be ignored
- if (
- statement.type === 'rule' &&
- optionsMatches(secondaryOptions, 'ignoreSelectors', statement.selector)
- ) {
- return;
- }
- const source = beforeBlockString(statement);
- const beforeBraceNoRaw = beforeBlockString(statement, {
- noRawBefore: true,
- });
- let index = beforeBraceNoRaw.length - 1;
- if (beforeBraceNoRaw[index - 1] === '\r') {
- index -= 1;
- }
- checker.before({
- source,
- index: source.length,
- lineCheckStr: blockString(statement),
- err: (m) => {
- if (context.fix) {
- if (primary.startsWith('always')) {
- statement.raws.between = ' ';
- return;
- }
- if (primary.startsWith('never')) {
- statement.raws.between = '';
- return;
- }
- }
- report({
- message: m,
- node: statement,
- index,
- result,
- ruleName,
- });
- },
- });
- }
- };
- };
- rule.ruleName = ruleName;
- rule.messages = messages;
- rule.meta = meta;
- module.exports = rule;
|