add typos spell checker to pre-commit

[Adam-D-Lewis]

Reference Issues or PRs

Adds typos to the pre-commit config to fix a lot of uncaught typos.

I think the biggest benefit of adding typos is that it caught quite a few typos that codespell doesn't catch. I'm okay with trying to leave codespell and typos both in the pre-commit file, but they may conflict eventually. If that's the case, perhaps we remove either codespell or typos at that time from the pre-commit file.

Typos is faster than codespell. Typos took 0.2 seconds to run while typos took 0.05 seconds to run in my test, but I think the time difference is not important since they are both quick to run.

What does this implement/fix?

Put a x in the boxes that apply

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds a feature)
• Breaking change (fix or feature that would cause existing features not to work as expected)
• Documentation Update
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no API changes)
• Build related changes
• Other (please describe):

Testing

• Did you test the pull request locally?
• Did you add new tests?

Any other comments?

[Adam-D-Lewis]

We should catch this in the update step and update the spelling for users if they had this set explicitly.

[viniciusdc]

I would add a # typos: ignore here for now, and a todo to address this for next release, so that we add as part of the update method as suggested. to keep this in mind, we could pin the issue in our notes, or in the issues tab

[Adam-D-Lewis]

We will likely need to delete the old file during the nebari update step since otherwise it'll leave it behind in the stages folder. We've done this in the past.

[Adam-D-Lewis]

Even though this isn't done yet (see my comments), I'd be curious to get any feedback on it @dcmcand @marcelovilla @viniciusdc

[marcelovilla]

@Adam-D-Lewis thank you for this! I wouldn't have thought we had that many typos in the code base and it's great you're adding a hook to catch them.

I'm not familiar with either codespell or typos but it seems typos worked great in this case so I think leaving it for now might be good enough.

As for fixing the typo in the configuration file, I agree we should include the logic to fix the spelling in the user's config file and delete the rendered terraform file during the upgrade step. However, I don't think it's necessarily urgent and we could have a separate PR for that if you think it's more convenient.

[viniciusdc]

I completely agree on what @marcelovilla said above as well, and would vote for a separate PR to address the changes in the config file.

[Adam-D-Lewis]

@viniciusdc Alright, I pushed off the 2 things which would take a bit more work to resolve and opened issues for them so we can get this in sooner rather than later. @viniciusdc or @marcelovilla Can you review again?

[viniciusdc]

LGTM, nice tool! 🚀