Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change CI from using cspell to codespell #2467

Merged
merged 9 commits into from
Mar 21, 2024
Merged

Change CI from using cspell to codespell #2467

merged 9 commits into from
Mar 21, 2024

Conversation

pplantinga
Copy link
Collaborator

The cspell tool comes from the node.js ecosystem and apparently fails to install on some systems due to requiring a fairly recent version of GLIBC, see this issue for more details:

jupyterlab/jupyterlab#12675

This PR suggests we switch to codespell which is in python. The tool is less mature but still has > 1k stars and should be well-supported. In addition, it found a bunch more spelling errors.

@pplantinga pplantinga requested a review from Adel-Moumen March 20, 2024 23:04
Adel-Moumen
Adel-Moumen reviewed Mar 21, 2024
View reviewed changes
Copy link
Collaborator

@Adel-Moumen Adel-Moumen left a comment

Choose a reason for hiding this comment

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

ok, good! I left one comment. BTW, could you please fetch the latest speechbrain update? I suspect that you will need to run the linter on the new merged PR as well. I will check your PR locally once it's ready . Thanks again :)

recipes/Fisher-Callhome-Spanish/fisher_callhome_prepare.py Show resolved Hide resolved
@Adel-Moumen
Copy link
Collaborator 

(cspell) amoumen@hades:~/machine_learning/speechbrain/pr/cspell/speechbrain$ pre-commit install 
pre-commit installed at .git/hooks/pre-commit
(cspell) amoumen@hades:~/machine_learning/speechbrain/pr/cspell/speechbrain$ pre-commit run --all-files
[INFO] Initializing environment for https://github.com/codespell-project/codespell.
[INFO] Initializing environment for https://github.com/codespell-project/codespell:tomli.
[INFO] Installing environment for https://github.com/codespell-project/codespell.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
Trim Trailing Whitespace.................................................Passed
Fix End of Files.........................................................Passed
Fix requirements.txt.....................................................Passed
Mixed line ending........................................................Passed
Check for added large files..............................................Passed
black....................................................................Passed
flake8...................................................................Passed
yamllint.................................................................Passed
codespell................................................................Passed

Adel-Moumen
Adel-Moumen approved these changes Mar 21, 2024
View reviewed changes
Copy link
Collaborator

@Adel-Moumen Adel-Moumen left a comment

Choose a reason for hiding this comment

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

LGTM! Works on my lab cluster now.

@Adel-Moumen Adel-Moumen merged commit 341e35c into speechbrain:develop Mar 21, 2024
5 checks passed
pchampio pushed a commit to pchampio/speechbrain that referenced this pull request Apr 17, 2024
@pplantinga @pchampio
Change CI from using cspell to codespell (speechbrain#2467)
3ae753e
@pplantinga pplantinga deleted the cspell-to-codespell branch September 10, 2024 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Adel-Moumen Adel-Moumen Adel-Moumen approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pplantinga @Adel-Moumen