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

Update: added ignoreExpressions option to max-classes-per-file #15000

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 32 additions & 3 deletions docs/rules/max-classes-per-file.md
Expand Up @@ -28,8 +28,12 @@ class Foo {}

## Options

This rule has a numeric option (defaulted to 1) to specify the
maximum number of classes.
This rule may take in either an object or a number.
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved

If the option is an object, it may contain one or both of:

- `ignoreExpressions`: a boolean option (defaulted to `false`) to ignore class expressions.
- `maximum`: a numeric option (defaulted to 1) to specify the maximum number of classes.
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved

For example:

Expand All @@ -39,11 +43,36 @@ For example:
}
```

Examples of **correct** code for this rule with the numeric option set to `2`:
```json
{
"max-classes-per-file": [
"error",
{ "ignoreExpressions": true, "maximum": 2 }
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
]
}
```

Examples of **correct** code for this rule with the `maximum` option set to `2`:
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved

```js
/* eslint max-classes-per-file: ["error", 2] */

class Foo {}
class Bar {}
```

Examples of **correct** code for this rule with the `ignoreExpressions` option set to `true`:

```js
/* eslint max-classes-per-file: ["error", { ignoreExpressions: true }] */

class VisitorFactory {
forDescriptor(descriptor) {
return class {
visit(node) {
return `Visiting ${descriptor}.`;
}
};
}
}
```
34 changes: 29 additions & 5 deletions lib/rules/max-classes-per-file.js
Expand Up @@ -25,8 +25,25 @@ module.exports = {

schema: [
{
type: "integer",
minimum: 1
oneOf: [
{
type: "integer",
minimum: 1
},
{
type: "object",
properties: {
ignoreExpressions: {
type: "boolean"
},
maxClasses: {
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
type: "integer",
minimum: 1
}
},
additionalProperties: false
}
]
}
],

Expand All @@ -35,8 +52,10 @@ module.exports = {
}
},
create(context) {

const maxClasses = context.options[0] || 1;
const [option = {}] = context.options;
const [ignoreExpressions, maxClasses] = typeof option === "number"
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
? [false, option || 1]
: [option.ignoreExpressions, option.maxClasses || 1];
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved

let classCount = 0;

Expand All @@ -56,8 +75,13 @@ module.exports = {
});
}
},
"ClassDeclaration, ClassExpression"() {
"ClassDeclaration"() {
classCount++;
},
"ClassExpression"() {
if (!ignoreExpressions) {
classCount++;
}
}
};
}
Expand Down
46 changes: 46 additions & 0 deletions tests/lib/rules/max-classes-per-file.js
Expand Up @@ -29,6 +29,29 @@ ruleTester.run("max-classes-per-file", rule, {
{
code: "class Foo {}\nclass Bar {}",
options: [2]
},
{
code: "class Foo {}",
options: [{ maxClasses: 1 }]
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
},
{
code: "class Foo {}\nclass Bar {}",
options: [{ maxClasses: 2 }]
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
},
{
code: `
class Foo {}
const myExpression = class {}
`,
options: [{ ignoreExpressions: true, maxClasses: 1 }]
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
},
{
code: `
class Foo {}
class Bar {}
const myExpression = class {}
`,
options: [{ ignoreExpressions: true, maxClasses: 2 }]
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
}
],

Expand All @@ -37,6 +60,10 @@ ruleTester.run("max-classes-per-file", rule, {
code: "class Foo {}\nclass Bar {}",
errors: [{ messageId: "maximumExceeded", type: "Program" }]
},
{
code: "class Foo {}\nconst myExpression = class {}",
errors: [{ messageId: "maximumExceeded", type: "Program" }]
},
{
code: "var x = class {};\nvar y = class {};",
errors: [{ messageId: "maximumExceeded", type: "Program" }]
Expand All @@ -54,6 +81,25 @@ ruleTester.run("max-classes-per-file", rule, {
code: "class Foo {} class Bar {} class Baz {}",
options: [2],
errors: [{ messageId: "maximumExceeded", type: "Program" }]
},
{
code: `
class Foo {}
class Bar {}
const myExpression = class {}
`,
options: [{ ignoreExpressions: true, maxClasses: 1 }],
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
errors: [{ messageId: "maximumExceeded", type: "Program" }]
},
{
code: `
class Foo {}
class Bar {}
class Baz {}
const myExpression = class {}
`,
options: [{ ignoreExpressions: true, maxClasses: 2 }],
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved
errors: [{ messageId: "maximumExceeded", type: "Program" }]
}
]
});