Skip to content

Codespell#12

Merged
mOctave merged 20 commits intomOctave:mainfrom
TheGiraffe3:codespell
Aug 9, 2025
Merged

Codespell#12
mOctave merged 20 commits intomOctave:mainfrom
TheGiraffe3:codespell

Conversation

@TheGiraffe3
Copy link
Contributor

@TheGiraffe3 TheGiraffe3 commented Aug 3, 2025

CI/CD/Testing

Fixes #11

Checklist

  • I have read and understand the Contributing Guidelines
  • I accept the terms of the AGPL-3-or-later license of this project, and recognize that, if and when this pull request is merged, I relinquish individual ownership of my work.
  • I did not use generative AI to write any code or create any other part of this PR

For code PRs only:
- [ ] I have tested any code I've added, and added unit tests where needed
- [ ] I have added Javadoc comments to all my new code
- [ ] I have updated the copyright header of all files I've made significant changes to, or do not wish to have my name attached to this wretched piece of work

Summary

Adds a codespell to find typos.
Also fixes typos the codespell found.

In draft form as it doesn't fully work yet

Usage examples

When you commit something, the check will tell you how many typos you've made. The goal, of course, is to have this number be 0.

Testing

Tests itself.

Performance Impact

Hopefully none

@TheGiraffe3
Copy link
Contributor Author

So, I have a question...
In the current state of the PR, we get this warning:
Screen Shot 2025-08-03 at 8 21 45 AM
When I try to fix that by ignoring the files that cause the warning, we get:
Screen Shot 2025-08-03 at 8 22 08 AM

How much do you care about fixing the warning? It seems to be an issue with the COPYRIGHT files in question, but it might be an issue with the codespell, and I'm not entirely sure how to tell which.

@mOctave
Copy link
Owner

mOctave commented Aug 3, 2025

Hmm, I think the warning is probably okay? I'll take a look at it tomorrow.

@TheGiraffe3 TheGiraffe3 marked this pull request as ready for review August 3, 2025 05:36
show-progress: false
- uses: codespell-project/actions-codespell@master
with:
exclude_file: site/java/testapidocs/script-dir/jquery-3.5.1.min.js,site/java/apidocs/script-dir/jquery-3.5.1.min.js
Copy link
Owner

Choose a reason for hiding this comment

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

Is there a way to exclude everything under ./site/java or ./site/python instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Owner

Choose a reason for hiding this comment

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

Okay, I'll merge this for now and play with it later

@mOctave
Copy link
Owner

mOctave commented Aug 3, 2025

Looks like the warnings are getting triggered by Oracle's copyright file, which we can't control and which shouldn't have any meaning-affecting typos anyways, so it should be okay to just ignore it.

@mOctave mOctave merged commit be492b4 into mOctave:main Aug 9, 2025
4 checks passed
@TheGiraffe3 TheGiraffe3 deleted the codespell branch August 9, 2025 05:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(Feat) Codespell

2 participants