ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
canvas-lms/hooks/pre-commit

11 lines
347 B
Plaintext
Raw Normal View History

Add precommit hook for auto fixing files This only affects javascript files and only affects things from the prettier whitelist This will run slowly if you don't have node_modules installed locally (e.g., in Docker), but it will gladly attempt to run things in Docker for you. This adds a new githook_installer image that will install the githook whenever a docker-compose up happens in the repo. It will also install the hook whenever a `yarn` occurs locally (as a postinstall hook). This commit should also not fail things. For example having unused variables is an ESLint error, but it isn't autofixable. It will log the error, but will otherwise continue. However, it will make this pretty with prettier as well as fix any other autofixable ESLint errors. closes CORE-2118 Test Plan: - Run `yarn` - Add some semicolons to something from the whitelist - git add that file - git commit and it will strip semicolons - In a dockerized Canvas: - docker-compose up - Add semicolons to a file - git add that file - git commit, it will take forever (~60s) - It should have stripped out semicolons Change-Id: Id9198aa008808e898f29acb9ed64dd14ff843222 Reviewed-on: https://gerrit.instructure.com/171510 Tested-by: Jenkins Reviewed-by: Brent Burgoyne <bburgoyne@instructure.com> QA-Review: Brent Burgoyne <bburgoyne@instructure.com> Product-Review: Brent Burgoyne <bburgoyne@instructure.com>
2018-11-08 07:04:08 +08:00
#!/bin/sh
fix pre-commit hook with unfixable eslint error test plan: - have a local yarn install - add an unfixable lint error (unused var) to a file in the prettier whitelist - try to commit the file - it should not try to run in docker after the lint error Change-Id: If1fcfc6693be26c6f6fdddb8cfa4c54a73512ebe Reviewed-on: https://gerrit.instructure.com/173469 Reviewed-by: Clay Diffrient <cdiffrient@instructure.com> QA-Review: Clay Diffrient <cdiffrient@instructure.com> Product-Review: Clay Diffrient <cdiffrient@instructure.com> Tested-by: Jenkins
2018-11-28 06:40:21 +08:00
if [ -f node_modules/.bin/lint-staged ]; then
yarn run --silent lint:staged
else
echo 'Trying to run lint:staged inside Docker, if you want things quicker yarn install locally.'
docker-compose run --rm --no-deps web yarn run lint:staged ||
echo 'You should run `yarn` locally or check to make sure docker is running.'
fi
Add precommit hook for auto fixing files This only affects javascript files and only affects things from the prettier whitelist This will run slowly if you don't have node_modules installed locally (e.g., in Docker), but it will gladly attempt to run things in Docker for you. This adds a new githook_installer image that will install the githook whenever a docker-compose up happens in the repo. It will also install the hook whenever a `yarn` occurs locally (as a postinstall hook). This commit should also not fail things. For example having unused variables is an ESLint error, but it isn't autofixable. It will log the error, but will otherwise continue. However, it will make this pretty with prettier as well as fix any other autofixable ESLint errors. closes CORE-2118 Test Plan: - Run `yarn` - Add some semicolons to something from the whitelist - git add that file - git commit and it will strip semicolons - In a dockerized Canvas: - docker-compose up - Add semicolons to a file - git add that file - git commit, it will take forever (~60s) - It should have stripped out semicolons Change-Id: Id9198aa008808e898f29acb9ed64dd14ff843222 Reviewed-on: https://gerrit.instructure.com/171510 Tested-by: Jenkins Reviewed-by: Brent Burgoyne <bburgoyne@instructure.com> QA-Review: Brent Burgoyne <bburgoyne@instructure.com> Product-Review: Brent Burgoyne <bburgoyne@instructure.com>
2018-11-08 07:04:08 +08:00
fix pre-commit hook with unfixable eslint error test plan: - have a local yarn install - add an unfixable lint error (unused var) to a file in the prettier whitelist - try to commit the file - it should not try to run in docker after the lint error Change-Id: If1fcfc6693be26c6f6fdddb8cfa4c54a73512ebe Reviewed-on: https://gerrit.instructure.com/173469 Reviewed-by: Clay Diffrient <cdiffrient@instructure.com> QA-Review: Clay Diffrient <cdiffrient@instructure.com> Product-Review: Clay Diffrient <cdiffrient@instructure.com> Tested-by: Jenkins
2018-11-28 06:40:21 +08:00
exit 0