This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
[enhancement] max-classes-per-file / config to exclude class expressions #3281
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ajafff
suggested changes
Oct 5, 2017
| @@ -1,6 +1,23 @@ | |||
| export abstract class UnsupportedVisitor extends NodeVisitor { | |||
| public static withDescriptor(descriptor: string): typeof UnsupportedVisitor { | |||
| return class extends UnsupportedVisitor { // ignores this class b/c it's an expression | |||
There was a problem hiding this comment.
the comment here is wrong and should be removed
| options: { | ||
| type: "array", | ||
| items: [ | ||
| { | ||
| type: "number", | ||
| minimum: 1, | ||
| }, | ||
| { | ||
| type: "string", |
There was a problem hiding this comment.
use "enum" to specify the valid options
src/rules/maxClassesPerFileRule.ts
Outdated
| @@ -29,20 +36,25 @@ export class Rule extends Lint.Rules.AbstractRule { | |||
| rationale: Lint.Utils.dedent` | |||
| Ensures that files have a single responsibility so that that classes each exist in their own files`, | |||
| optionsDescription: Lint.Utils.dedent` | |||
| The one required argument is an integer indicating the maximum number of classes that can appear in a file.`, | |||
| The one required argument is an integer indicating the maximum number of classes that can appear in a | |||
| file. An optional argument \`"include-class-expressions"\` can be provided to include class expressions | |||
There was a problem hiding this comment.
better use "exclude-class-expressions" since that will not change the default behavior
src/rules/maxClassesPerFileRule.ts
Outdated
| ], | ||
| additionalItems: false, | ||
| minLength: 1, | ||
| maxLength: 2, | ||
| minLength: 2, |
src/rules/maxClassesPerFileRule.ts
Outdated
| minLength: 1, | ||
| maxLength: 2, | ||
| minLength: 2, | ||
| maxLength: 3, |
There was a problem hiding this comment.
maxLength should be 2, seems like it was wrong before
added 2 commits
October 5, 2017 11:49
ajafff
reviewed
Oct 5, 2017
src/rules/maxClassesPerFileRule.ts
Outdated
| options: { | ||
| type: "array", | ||
| items: [ | ||
| { | ||
| type: "number", | ||
| minimum: 1, | ||
| }, | ||
| { | ||
| type: "string", | ||
| enum: OPTION_INCLUDE_CLASS_EXPRESSIONS, |
src/rules/maxClassesPerFileRule.ts
Outdated
| isClassLikeDeclaration(node) && | ||
| (excludeClassExpressions | ||
| ? !isClassExpression(node) | ||
| : true) |
There was a problem hiding this comment.
could also be isClassDeclaration(node) || (!excludeClassExpression && isClassExpression(node))
It's up to you which one you prefer.
src/rules/maxClassesPerFileRule.ts
Outdated
| maxClasses: number; | ||
| } | ||
|
|
||
| const OPTION_INCLUDE_CLASS_EXPRESSIONS = "exclude-class-expressions"; |
src/rules/maxClassesPerFileRule.ts
Outdated
| ], | ||
| additionalItems: false, | ||
| minLength: 1, | ||
| maxLength: 2, | ||
| }, | ||
| optionExamples: [[true, 1], [true, 5]], | ||
| optionExamples: [[true, 1], [true, 5, "exclude-class-expressions"]], |
There was a problem hiding this comment.
use the constant declared above
…o be more readable
ajafff
approved these changes
Oct 5, 2017
aervin
changed the title
|
Thanks @aervin |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR checklist
Overview of change:
Rule accepts an optional
"include-class-expressions"argument. If arg is provided, class expressions count toward the file's overall class count, otherwise they are ignored.