pypa / hatch

Modern, extensible Python project management
https://hatch.pypa.io/latest/
MIT License
5.52k stars 270 forks source link

Fix a typo found by codespell #1479

Closed DimitriPapadopoulos closed 3 weeks ago

DimitriPapadopoulos commented 3 weeks ago

I'm not a fan of pre-comit, but that's what virtualenv and wheel use:

virtualenv/.pre-commit-config.yaml Lines 12 to 16 in 7864fde

  - repo: https://github.com/codespell-project/codespell
    rev: v2.2.6
    hooks:
      - id: codespell
        args: ["--write-changes"]

wheel/.pre-commit-config.yaml Lines 27 to 30 in 0b7771e

- repo: https://github.com/codespell-project/codespell
  rev: v2.2.6
  hooks:
  - id: codespell

If you prefer GitHub workflows, have a look at:

fsspec/filesystem_spec.github/workflows/codespell.yml

---
name: Codespell

on:
  push:
    branches: [master]
  pull_request:
    branches: [master]

jobs:
  codespell:
    name: Check for spelling errors
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Codespell
        uses: codespell-project/actions-codespell@v1

Whatever you decide, codespell is not 100% proof, so you might have to maintain a list of false positives to disable.