Add pre-commit hooks for formatting and linting

[jacobtylerwalls]

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Description of Change

Hand-formatting code is a drain on team productivity:

• slows development
• easily forgotten
• bloats diffs
• causes merge conflicts
• prolongs code reviews or encourages bikeshedding
• perhaps most importantly: could discourage people from contributing

This PR adds prettier to format the frontend. Run it with yarn prettier:fix.

It also adds a GitHub action that fails PRs without formatting. A hint is given:

[warn] Code style issues found in the above file. Run Prettier to fix.

Of course, that's a last resort, as pull request time is too late to get the real benefit. We can socialize the knowledge to enable either "format on save" in VS Code or install a pre-commit hook (update: included here).

Demonstration

Sample changes that would be made in other pending work:
1e79453
7629b6d

Issues Solved

Closes #10575

Checklist

• Unit tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Ticket Background

• Sponsored by: Getty Conservation Institute
• Found by: @
• Tested by: @
• Designed by: @

[chrabyrd]

Overall I like this feature. There are some merge conflicts that need to be taken care of.

I'm wondering if instead of something like yarn format , this could be added as a pre-commit hook to remove the friction of using this

[jacobtylerwalls]

I'm wondering if instead of something like yarn format , this could be added as a pre-commit hook to remove the friction of using this

Sure, I was planning to add something like that as a follow-up, but I'm happy to add a little PoC here.

[jacobtylerwalls]

Added a pre-commit hook so that folks can have a frictionless formatting experience.

To use, assuming you already have the new js dependencies like prettier itself:

pip install -r arches/install/requirements_dev.txt
pre-commit install

Then write some vue/ts by hand, attempt to commit, see the auto-fix happen as the commit aborts. You can always git commit --no-verify.

I can walk interested folks through this on the forum and update the contributor docs if this lands. It is truly optional, if you like waiting for Github Actions to fail and asking you to make more commits ;)

[jacobtylerwalls]

@chrabyrd added black, but decided to wait on eslint/ts until #10758.

[jacobtylerwalls]

Merge checklist:

• Merge arches-dev-dependencies/pull/15
• Get an approval
• Revert the package.json to point back to dev/7.6.x
• Merge this with a merge commit
• Forum post

[jacobtylerwalls]

👋 @chrabyrd ready for another look, let me know if you have any questions. Will need to repoint package.json dev dependencies back to 7.6.x before merging.

[chrabyrd]

combed the code and it looks good. Going to do one final runthrough to watch it work && it should be g2g 👍

[chrabyrd]

Gave it another lookover and runthrough and it looks and works well. There's just a few minor things to address:

1. I notice .pre-commit-config.yaml gets added to the interpolation logic in updateproject.py, but the file is never shutil-ed over.
2. Can updateproject.py and arches-admin/arches-project get updated to run pre-commit install? That way the user doesn't need to do that extra step
3. Can the 7.6.0 doc be updated to include instructions for this feature? Even if all the work is abstracted away in updateproject at least the line that says they need to reinstall dev requirements.
4. Is this involved enough to include documentation around in arches-docs?

But yeah overall these are relatively minor and this branch is nearly wrapped up. This work should undo a lot of the friction for styleguide adhesion 👍

[jacobtylerwalls]

I notice .pre-commit-config.yaml gets added to the interpolation logic in updateproject.py, but the file is never shutil-ed over.

Great catch, thanks.

Can updateproject.py and arches-admin/arches-project get updated to run pre-commit install? That way the user doesn't need to do that extra step

I'm open to it, but it's kind of breaking new ground, since I don't think updateproject or arches-admin/etc. manage python dependencies, e.g. installing the dev dependencies. I'd like to get some more input here, and would suggest to not block this work on it.

Another wrinkle is that folks might choose to pre-commit install --allow-missing-config if they're regularly switching between 7.6 and 7.5 or project/7.6.x and project/7.5.x, but I don't necessarily want to make that decision for everyone. Was going to explain that in the forum post.

Can the 7.6.0 doc be updated to include instructions for this feature? Even if all the work is abstracted away in updateproject at least the line that says they need to reinstall dev requirements.

agree 👍

Is this involved enough to include documentation around in arches-docs?

Yep, I'll raise a PR to the creating-a-development-environment section, especially if we end up not auto-installing dev dependencies.

[chrabyrd]

Can updateproject.py and arches-admin/arches-project get updated to run pre-commit install? That way the user doesn't need to do that extra step

I'm open to it, but it's kind of breaking new ground, since I don't think updateproject or arches-admin/etc. manage python dependencies, e.g. installing the dev dependencies. I'd like to get some more input here, and would suggest to not block this work on it.

Another wrinkle is that folks might choose to pre-commit install --allow-missing-config if they're regularly switching between 7.6 and 7.5 or project/7.6.x and project/7.5.x, but I don't necessarily want to make that decision for everyone. Was going to explain that in the forum post.

Yeah that's fair and a good point. As long as there's solid documentation around this then I'm good to move forward without that bit of logic 👍

[chrabyrd]

lgtm! Great feature to have and thanks for implementing it 💯

[jacobtylerwalls]

Of course, thanks for the review! Next stop: forum