Skip to content

Add Typos to CI#1430

Merged
cmadjar merged 3 commits into
aces:mainfrom
MaximeBICMTL:typos
Jun 11, 2026
Merged

Add Typos to CI#1430
cmadjar merged 3 commits into
aces:mainfrom
MaximeBICMTL:typos

Conversation

@MaximeBICMTL

@MaximeBICMTL MaximeBICMTL commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Description

This PR adds Typos as a development tool for LORIS Python.

Typos is a language-agnostic tool to find typos in a codebase, including code files, documentation... It can be installed using pip (among others), and run locally, as an IDE extension, and/or in CI. It is really fast (built in Rust) and usually has a small number of false positives (it uses a dictionary of known typos, 3 false positives found in this PR).

Details

  • This first commit does the following:
    • Add Typos as a Python development dependency (pip install .[dev])
    • Configure Typos in pyproject.toml
    • Add a dedicated Typos step in our GitHub Actions
    • Add a new typos_to_github.sh test file to display the typos found directly in the GitHub interface.
  • The second commit fixes non-bug typos.
  • The third commit fixes a bug typo ( 🙀 ).

The configuration uses the US English locale since it is the most international English variant and is arguably simpler.

@MaximeBICMTL MaximeBICMTL added Area: CI Issue or PR related to continuous integration, including automated tests and static checks Complexity: Simple Issue or PR that should be simple to implement, review, or test Category: Bug Issue or PR that aims to report or fix a bug labels Jun 2, 2026
@MaximeBICMTL MaximeBICMTL force-pushed the typos branch 2 times, most recently from 13eb16f to cc024ca Compare June 2, 2026 11:18
@github-actions github-actions Bot added the Language: Python Issue or PR related to the Python codebase label Jun 2, 2026
@MaximeBICMTL MaximeBICMTL force-pushed the typos branch 10 times, most recently from cdb39df to f4b318f Compare June 3, 2026 03:35
@github-actions github-actions Bot added Package: Utilities PR or issue related to the LORIS-agnostic utilities Package: BIDS utilities PR or issue related to the BIDS utilities labels Jun 3, 2026
@MaximeBICMTL MaximeBICMTL changed the base branch from main to bids_staging_branch June 3, 2026 03:36
@github-actions github-actions Bot added Package: DICOM importer PR or issue related to the DICOM importer Package: Electrophysiology chunker PR or issue related to the electrophysiology chunker labels Jun 3, 2026
@MaximeBICMTL MaximeBICMTL marked this pull request as ready for review June 3, 2026 03:47
@cmadjar cmadjar added this to the 29.0.0 milestone Jun 11, 2026
@MaximeBICMTL MaximeBICMTL changed the base branch from bids_staging_branch to main June 11, 2026 15:04
@cmadjar cmadjar merged commit bab2d50 into aces:main Jun 11, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: CI Issue or PR related to continuous integration, including automated tests and static checks Category: Bug Issue or PR that aims to report or fix a bug Complexity: Simple Issue or PR that should be simple to implement, review, or test Language: Python Issue or PR related to the Python codebase Package: BIDS utilities PR or issue related to the BIDS utilities Package: DICOM importer PR or issue related to the DICOM importer Package: Electrophysiology chunker PR or issue related to the electrophysiology chunker Package: Utilities PR or issue related to the LORIS-agnostic utilities

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants