This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
Rewrite and simplify comment-format #2616
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
andy-hanson
reviewed
Apr 20, 2017
| @@ -10,7 +10,8 @@ class Clazz { // This comment is correct | |||
| console.log("test"); //This comment has no space | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~ [space] | |||
| } | |||
| /// <reference or something> | |||
| /// <not a reference> | |||
| ~~~~~~~~~~~~~~~~~~~ [space] | |||
There was a problem hiding this comment.
This error message could be better -- there is a space, the problem is the extra /.
There was a problem hiding this comment.
Yeah, it should handle comments starting with more than 2 slashes better. The comment text should only be checked starting from the first non-slash character.
And maybe there could be a new option to disallow more than 2 slashes
nchen63
suggested changes
May 11, 2017
| super(sourceFile, options); | ||
| function parseOptions(options: Array<string | IExceptionsObject>): Options { | ||
| return { | ||
| case: options.indexOf(OPTION_LOWERCASE) !== -1 |
There was a problem hiding this comment.
nested ternary is discouraged
src/rules/commentFormatRule.ts
Outdated
| } | ||
| const commentText = fullText.slice(start, end); | ||
| // whitelist //#region and //#endregion and JetBrains IDEs' "//noinspection ..." | ||
| if (/^(?:#(!?end)?region|noinspection\s)/.test(commentText)) { |
There was a problem hiding this comment.
what is the !?end part for? This matches !end
There was a problem hiding this comment.
You're right, that should be ?:end
adidahiya
approved these changes
May 31, 2017
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:
Initially I just wanted to convert the walker to a function. But then I needed to change so much it became a complete rewrite.
Is there anything you'd like reviewers to focus on?
CHANGELOG.md entry:
[enhancement]
comment-formatno longer excludes comments with triple slash from linting except/// <reference path="..."/>