pre-commit: add `codespell` to check spelling #8197

jbampton · 2023-11-08T12:15:19Z

Description

This PR adds codespell to our pre-commit hooks.

The words in codespell.txt are ignored and this file has basically been created by running:

codespell . | cut -f2 -d' ' | tr A-Z a-z | sort | uniq > codespell.txt

from the repo root.

https://github.com/codespell-project/codespell

codespell is one of the leading spell checkers on GitHub.

Going forwards we will need to fix a lot of the misspelled words that are in codespell.txt

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

pre-commit run codespell --all-files

Or to run all the hooks:

pre-commit run --all-files

How did you try to break this feature and the system with this change?

codecov · 2023-11-08T12:39:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.53%. Comparing base (9f1577d) to head (416707a).
Report is 4 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #8197      +/-   ##
============================================
- Coverage     15.53%   15.53%   -0.01%     
  Complexity    11966    11966              
============================================
  Files          5492     5492              
  Lines        480929   480929              
  Branches      60325    62046    +1721     
============================================
- Hits          74710    74708       -2     
- Misses       397957   397959       +2     
  Partials       8262     8262

Flag	Coverage Δ
uitests	`4.17% <ø> (ø)`
unittests	`16.30% <ø> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

DaanHoogland · 2023-11-08T12:45:20Z

looks good @jbampton . Should we consider the contents of codespell.txt as a list of nouns to review/improve?

jbampton · 2023-11-08T13:08:39Z

Hey @DaanHoogland yes we need to review codespell.txt. It does have lots of spelling mistakes.

We can also exclude files/folders from spell checking if needed.

DaanHoogland · 2023-11-08T13:16:22Z

@jbampton , there is a bunch of PRs going on with "polish" in the name. I think this is a bit related to some of that work, And I think we should not exclude any folders. It might be worth to run this without the codespell.txt and analyse how much work it would be to clean it. I think in the end we do want to maintain a short list in that file. I.E. we do want "cloudstack" (not in the file) and "attache" to be allowed for instance. ;)
NOTE: "attache" from french "attaché" is the name of type of a piece of code responsible for managing a resource.
There is bound to be some more in there.
Very interesting addition!

jbampton · 2024-05-12T22:57:30Z

@blueorangutan package

blueorangutan · 2024-05-12T22:58:03Z

@jbampton a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-05-13T00:12:20Z

Packaging result [SF]: ✔️ el7 ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 9600

DaanHoogland · 2024-05-18T20:05:15Z

@blueorangutan test

blueorangutan · 2024-05-18T20:06:04Z

@DaanHoogland a [SL] Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

blueorangutan · 2024-05-18T20:29:58Z

[SF] Trillian Build Failed (tid-10215)

DaanHoogland · 2024-05-22T08:31:29Z

@blueorangutan test

blueorangutan · 2024-05-22T08:32:03Z

@DaanHoogland a [SL] Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

blueorangutan · 2024-05-22T23:30:11Z

[SF] Trillian test result (tid-10244)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 52031 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr8197-t10244-kvm-centos7.zip
Smoke tests completed. 129 look OK, 2 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_01_events_resource	`Error`	431.60	test_events_resource.py
test_02_trigger_shutdown	`Failure`	351.72	test_safe_shutdown.py

github-actions · 2024-05-28T07:56:16Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

DaanHoogland

@jbampton any sugestions for followup work on this? I pointed out two obviously wrong words but saw a lot more.

.github/linters/codespell.txt

jbampton · 2024-05-28T13:27:37Z

.pre-commit-config.yaml

+        name: run codespell
+        description: Check spelling with codespell
+        args: [--ignore-words=.github/linters/codespell.txt]
+        exclude: ^ui/package\.json$|^ui/package-lock\.json$|^ui/public/js/less\.min\.js$|^ui/public/locales/.*[^n].*\.json$


@DaanHoogland I am now excluding some files from spell checking

jbampton · 2024-07-08T02:40:32Z

@blueorangutan package

blueorangutan · 2024-07-08T02:42:03Z

@jbampton a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-07-08T04:33:50Z

Packaging result [SF]: ✔️ el7 ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 10281

DaanHoogland

@jbampton I like this kind of ruling but making it consistent is going to ask a lot, is it? as said earlier I still see a lot of danglish and franglish..

DaanHoogland · 2024-07-08T08:00:06Z

.github/linters/codespell.txt

 authenitcation
 authenitication
 availiability
+avialable


shouldn't be in should it?

DaanHoogland · 2024-07-08T08:00:30Z

.github/linters/codespell.txt

 confg
 configruation
 configuable
+conneciton


this doesn't seem right either.

DaanHoogland · 2024-07-08T08:01:03Z

.github/linters/codespell.txt

 reseted
 reseting
 resorce
+responser


responder I would say. not sure if this makes sense to allow

DaanHoogland · 2024-07-08T08:01:28Z

.github/linters/codespell.txt

 shoule
 sie
 signle
+simplier


should this be simpler?

DaanHoogland · 2024-07-08T08:01:45Z

.github/linters/codespell.txt

 throught
 ths
 tipically
+transction


Suggested change

transction

transaction

jbampton · 2024-07-08T12:35:45Z

Hey @DaanHoogland the list of words in .github/linters/codespell.txt will need fixing in other PRs in future.

Basically codespell ignores those words when it runs the spell check.

So this PR is just adding the codespell test and making sure it passes.

You can see that on the last commit in this PR we are regressing and new misspelled words have been added.

7384e82

So until we get this PR merged misspelled words will continue to be added the codebase.

In future as we clean up and and fix spelling we will recreate the ignored word list hopefully with less misspelled words each time.

github-actions · 2024-07-10T09:23:35Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

JoaoJandre · 2024-07-11T13:50:10Z

If I understood correctly, the .github/linters/codespell.txt file has a list of misspelled words that were found within the project and that are going to be ignored by codespell, right?
If so, should we have a plan for removing and fixing these, so that eventually the file is empty?

jbampton · 2024-07-11T14:18:14Z

Hey @JoaoJandre yes you are correct.

I have been working on spelling fixes for a while now and have a couple of PRs in progress with spell fixes.

JoaoJandre

LGTM. I saw some PRs that fixed spellings in the past and always thought that they would eventually have to be redone as new misspellings are introduced constantly. With this change we should eventually be able to fix every misspell on the codebase :)

pre-commit: add codespell to check spelling

8306ce5

jbampton force-pushed the add-codespell-to-pre-commit branch from e178a59 to 8306ce5 Compare November 8, 2023 12:17

Exclude codespell.txt from license check

c0c1270

boring-cyborg bot added the component:build label Nov 8, 2023

DaanHoogland approved these changes Nov 8, 2023

View reviewed changes

jbampton self-assigned this Nov 8, 2023

jbampton marked this pull request as draft April 26, 2024 00:47

jbampton added 2 commits May 13, 2024 07:41

Merge branch 'main' into add-codespell-to-pre-commit

a07f4f9

Update codespell.txt

fa4b85d

jbampton marked this pull request as ready for review May 12, 2024 23:26

DaanHoogland approved these changes May 18, 2024

View reviewed changes

github-actions bot added the status:has-conflicts label May 28, 2024

Merge branch 'main' into add-codespell-to-pre-commit

0c0fdfe

github-actions bot removed the status:has-conflicts label May 28, 2024

Recreate word list

b96dcd0

jbampton force-pushed the add-codespell-to-pre-commit branch from f3cdda3 to b96dcd0 Compare May 28, 2024 12:11

DaanHoogland reviewed May 28, 2024

View reviewed changes

.github/linters/codespell.txt Outdated Show resolved Hide resolved

.github/linters/codespell.txt Outdated Show resolved Hide resolved

Fix up; exclude some files from spell checking

8d28d14

jbampton commented May 28, 2024

View reviewed changes

jbampton added 2 commits July 8, 2024 12:29

Merge branch 'main' into add-codespell-to-pre-commit

ba9afc1

Recreate word list

7384e82

DaanHoogland reviewed Jul 8, 2024

View reviewed changes

github-actions bot added the status:has-conflicts label Jul 10, 2024

Merge branch 'main' into add-codespell-to-pre-commit

416707a

github-actions bot removed the status:has-conflicts label Jul 10, 2024

DaanHoogland requested a review from JoaoJandre July 11, 2024 10:56

JoaoJandre approved these changes Jul 11, 2024

View reviewed changes

DaanHoogland merged commit 2919cac into apache:main Jul 12, 2024

jbampton deleted the add-codespell-to-pre-commit branch July 12, 2024 08:11

dhslove pushed a commit to ablecloud-team/ablestack-cloud that referenced this pull request Jul 23, 2024

pre-commit: add codespell to check spelling (apache#8197)

a898e1e

DaanHoogland added this to the 4.20.0.0 milestone Sep 6, 2024

pre-commit: add codespell to check spelling #8197

pre-commit: add codespell to check spelling #8197

Uh oh!

Conversation

jbampton commented Nov 8, 2023

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented Nov 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

DaanHoogland commented Nov 8, 2023

Uh oh!

jbampton commented Nov 8, 2023

Uh oh!

DaanHoogland commented Nov 8, 2023

Uh oh!

jbampton commented May 12, 2024

Uh oh!

blueorangutan commented May 12, 2024

Uh oh!

blueorangutan commented May 13, 2024

Uh oh!

DaanHoogland commented May 18, 2024

Uh oh!

blueorangutan commented May 18, 2024

Uh oh!

blueorangutan commented May 18, 2024

Uh oh!

DaanHoogland commented May 22, 2024

Uh oh!

blueorangutan commented May 22, 2024

Uh oh!

blueorangutan commented May 22, 2024

Uh oh!

github-actions bot commented May 28, 2024

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jbampton May 28, 2024

Choose a reason for hiding this comment

Uh oh!

jbampton commented Jul 8, 2024

Uh oh!

blueorangutan commented Jul 8, 2024

Uh oh!

blueorangutan commented Jul 8, 2024

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Jul 8, 2024

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Jul 8, 2024

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Jul 8, 2024

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Jul 8, 2024

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Jul 8, 2024

Choose a reason for hiding this comment

Uh oh!

jbampton commented Jul 8, 2024

Uh oh!

github-actions bot commented Jul 10, 2024

Uh oh!

pre-commit: add `codespell` to check spelling #8197

pre-commit: add `codespell` to check spelling #8197

codecov bot commented Nov 8, 2023 •

edited

Loading