This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
Replace Husky and lint-staged with pre-commit #1862
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
|
Storybook and Tailwind configuration previews: Ready Storybook: https://wordpress.github.io/openverse-frontend/_preview/1862 Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again. You can check the GitHub pages deployment action list to see the current status of the deployments. |
openverse-bot
added
🟩 priority: low
|
Size Change: -1.97 kB (0%) Total Size: 814 kB
ℹ️ View Unchanged
|
|
Weirdly Prettier is suggesting a number of strange changes to the codebase that are purely stylistic and weren't being suggested before. If someone can checkout the branch locally to see why Prettier is suggesting extra changes, that'd be very helpful. |
| @@ -0,0 +1,114 @@ | |||
| exclude: Pipfile\.lock|migrations|\.idea|node_modules | |||
There was a problem hiding this comment.
There might be more files than this to ignore as well, but I think we need at least these 🤔
Suggested change
| exclude: Pipfile\.lock|migrations|\.idea|node_modules | |
| exclude: pnpm-lock\.yaml|\.idea|node_modules|nuxt-template-overrides|\.storybook |
There was a problem hiding this comment.
@sarayourfriend I added an exception for nuxt-template-overrides in ESLint. Even without excluding the others, all checks are passing. So I think it's better to leave them in.
|
I got some missing package errors in the IDE and when linting: |
|
@obulat IDE linting will generally not work with this PR because tooling like Prettier and ESLint will not be installed as Node modules. This might be a huge drawback for this approach. |
|
We can leave the dependencies in as development dependencies anyway. It'll mean updating them in two places but we already have to update dependencies in this repository by hand anyway due to the pnpm limitations. |
5 tasks
|
@dhruvkb what's blocking here? |
|
I am facing some problems in getting Node tooling to work reliably inside the I haven't had time to debug what's behind that yet. No blockers, just been busy with some other work. |
|
@zackkrida this seems to be working now! @sarayourfriend I've left the Node dependencies unchanged so that IDE integration works. As a next step, we should uninstall Husky and lint-staged Node packages, but I'm thinking to do that in a separate because |
|
Sounds good to me to do the package.json changes in a fast-follow PR. Nice job getting this working 🚀 |
obulat
reviewed
Oct 10, 2022
obulat
reviewed
Oct 10, 2022
obulat
reviewed
Oct 10, 2022
obulat
reviewed
Oct 10, 2022
obulat
reviewed
Oct 10, 2022
obulat
approved these changes
Oct 10, 2022
Co-authored-by: Olga Bulat <obulat@gmail.com>
|
@dhruvkb observing some local error output: front on pre_commit +/- [$] via v16.15.0
❯ pnpm dev
> openverse-frontend@2.2.1 predev /Users/zackkrida/Code/openverse/front
> pnpm install && pnpm i18n:no-get
Lockfile is up-to-date, resolution step is skipped
Already up-to-date
> openverse-frontend@2.2.1 prepare /Users/zackkrida/Code/openverse/front
> pnpm pc:download && pnpm pc:install
> openverse-frontend@2.2.1 pc:download /Users/zackkrida/Code/openverse/front
> curl https://api.github.com/repos/pre-commit/pre-commit/releases/latest | grep -o 'https://.*\.pyz' -m 1 | xargs | xargs curl -fsJo pre-commit.pyz -L
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 6175 100 6175 0 0 27703 0 --:--:-- --:--:-- --:--:-- 28456
> openverse-frontend@2.2.1 pc:install /Users/zackkrida/Code/openverse/front
> python3 pre-commit.pyz install -t pre-push -t pre-commit
[ERROR] Cowardly refusing to install hooks with `core.hooksPath` set.
hint: `git config --unset-all core.hooksPath`
ELIFECYCLE Command failed with exit code 1.
ELIFECYCLE Command failed with exit code 1.
ELIFECYCLE Command failed with exit code 1. |
|
Gotta run |
|
@dhruvkb will do. Should we document that somewhere for contributors then? |
|
Yeah, I'll update the contributor docs. Should I do that in a separate PR? |
zackkrida
approved these changes
Oct 10, 2022
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.
Fixes
Fixes #1641 by @sarayourfriend
Description
This PR replaces Husky and lint-staged with the tried-and-tested pre-commit that we're already using in all other repos.
This PR
pc:*scripts to thepackage.jsonfile to download, install and run pre-commiti18n,types,test:unit)Screenshots
See how the
test:unithook is skipped during the pre-commit staged but run during pre-push stage.Testing Instructions
git config --unset core.hooksPathtest:unithook runs.Checklist
Update index.md).main) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin