chore(sdk): OLD adding eslint rules for capitalize comment and explicit member accessibility #3687
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
Signed-off-by: monada-bot[bot] <[email protected]>
monadabot
added
the
⚠️ pr/review-mutation
…g/wing into tsuf/adding-eslint-rules
Signed-off-by: monada-bot[bot] <[email protected]>
…g/wing into tsuf/adding-eslint-rules
Signed-off-by: monada-bot[bot] <[email protected]>
Chriscbr
reviewed
Aug 3, 2023
Comment on lines
+218
to
+227
| // Makes sure comments and doc strings are capitalized | ||
| "capitalized-comments": [ | ||
| "error", | ||
| "always", | ||
| { | ||
| ignoreConsecutiveComments: true, | ||
| ignorePattern: "pragma|ignored", | ||
| ignoreInlineComments: true, | ||
| }, | ||
| ], |
There was a problem hiding this comment.
Can we change this to only apply to block style comments (/* ... */)? The other comments (//) aren't generated in the public APIs like our docs or the Wing IDE extension, so I don't think the capitalization matters as much
There was a problem hiding this comment.
yes, I fixed it and created another PR (to prevent rolling back the changes to the line comments)
here it is: #3725
|
opened a new one: #3725 |
tsuf239
changed the title
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.
Following @Chriscbr's comment: #3570 (comment)
I added those two rules to the SDK's linter and ran it once to apply them.
The added regulations are:
I also added a sentence to the docs referring to the importance of docstrings, which should be capitalized.
Checklist
pr/e2e-fulllabel if this feature requires end-to-end testingBy submitting this pull request, I confirm that my contribution is made under the terms of the Wing Cloud Contribution License.