docs: update angular eslint instructions #72
Conversation
WalkthroughThe changes in the Changes
Sequence Diagram(s) (Beta)Silently ignored as the changes are too simple to warrant a sequence diagram. Possibly related issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- coding-standards/angular.md (2 hunks)
Additional context used
LanguageTool
coding-standards/angular.md
[uncategorized] ~49-~49: “its” (belonging to it) seems less likely than “it’s” (it is) (AI_HYDRA_LEO_CPT_ITS_ITIS)
Context: ...roject is currently on a lower version, its recommended upgrading it to Angular 13 ...
[grammar] ~74-~74: The plural determiner ‘these’ does not agree with the singular noun ‘typescript’. (THIS_NNS)
Context: ...mport/export) - Frameworks: None of these - Typescript: No (Airbnb does not have support for T...
[uncategorized] ~75-~75: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ave support for TS, it is defined for JS and we will add additional TS support for i...
[uncategorized] ~102-~102: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...ds) ### Files to be created/modified in root directory To ensure proper setup, add ...
[grammar] ~611-~611: Did you mean “you are”, “yours are” or “your”? (YOUR_RE)
Context: ... is only recommended for the first time your are enforcing prettier rules and want to fo...
Markdownlint
coding-standards/angular.md
23-23: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
561-561: Expected: 0 or 2; Actual: 3 (MD009, no-trailing-spaces)
Trailing spaces
611-611: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
530-530: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
23-23: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
28-28: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
36-36: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
52-52: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
62-62: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
102-102: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
584-584: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
70-70: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
560-560: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
Additional comments not posted (2)
coding-standards/angular.md (2)
72-81: Update ESLint configuration instructions to reflect the removal of Airbnb style guide.The updated ESLint configuration instructions correctly reflect the removal of the Airbnb style guide, focusing now solely on syntax checking and problem identification. This aligns with the PR's objective to update the document based on outdated ESLint options.
Tools
LanguageTool
[grammar] ~74-~74: The plural determiner ‘these’ does not agree with the singular noun ‘typescript’. (THIS_NNS)
Context: ...mport/export) - Frameworks: None of these - Typescript: No (Airbnb does not have support for T...
[uncategorized] ~75-~75: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ave support for TS, it is defined for JS and we will add additional TS support for i...
555-555: Addition of new lint script inpackage.json.The addition of
"lint": "ng lint --max-warnings 0"to thepackage.jsonis a good practice to enforce zero warnings policy in linting, ensuring higher code quality standards.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
coding-standards/angular.md (1)
Line range hint
612-612: Correct grammatical error in the documentation.- This is only recommended for the first time your are enforcing prettier rules and want to format all your code according to specified rules. + This is only recommended for the first time you are enforcing prettier rules and want to format all your code according to specified rules.Tools
LanguageTool
[grammar] ~74-~74: The plural determiner ‘these’ does not agree with the singular noun ‘typescript’. (THIS_NNS)
Context: ...mport/export) - Frameworks: None of these - Typescript: No (Airbnb does not have support for T...
[uncategorized] ~75-~75: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ave support for TS, it is defined for JS and we will add additional TS support for i...Markdownlint
70-70: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- coding-standards/angular.md (3 hunks)
Additional context used
LanguageTool
coding-standards/angular.md
[grammar] ~74-~74: The plural determiner ‘these’ does not agree with the singular noun ‘typescript’. (THIS_NNS)
Context: ...mport/export) - Frameworks: None of these - Typescript: No (Airbnb does not have support for T...
[uncategorized] ~75-~75: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ave support for TS, it is defined for JS and we will add additional TS support for i...
[grammar] ~612-~612: Did you mean “you are”, “yours are” or “your”? (YOUR_RE)
Context: ... is only recommended for the first time your are enforcing prettier rules and want to fo...
Markdownlint
coding-standards/angular.md
23-23: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
561-561: Expected: 0 or 2; Actual: 4 (MD009, no-trailing-spaces)
Trailing spaces
562-562: Expected: 0 or 2; Actual: 3 (MD009, no-trailing-spaces)
Trailing spaces
612-612: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
530-530: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
23-23: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
28-28: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
36-36: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
52-52: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
62-62: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
102-102: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
585-585: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
70-70: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
Additional comments not posted (2)
coding-standards/angular.md (2)
72-81: Update ESLint configuration to reflect the removal of Airbnb style guide.The updated ESLint configuration correctly focuses on syntax checking and problem identification, aligning with the PR's objectives to simplify the ESLint setup.
Tools
LanguageTool
[grammar] ~74-~74: The plural determiner ‘these’ does not agree with the singular noun ‘typescript’. (THIS_NNS)
Context: ...mport/export) - Frameworks: None of these - Typescript: No (Airbnb does not have support for T...
[uncategorized] ~75-~75: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ave support for TS, it is defined for JS and we will add additional TS support for i...
Line range hint
546-555: Ensure the new lint script is correctly added to the project configuration.The addition of
"lint": "ng lint --max-warnings 0"to thepackage.jsonis a good practice to enforce zero warnings in linting, enhancing code quality.
xixas
changed the title
Updated the angular document as the ESLint configuration options were outdated.
Summary by CodeRabbit
"lint": "ng lint --max-warnings 0"to support linting with Angular CLI.