ci: add require formly documentation rule #1019
Merged
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
Eisie96
suggested changes
Feb 21, 2022
| function hasPrecedingComment(node: TSESTree.ClassDeclaration) { | ||
| return ( | ||
| context.getSourceCode().getCommentsBefore(node)?.length > 0 || | ||
| context.getSourceCode().getCommentsBefore(node.decorators?.[0])?.length > 0 |
There was a problem hiding this comment.
getCommentsBefore cannot be called with a falsy object. node.decorators?.[0] could be undefined.
Eisie96
approved these changes
Feb 21, 2022
SGrueber
pushed a commit
that referenced
this pull request
May 19, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 Type
[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no API changes)
[ ] Build-related changes
[x] CI-related changes
[ ] Documentation content changes
[ ] Application / infrastructure changes
[ ] Other:
## What Is the Current Behavior?
Currently, no one is checking whether your formly artifacts are documented.
Issue Number: Closes #
## What Is the New Behavior?
Now, an eslint rule enforces (hopefully explanatory) comments before formly artifacts.
## Does this PR Introduce a Breaking Change?
[ ] Yes
[x] No
## Other Information
AB#74442