pre-commit

[norlandrhagen]

• Added .pre-commit config yaml file, which is a copy of the Pithia Foundations pre-commit config
• Ran pre-commit on existing files in the cookbook template

cc @brian-rose

[github-actions]

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below.
🔍 Git commit SHA: b82a470
✅ Deployment Preview URL: https://ProjectPythia.github.io/cookbook-template/_preview/103

[brian-rose]

This looks great @norlandrhagen, thanks for putting it together!

My only hesitation against merging now is that we've had a lot of bother in other repos with pre-commit autoupdate PRs. The problem is with prettier, which has a series of 3.0.0-alpha.* releases. We aren't interested in using pre-release versions of these tools, but the auto-update tool keeps trying to increment prettier to the latest alpha release.

So for months now we've been manually editing the auto-update PRs to strip away the prettier update. It's been tedious, and I worry about spreading that tedium around to all the Cookbook repos...

I see three potential solutions:

1. We just wait on merging this until prettier 3.0.0 is released
2. We figure out a solution to prevent alpha releases from being included in the auto-update
3. We change the frequency of auto-update. Currently it's weekly. If we reduced to monthly, that would ease the tedium quite a bit.

I don't know how to do 2 or 3! Any ideas?

[norlandrhagen]

Hey there @brian-rose, thanks for the feedback!

I'm fine with any of those. Waiting until prettier 3.0.0 seem fine, definitely don't want to create more tedious cleanup work!

As for exploring option #2, I'm not sure if it works, but can we pin the prettier version?
Something like is mentioned in this issue: pre-commit/pre-commit-hooks#332

  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: v2.7.1
    hooks:
      - id: prettier
        additional_dependencies: [prettier@v2.7.1]

[brian-rose]

As for exploring option #2, I'm not sure if it works, but can we pin the prettier version?

I don't know if it will work either, but let's give it a try! We can try it out here in the template repo for a week or so and see what autoupdates get generated. If we're happy these changes, then we can migrate them to all the existing cookbook repos.

[brian-rose]

Thanks for your contribution @norlandrhagen !

[norlandrhagen]

Thanks @brian-rose! Not sure if it'll work, but fingers crossed.