1 |
|
2 |
|
3 | 'use strict';
|
4 |
|
5 | const _ = require('lodash');
|
6 | const addEmptyLineBefore = require('../../utils/addEmptyLineBefore');
|
7 | const getPreviousNonSharedLineCommentNode = require('../../utils/getPreviousNonSharedLineCommentNode');
|
8 | const hasEmptyLine = require('../../utils/hasEmptyLine');
|
9 | const isAfterComment = require('../../utils/isAfterComment');
|
10 | const isBlocklessAtRuleAfterBlocklessAtRule = require('../../utils/isBlocklessAtRuleAfterBlocklessAtRule');
|
11 | const isBlocklessAtRuleAfterSameNameBlocklessAtRule = require('../../utils/isBlocklessAtRuleAfterSameNameBlocklessAtRule');
|
12 | const isFirstNested = require('../../utils/isFirstNested');
|
13 | const isFirstNodeOfRoot = require('../../utils/isFirstNodeOfRoot');
|
14 | const isStandardSyntaxAtRule = require('../../utils/isStandardSyntaxAtRule');
|
15 | const optionsMatches = require('../../utils/optionsMatches');
|
16 | const removeEmptyLinesBefore = require('../../utils/removeEmptyLinesBefore');
|
17 | const report = require('../../utils/report');
|
18 | const ruleMessages = require('../../utils/ruleMessages');
|
19 | const validateOptions = require('../../utils/validateOptions');
|
20 |
|
21 | const ruleName = 'at-rule-empty-line-before';
|
22 |
|
23 | const messages = ruleMessages(ruleName, {
|
24 | expected: 'Expected empty line before at-rule',
|
25 | rejected: 'Unexpected empty line before at-rule',
|
26 | });
|
27 |
|
28 | function rule(expectation, options, context) {
|
29 | return (root, result) => {
|
30 | const validOptions = validateOptions(
|
31 | result,
|
32 | ruleName,
|
33 | {
|
34 | actual: expectation,
|
35 | possible: ['always', 'never'],
|
36 | },
|
37 | {
|
38 | actual: options,
|
39 | possible: {
|
40 | except: [
|
41 | 'after-same-name',
|
42 | 'inside-block',
|
43 | 'blockless-after-same-name-blockless',
|
44 | 'blockless-after-blockless',
|
45 | 'first-nested',
|
46 | ],
|
47 | ignore: [
|
48 | 'after-comment',
|
49 | 'first-nested',
|
50 | 'inside-block',
|
51 | 'blockless-after-same-name-blockless',
|
52 | 'blockless-after-blockless',
|
53 | ],
|
54 | ignoreAtRules: [_.isString],
|
55 | },
|
56 | optional: true,
|
57 | },
|
58 | );
|
59 |
|
60 | if (!validOptions) {
|
61 | return;
|
62 | }
|
63 |
|
64 | root.walkAtRules((atRule) => {
|
65 | const isNested = atRule.parent.type !== 'root';
|
66 |
|
67 |
|
68 | if (isFirstNodeOfRoot(atRule)) {
|
69 | return;
|
70 | }
|
71 |
|
72 | if (!isStandardSyntaxAtRule(atRule)) {
|
73 | return;
|
74 | }
|
75 |
|
76 |
|
77 | if (optionsMatches(options, 'ignoreAtRules', atRule.name)) {
|
78 | return;
|
79 | }
|
80 |
|
81 |
|
82 | if (
|
83 | optionsMatches(options, 'ignore', 'blockless-after-blockless') &&
|
84 | isBlocklessAtRuleAfterBlocklessAtRule(atRule)
|
85 | ) {
|
86 | return;
|
87 | }
|
88 |
|
89 |
|
90 | if (optionsMatches(options, 'ignore', 'first-nested') && isFirstNested(atRule)) {
|
91 | return;
|
92 | }
|
93 |
|
94 |
|
95 |
|
96 | if (
|
97 | optionsMatches(options, 'ignore', 'blockless-after-same-name-blockless') &&
|
98 | isBlocklessAtRuleAfterSameNameBlocklessAtRule(atRule)
|
99 | ) {
|
100 | return;
|
101 | }
|
102 |
|
103 |
|
104 | if (optionsMatches(options, 'ignore', 'inside-block') && isNested) {
|
105 | return;
|
106 | }
|
107 |
|
108 |
|
109 | if (optionsMatches(options, 'ignore', 'after-comment') && isAfterComment(atRule)) {
|
110 | return;
|
111 | }
|
112 |
|
113 | const hasEmptyLineBefore = hasEmptyLine(atRule.raws.before);
|
114 | let expectEmptyLineBefore = expectation === 'always';
|
115 |
|
116 |
|
117 | if (
|
118 | (optionsMatches(options, 'except', 'after-same-name') &&
|
119 | isAtRuleAfterSameNameAtRule(atRule)) ||
|
120 | (optionsMatches(options, 'except', 'inside-block') && isNested) ||
|
121 | (optionsMatches(options, 'except', 'first-nested') && isFirstNested(atRule)) ||
|
122 | (optionsMatches(options, 'except', 'blockless-after-blockless') &&
|
123 | isBlocklessAtRuleAfterBlocklessAtRule(atRule)) ||
|
124 | (optionsMatches(options, 'except', 'blockless-after-same-name-blockless') &&
|
125 | isBlocklessAtRuleAfterSameNameBlocklessAtRule(atRule))
|
126 | ) {
|
127 | expectEmptyLineBefore = !expectEmptyLineBefore;
|
128 | }
|
129 |
|
130 |
|
131 | if (expectEmptyLineBefore === hasEmptyLineBefore) {
|
132 | return;
|
133 | }
|
134 |
|
135 |
|
136 | if (context.fix) {
|
137 | if (expectEmptyLineBefore) {
|
138 | addEmptyLineBefore(atRule, context.newline);
|
139 | } else {
|
140 | removeEmptyLinesBefore(atRule, context.newline);
|
141 | }
|
142 |
|
143 | return;
|
144 | }
|
145 |
|
146 | const message = expectEmptyLineBefore ? messages.expected : messages.rejected;
|
147 |
|
148 | report({ message, node: atRule, result, ruleName });
|
149 | });
|
150 | };
|
151 | }
|
152 |
|
153 | function isAtRuleAfterSameNameAtRule(atRule) {
|
154 | const previousNode = getPreviousNonSharedLineCommentNode(atRule);
|
155 |
|
156 | return previousNode && previousNode.type === 'atrule' && previousNode.name === atRule.name;
|
157 | }
|
158 |
|
159 | rule.ruleName = ruleName;
|
160 | rule.messages = messages;
|
161 | module.exports = rule;
|