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.

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

Add codespell (config, precommit, workflow) and make it fix typos #670

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Commits on Feb 20, 2024

  1. Configuration menu
    Copy the full SHA
    037e8ca View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    e32a19a View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    5547848 View commit details
    Browse the repository at this point in the history
  4. Fix pyproject for black -- exclude must be a string regex, not array

    Otherwise black does not work
    
        ❯ black shpc/client/__init__.py
        Invalid config keys detected: 'profile' (in /home/yoh/proj/misc/singularity-hpc/pyproject.toml)
        Usage: black [OPTIONS] SRC ...
        Try 'black -h' for help.
    
        Error: Config key exclude must be a string
    
        ❯ black --version
        black, 24.2.0 (compiled: yes)
        Python (CPython) 3.11.8
    yarikoptic committed Feb 20, 2024
    Configuration menu
    Copy the full SHA
    98f4b43 View commit details
    Browse the repository at this point in the history
  5. [DATALAD RUNCMD] run codespell throughout fixing typo automagically

    === Do not change lines below ===
    {
     "chain": [],
     "cmd": "codespell -w || :",
     "exit": 0,
     "extra_inputs": [],
     "inputs": [],
     "outputs": [],
     "pwd": "."
    }
    ^^^ Do not change lines above ^^^
    yarikoptic committed Feb 20, 2024
    Configuration menu
    Copy the full SHA
    54dc38b View commit details
    Browse the repository at this point in the history
  6. [DATALAD RUNCMD] Do interactive fixing of typos

    === Do not change lines below ===
    {
     "chain": [],
     "cmd": "codespell -w -i 3 -C 2",
     "exit": 0,
     "extra_inputs": [],
     "inputs": [],
     "outputs": [],
     "pwd": "."
    }
    ^^^ Do not change lines above ^^^
    yarikoptic committed Feb 20, 2024
    Configuration menu
    Copy the full SHA
    1a41fed View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    62fd25b View commit details
    Browse the repository at this point in the history