DEMO: Github action to catch linting & formating issues #2422
Conversation
- Reformat & cleanup the doc as well Issue #2096
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| /** | ||
| * a method without sufficient documentation |
There was a problem hiding this comment.
Missing JSDoc @param "x" declaration.
| /** | |
| * a method without sufficient documentation | |
| /** | |
| * a method without sufficient documentation | |
| * @param x | |
| * @param y |
| /** | ||
| * a method without sufficient documentation |
There was a problem hiding this comment.
Missing JSDoc @param "y" declaration.
| /** | |
| * a method without sufficient documentation | |
| /** | |
| * a method without sufficient documentation | |
| * @param x | |
| * @param y | |
| * @param x | |
| * @param y |
| /** | ||
| * a method without sufficient documentation | ||
| */ |
There was a problem hiding this comment.
Missing JSDoc @returns declaration.
| /** | ||
| * a method without sufficient documentation | ||
| */ | ||
| aNewMethodWithLintingAndFormattingErrors: function (x, y) { |
There was a problem hiding this comment.
Unexpected unnamed method 'aNewMethodWithLintingAndFormattingErrors'.
| /** | ||
| * a method without sufficient documentation | ||
| */ | ||
| aNewMethodWithLintingAndFormattingErrors: function (x, y) { |
There was a problem hiding this comment.
🚫 [eslint] <object-shorthand> reported by reviewdog 🐶
Expected method shorthand.
| aNewMethodWithLintingAndFormattingErrors: function (x, y) { | |
| aNewMethodWithLintingAndFormattingErrors (x, y) { |
| /** | ||
| * a method without sufficient documentation | ||
| */ | ||
| aNewMethodWithLintingAndFormattingErrors: function (x, y) { |
There was a problem hiding this comment.
🚫 [eslint] <no-unused-vars> reported by reviewdog 🐶
'y' is defined but never used.
| */ | ||
| aNewMethodWithLintingAndFormattingErrors: function (x, y) { | ||
| const a = 1; | ||
| a = 999; |
There was a problem hiding this comment.
🚫 [eslint] <no-const-assign> reported by reviewdog 🐶
'a' is constant.
| aNewMethodWithLintingAndFormattingErrors: function (x, y) { | ||
| const a = 1; | ||
| a = 999; | ||
| var b=2; |
There was a problem hiding this comment.
🚫 [eslint] <vars-on-top> reported by reviewdog 🐶
All 'var' declarations must be at the top of the function scope.
| aNewMethodWithLintingAndFormattingErrors: function (x, y) { | ||
| const a = 1; | ||
| a = 999; | ||
| var b=2; |
| const a = 1; | ||
| a = 999; | ||
| var b=2; | ||
| console.log("this is just a test of the new linter and formatter") |
There was a problem hiding this comment.
Unexpected console statement.
| @@ -468,6 +468,18 @@ define([ | |||
| $("body").off("activate"); | |||
| $(window).off("resize"); | |||
| }, | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| * a method without sufficient documentation | ||
| */ | ||
| aNewMethodWithLintingAndFormattingErrors: function (x, y) { | ||
| const a = 1; |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| const a = 1; | |
| const a = 1; |
| var b=2; | ||
| console.log("this is just a test of the new linter and formatter") | ||
| return a + b; |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| var b=2; | |
| console.log("this is just a test of the new linter and formatter") | |
| return a + b; | |
| var b = 2; | |
| console.log("this is just a test of the new linter and formatter"); | |
| return a + b; |
robyngit
force-pushed
the
feature-2096-linting-formatting
branch
from
420bdeb
to
2284d19
Compare
This PR demonstrates new Github Actions introduced in PR #2412. It's just a demonstration and should no be merged. The PR introduced a new function that has linting and formatting errors. The github action will catch these errors and make comments on the PR with specific issues and suggested fixes.