Fixes #1474 - added pre-commit linter #1538

magsout · 2017-04-27T10:53:49Z

I just added the pre-commit part #1474 (comment)

zoepage · 2017-05-03T11:30:06Z

@magsout Sorry for the late review. Had issues with my setup.

I get two errors. Could you take a look please? :)

/webcompat/webcompat.com/webcompat/static/js/lib/labels.js
  159:59  error  Follow `prettier` formatting (expected '\n' but found ' ')  prettier/prettier
/webcompat/webcompat.com/webcompat/static/js/lib/models/query-params.js
  278:28  error  Follow `prettier` formatting (expected '\n' but found ' ')  prettier/prettier

✖ 2 problems (2 errors, 0 warnings)

Would you also like to add the information about the pre-linter to that PR? Would be great. Otherwise I'm happy to file a follow up issue and add it.
#1474 (comment)

magsout · 2017-05-03T14:31:58Z

I get two errors. Could you take a look please? :)

Yeah, I had exactly these errors. I think we should blocked the version of prettier to avoid this kind of errors. If you check the version of prettier in node_modules it is different than 1.1.0..

magsout · 2017-05-03T14:33:23Z

Would you also like to add the information about the pre-linter to that PR? Would be great. Otherwise I'm happy to file a follow up issue and add it.
#1474 (comment)

@zoepage oups, I I have forgotten, I'll do.

Thanks for the review.

zoepage · 2017-05-08T11:44:35Z

