Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add selector-disallowed-list rule #5239

1 change: 1 addition & 0 deletions docs/user-guide/rules/list.md
Expand Up @@ -185,6 +185,7 @@ Grouped first by the following categories and then by the [_thing_](http://apps.
- [`selector-combinator-blacklist`](../../../lib/rules/selector-combinator-blacklist/README.md): Specify a list of disallowed combinators. **(deprecated)**
- [`selector-combinator-disallowed-list`](../../../lib/rules/selector-combinator-disallowed-list/README.md): Specify a list of disallowed combinators.
- [`selector-combinator-whitelist`](../../../lib/rules/selector-combinator-whitelist/README.md): Specify a list of allowed combinators. **(deprecated)**
- [`selector-disallowed-list`](../../../lib/rules/selector-disallowed-list/README.md): Specify a list of disallowed selectors.
- [`selector-id-pattern`](../../../lib/rules/selector-id-pattern/README.md): Specify a pattern for ID selectors.
- [`selector-max-attribute`](../../../lib/rules/selector-max-attribute/README.md): Limit the number of attribute selectors in a selector.
- [`selector-max-class`](../../../lib/rules/selector-max-class/README.md): Limit the number of classes in a selector.
Expand Down
1 change: 1 addition & 0 deletions lib/rules/index.js
Expand Up @@ -303,6 +303,7 @@ const rules = {
'selector-descendant-combinator-no-non-space': importLazy(() =>
require('./selector-descendant-combinator-no-non-space'),
)(),
'selector-disallowed-list': importLazy(() => require('./selector-disallowed-list'))(),
'selector-id-pattern': importLazy(() => require('./selector-id-pattern'))(),
'selector-list-comma-newline-after': importLazy(() =>
require('./selector-list-comma-newline-after'),
Expand Down
68 changes: 68 additions & 0 deletions lib/rules/selector-disallowed-list/README.md
@@ -0,0 +1,68 @@
# selector-disallowed-list

Specify a list of disallowed selectors.

<!-- prettier-ignore -->
```css
.foo > .bar
/** ↑
* This is selector */
```

## Options

`array|string|regexp`: `["array", "of", "selectors", /or/, "/regex/"]|"selector"|"/regex/"`

If a string is surrounded with `"/"` (e.g. `"/\.foo/"`), it is interpreted as a regular expression.

### Given:
doing-art marked this conversation as resolved.
Show resolved Hide resolved

```
["a > .foo", /\[data-.+]/]
```

The following patterns are considered violations:

<!-- prettier-ignore -->
```css
a > .foo {}
```

<!-- prettier-ignore -->
```css
a[data-auto="1"] {}
```

<!-- prettier-ignore -->
```css
.foo, [data-auto="1"] {}
```

The following patterns are _not_ considered violations:

<!-- prettier-ignore -->
```css
.foo {}
```

<!-- prettier-ignore -->
```css
a
>
.foo {}
```

<!-- prettier-ignore -->
```css
.bar > a > .foo {}
```

<!-- prettier-ignore -->
```css
.data-auto {}
```

<!-- prettier-ignore -->
```css
a[href] {}
```
144 changes: 144 additions & 0 deletions lib/rules/selector-disallowed-list/__tests__/index.js
@@ -0,0 +1,144 @@
'use strict';

const { messages, ruleName } = require('..');

testRule({
ruleName,
config: ['a > .foo', /\[data-.+]/],

accept: [
{
code: 'a {}',
},
{
code: '.foo {}',
},
{
code: 'a\n>\n.foo {}',
},
{
code: '.bar > a > .foo {}',
},
{
code: '.foo > a {}',
},
{
code: '.data-auto {}',
},
{
code: 'a[href] {}',
},
],

reject: [
{
code: 'a > .foo {}',
message: messages.rejected('a > .foo'),
line: 1,
column: 1,
},
{
code: 'a[data-auto="1"] {}',
message: messages.rejected('a[data-auto="1"]'),
line: 1,
column: 1,
},
{
code: 'a[data-auto] {}',
message: messages.rejected('a[data-auto]'),
line: 1,
column: 1,
},
{
code: '.foo, [data-auto="1"] {}',
message: messages.rejected('.foo, [data-auto="1"]'),
line: 1,
column: 1,
},
],
});

testRule({
ruleName,
config: [/\.foo.*>.*\.bar/],

accept: [
{
code: '.bar {}',
},
{
code: '.foo .bar {}',
},
{
code: '.bar { --baz: 1px; }',
},
],

reject: [
{
code: '.foo>.bar {}',
message: messages.rejected('.foo>.bar'),
line: 1,
column: 1,
},
{
code: '.foo > .bar {}',
message: messages.rejected('.foo > .bar'),
line: 1,
column: 1,
},
{
code: '.foo > /*comment*/.bar {}',
message: messages.rejected('.foo > .bar'),
line: 1,
column: 1,
},
{
code: '.foo:hover > .bar {}',
message: messages.rejected('.foo:hover > .bar'),
line: 1,
column: 1,
},
{
code: '.foo > a > .bar {}',
message: messages.rejected('.foo > a > .bar'),
line: 1,
column: 1,
},
{
code: 'a > .foo > .bar {}',
message: messages.rejected('a > .foo > .bar'),
line: 1,
column: 1,
},
{
code: 'a, .foo > .bar {}',
message: messages.rejected('a, .foo > .bar'),
line: 1,
column: 1,
},
],
});

testRule({
ruleName,
config: ['.foo, .bar'],

accept: [
{
code: '.foo > a {}',
},
{
code: '.bar, a {}',
},
],

reject: [
{
code: '.foo, .bar {}',
message: messages.rejected('.foo, .bar'),
line: 1,
column: 1,
},
],
});
56 changes: 56 additions & 0 deletions lib/rules/selector-disallowed-list/index.js
@@ -0,0 +1,56 @@
// @ts-nocheck

'use strict';

const _ = require('lodash');
const isStandardSyntaxRule = require('../../utils/isStandardSyntaxRule');
const matchesStringOrRegExp = require('../../utils/matchesStringOrRegExp');
const report = require('../../utils/report');
const ruleMessages = require('../../utils/ruleMessages');
const validateOptions = require('../../utils/validateOptions');

const ruleName = 'selector-disallowed-list';

const messages = ruleMessages(ruleName, {
rejected: (selector) => `Unexpected selector "${selector}"`,
});

function rule(listInput) {
const list = [].concat(listInput);

return (root, result) => {
const validOptions = validateOptions(result, ruleName, {
actual: list,
possible: [_.isString, _.isRegExp],
});

if (!validOptions) {
return;
}

root.walkRules((ruleNode) => {
if (!isStandardSyntaxRule(ruleNode)) {
return;
}

const selector = ruleNode.selector;

if (!matchesStringOrRegExp(selector, list)) {
return;
}

report({
result,
ruleName,
message: messages.rejected(selector),
node: ruleNode,
});
});
};
}

rule.primaryOptionArray = true;

rule.ruleName = ruleName;
rule.messages = messages;
module.exports = rule;