Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Speed up pre-commit hooks #124

Merged
merged 3 commits into from
Aug 12, 2021
Merged

Speed up pre-commit hooks #124

merged 3 commits into from
Aug 12, 2021

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Aug 12, 2021

Fixes

Fixes #122 by @zackkrida

Description

This PR updates the pre-commit hook to only run on the actually changed file, which should drastically cut down time to commit.

Technical details

The lint-staged runner passes a list of changed files as arguments to the commands.

Our current configuration invokes npm run lint-staged which is equal to the following.

"lint-staged": "npm run lintfix && npm run format"

This is not lint-staged and runs these commands on all files.

lint-staged must be invoked with npx lint-staged and must be passed an array of commands that it can then invoke only on the changed files.

Tests

  1. Make changes in two files, some that are genuine and some just to violate lint rules.
  2. Add one file to the stage.
  3. Commit the file.
  4. lint-staged will lint it, fix it (if possible) and commit it, leaving the other one untouched.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb requested a review from a team as a code owner August 12, 2021 15:28
@dhruvkb dhruvkb added this to Needs review in Openverse Aug 12, 2021
@dhruvkb dhruvkb added the 🤖 aspect: dx Concerns developers' experience with the codebase label Aug 12, 2021
Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fast! ⚡️ Nice!

Openverse automation moved this from Needs review to Reviewer approved Aug 12, 2021
@zackkrida
Copy link
Member

LGTM

@dhruvkb dhruvkb merged commit dbc8918 into main Aug 12, 2021
@dhruvkb dhruvkb deleted the fast_hooks branch August 12, 2021 15:48
Openverse automation moved this from Reviewer approved to Done! Aug 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase
Projects
No open projects
Openverse
  
Done!
Development

Successfully merging this pull request may close these issues.

[Feature] Make pre-commit hooks faster
3 participants