@magsout I know, you are super busy right now (FAMILY always comes FIRST 🎉)
Is there anything I could help with? (If not, don't worry.)

magsout · 2017-05-09T12:53:38Z

@magsout I know, you are super busy right now (FAMILY always comes FIRST 🎉)
Is there anything I could help with? (If not, don't worry.)

@zoepage oups, sorry, I'm on it. I'll take care of it Friday night...

magsout · 2017-05-14T14:40:23Z

@zoepage sorry for the delay..

I have sent a commit for the documentation. Tell me what do you think ?

docs/pr-coding-guidelines.md

+`npm run lint` check all JavaScript files and display the resulting errors. If you get errors, you have two possibilities. You can correct yourself or you can run `npm run fix` which use Prettier to format the code. 
+
+In order to avoid errors during a Pull Request, `npm run lint` will be executed before each commit.
+
 @@something to write by miketaylr@@


package.json

-    "prettier": "^1.1.0",
-    "suitcss-utils-align": "^0.2.0",
-    "suitcss-utils-display": "^0.4.0"
+    "prettier": "^1.1.0"


docs/pr-coding-guidelines.md


 > Note: All code changes should be made to the files in `lib`

+#### Linting
+
+For the consistency of our codebase, we use eslint with these rules: https://github.com/webcompat/webcompat.com/blob/master/.eslintrc. We also use Prettier for formatting our code. We have set up two recipes to check and fixe the codebase.


docs/pr-coding-guidelines.md

+
+For the consistency of our codebase, we use eslint with these rules: https://github.com/webcompat/webcompat.com/blob/master/.eslintrc. We also use Prettier for formatting our code. We have set up two recipes to check and fixe the codebase.
+
+`npm run lint` check all JavaScript files and display the resulting errors. If you get errors, you have two possibilities. You can correct yourself or you can run `npm run fix` which use Prettier to format the code. 


docs/pr-coding-guidelines.md

+
+`npm run lint` check all JavaScript files and display the resulting errors. If you get errors, you have two possibilities. You can correct yourself or you can run `npm run fix` which use Prettier to format the code. 
+
+In order to avoid errors during a Pull Request, `npm run lint` will be executed before each commit.


magsout · 2017-05-19T20:51:57Z

Done @zoepage

magsout · 2017-05-19T20:52:24Z

let me know if it's ok. I'll rebase my commits

zoepage · 2017-05-20T13:25:58Z

@magsout I'll try to check ASAP. Might take 1-2 days. Sorry!

zoepage · 2017-05-31T09:37:23Z

Hey @magsout!
Found one tiny thing (I'm sure, I didn't see it before or suggested a wrong fix).

After that, feel free to rebase and merge! Great job! 🎉

docs/pr-coding-guidelines.md

+
+If you get an error displayed, there are two ways to fix it.
+1. You can run `npm run fix` automatically, which is great for small issues like missing spaces or lines in various files.
+2. You can correct it manually as every error message includes the file and line of the error as well as the rule which was violated.


package.json

+    "precommit": "lint-staged"
+  },
+  "lint-staged": {
+    "{webcompat/static/js/lib, tests, grunt-tasks}/**/*.js": "lint"


magsout · 2017-06-06T11:22:11Z

thanks a lot @zoepage for your review. ❤️

magsout added status: in progress in progress labels Apr 27, 2017

magsout changed the title ~~Fixes #1474 - added pre-commit~~ Fixes #1474 - added pre-commit linter Apr 28, 2017

magsout requested a review from zoepage April 28, 2017 19:28

magsout added lang: JS status: needs review and removed status: in progress labels Apr 28, 2017

magsout mentioned this pull request May 3, 2017

Pin the prettier version to specific version #1548

Closed

zoepage reviewed May 14, 2017

View reviewed changes

zoepage suggested changes May 15, 2017

View reviewed changes

zoepage suggested changes May 31, 2017

View reviewed changes

magsout added 4 commits June 6, 2017 09:48

No Issue. splited up dependencies / devDependencies

8a44374

Issue #1474 - added pre-commit

dbaae3f

Issue #1474 - added documentation

eee042b

Issue #1548 - pin version of prettier

28b27e4

magsout force-pushed the issues/1474 branch from e79d9f7 to 28b27e4 Compare June 6, 2017 07:56

magsout merged commit 603bd54 into master Jun 6, 2017

magsout added status: accepted and removed in progress labels Jun 6, 2017

magsout added status: add to changelog and removed status: needs review labels Jun 6, 2017

magsout deleted the issues/1474 branch June 6, 2017 11:24

miketaylr removed the status: add to changelog label Jun 20, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #1474 - added pre-commit linter #1538

Fixes #1474 - added pre-commit linter #1538

magsout commented Apr 27, 2017 •

edited

Loading

zoepage commented May 3, 2017

magsout commented May 3, 2017 •

edited

Loading

magsout commented May 3, 2017 •

edited

Loading

zoepage commented May 8, 2017

magsout commented May 9, 2017

magsout commented May 14, 2017

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

magsout commented May 19, 2017

magsout commented May 19, 2017

zoepage commented May 20, 2017

zoepage commented May 31, 2017

This comment was marked as abuse.

This comment was marked as abuse.

magsout commented Jun 6, 2017 •

edited

Loading


		For the consistency of our codebase, we use eslint with these rules: https://github.com/webcompat/webcompat.com/blob/master/.eslintrc. We also use Prettier for formatting our code. We have set up two recipes to check and fixe the codebase.

		`npm run lint` check all JavaScript files and display the resulting errors. If you get errors, you have two possibilities. You can correct yourself or you can run `npm run fix` which use Prettier to format the code.


		`npm run lint` check all JavaScript files and display the resulting errors. If you get errors, you have two possibilities. You can correct yourself or you can run `npm run fix` which use Prettier to format the code.

		In order to avoid errors during a Pull Request, `npm run lint` will be executed before each commit.

Fixes #1474 - added pre-commit linter #1538

Fixes #1474 - added pre-commit linter #1538

Conversation

magsout commented Apr 27, 2017 • edited Loading

zoepage commented May 3, 2017

magsout commented May 3, 2017 • edited Loading

magsout commented May 3, 2017 • edited Loading

zoepage commented May 8, 2017

magsout commented May 9, 2017

magsout commented May 14, 2017

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

magsout commented May 19, 2017

magsout commented May 19, 2017

zoepage commented May 20, 2017

zoepage commented May 31, 2017

This comment was marked as abuse.

This comment was marked as abuse.

magsout commented Jun 6, 2017 • edited Loading

magsout commented Apr 27, 2017 •

edited

Loading

magsout commented May 3, 2017 •

edited

Loading

magsout commented May 3, 2017 •

edited

Loading

magsout commented Jun 6, 2017 •

edited

Loading