Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace yorkie #992

Open
matthew-white opened this issue May 9, 2024 · 0 comments
Open

Replace yorkie #992

matthew-white opened this issue May 9, 2024 · 0 comments
Labels
infrastructure Low-level infrastructure, including the build

Comments

@matthew-white
Copy link
Member

We use yorkie to add a Git hook to ensure that bin/transifex/destructure.js is run for each commit:

"gitHooks": {
"pre-commit": "node bin/transifex/restructure.js && git diff --exit-code -- transifex/strings_en.json"
},

yorkie is a fork of husky, but we use yorkie because it came with Vue CLI: https://cli.vuejs.org/guide/cli-service.html#git-hooks. However, yorkie doesn't seem to be maintained: it hasn't been updated since 2018 even as updates have been made to husky. After we move to Vite (#671), I think we should consider replacing yorkie with something else (with husky?). yorkie seems to be reasonably popular, with 412K downloads in the past week, though that's much less than husky's 8.7M.

One thing to keep in mind is that yorkie may need to be manually uninstalled in repos in which npm install has been run. Uninstalling the npm package isn't enough to remove the Git hooks that yorkie adds when it's installed. I think that unless yorkie is manually uninstalled, trying to make a commit will result in an error. See #827 (comment) for details.

@matthew-white matthew-white added the infrastructure Low-level infrastructure, including the build label May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Low-level infrastructure, including the build
Projects
None yet
Development

No branches or pull requests

1 participant