chore: Add typos pre-commit hook (#503)

hofbi · alexeagle · web-flow · commit 23f0f019df79 · 2025-01-24T03:08:53.000Z
Automated typo fixes

---

### Changes are visible to end-users: yes

Typos were mainly fixed in the docs/docstrings

---------

Co-authored-by: Alex Eagle &lt;alex@aspect.build&gt;
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -54,6 +54,8 @@ jobs:
 
   test-release:
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write # allow commenting to the PR with the token
     defaults:
       run:
         working-directory: e2e/use_release
@@ -71,6 +73,7 @@ jobs:
       # The github-actions-report-lcov doesn't follow symlinks, so get an absolute path
       - run: echo "bazel_testlogs=$(bazel info bazel-testlogs)" >> $GITHUB_ENV
       - name: Report code coverage
+        if: github.event.pull_request.head.repo.fork == false # Forks always have read-only tokens
         uses: zgosalvez/github-actions-report-lcov@5989987f8058a03137e90bc16f9c0baaac5e069a # v4.1.22
         with:
           working-directory: ${{ env.bazel_testlogs }}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -24,3 +24,12 @@ repos:
     rev: "v3.1.0"
     hooks:
       - id: prettier
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.28.4
+    hooks:
+      - id: typos
+        exclude: |
+          (?x)^(
+            examples/django/mysite/settings.py|
+            gazelle_python.yaml
+          )
diff --git a/.typos.toml b/.typos.toml
@@ -0,0 +1,3 @@
+[default.extend-identifiers]
+MODULEs = "MODULEs"  # Else it becomes MODULEEs
+alocation = "alocation"  # Used as 'a location'
diff --git a/docs/py_binary.md b/docs/py_binary.md
diff --git a/docs/py_test.md b/docs/py_test.md
diff --git a/docs/venv.md b/docs/venv.md
diff --git a/e2e/system-interpreter/README.md b/e2e/system-interpreter/README.md
@@ -1,4 +1,4 @@
-# Test system interperter
+# Test system interpreter
 
 This is a minimal test that rules_py can use a toolchain that relies on the system interpreter.
 Note that this is setup to run on Aspect's CI, and locally on a MacOS, paths may vary on your system if running this.
diff --git a/py/private/providers.bzl b/py/private/providers.bzl
@@ -11,7 +11,7 @@ PyWheelInfo = provider(
 PyVirtualInfo = provider(
     doc = "FIXME",
     fields = {
-        "dependencies": "Depset of required virtual dependencies, independant of their resolution status",
+        "dependencies": "Depset of required virtual dependencies, independent of their resolution status",
         "resolutions": "FIXME",
     },
 )
diff --git a/py/private/py_binary.bzl b/py/private/py_binary.bzl
@@ -147,7 +147,7 @@ _attrs = dict({
     ),
     "package_collisions": attr.string(
         doc = """The action that should be taken when a symlink collision is encountered when creating the venv.
-A collision can occour when multiple packages providing the same file are installed into the venv. The possible values are:
+A collision can occur when multiple packages providing the same file are installed into the venv. The possible values are:
 
 * "error": When conflicting symlinks are found, an error is reported and venv creation halts.
 * "warning": When conflicting symlinks are found, an warning is reported, however venv creation continues.
diff --git a/py/private/py_venv.bzl b/py/private/py_venv.bzl
@@ -115,7 +115,7 @@ py_venv_rule = rule(
         ),
         "package_collisions": attr.string(
             doc = """The action that should be taken when a symlink collision is encountered when creating the venv.
-A collision can occour when multiple packages providing the same file are installed into the venv. The possible values are:
+A collision can occur when multiple packages providing the same file are installed into the venv. The possible values are:
 
 * "error": When conflicting symlinks are found, an error is reported and venv creation halts.
 * "warning": When conflicting symlinks are found, an warning is reported, however venv creation continues.
diff --git a/py/private/virtual.bzl b/py/private/virtual.bzl
@@ -1,6 +1,6 @@
 """Utility functions around managing virtual dependencies and resoloutions"""
 
-_RESOLUTION_SENTINAL_KEY = "_RESOLUTION_SENTINAL"
+_RESOLUTION_SENTINEL_KEY = "_RESOLUTION_SENTINEL"
 
 def _make_resolutions(base, requirement_fn = lambda r: r):
     """Returns data representing the resolution for a given set of dependencies
@@ -13,7 +13,7 @@ def _make_resolutions(base, requirement_fn = lambda r: r):
         A resolution struct for use with virtual deps.
     """
 
-    if not _RESOLUTION_SENTINAL_KEY in base:
+    if not _RESOLUTION_SENTINEL_KEY in base:
         _resolutions = dict([
             [
                 k,
@@ -23,14 +23,14 @@ def _make_resolutions(base, requirement_fn = lambda r: r):
                 ),
             ]
             for k in base.keys()
-        ], **{_RESOLUTION_SENTINAL_KEY: True})
+        ], **{_RESOLUTION_SENTINEL_KEY: True})
     else:
         _resolutions = base
 
     return struct(
         resolutions = _resolutions,
         override = lambda overrides, **kwargs: _make_resolutions(_make_overrides(_resolutions, overrides)),
-        to_label_keyed_dict = lambda: dict({v.requirement: v.name for k, v in _resolutions.items() if k != _RESOLUTION_SENTINAL_KEY}),
+        to_label_keyed_dict = lambda: dict({v.requirement: v.name for k, v in _resolutions.items() if k != _RESOLUTION_SENTINEL_KEY}),
     )
 
 def _make_overrides(resolutions, overrides):
diff --git a/py/tools/pex/main.py b/py/tools/pex/main.py
@@ -120,7 +120,7 @@ def __call__(self, parser, namespace, value, option_str=None):
     INJECT_TEMPLATE.append("sys.path.append(os.path.abspath(os.path.join(__entry_point__, '%s')))" % path)
 
 import_idx =  BE.index("from pex.pex_bootstrapper import bootstrap_pex")
-# This is here to catch potential future bugs where pex package is updated here but the boostrap 
+# This is here to catch potential future bugs where pex package is updated here but the bootstrap 
 # script was not checked again to see if we are still injecting values in the right place.
 assert import_idx == 3703, "Check bootstrap template monkey patching."
 
diff --git a/py/tools/py/src/unpack.rs b/py/tools/py/src/unpack.rs
@@ -48,7 +48,7 @@ pub fn unpack_wheel(version: &str, location: &Path, wheel: &Path) -> Result<()>
     let filename = wheel
         .file_name()
         .and_then(|f| f.to_str())
-        .expect("Exepected to get filename from wheel path");
+        .expect("Expected to get filename from wheel path");
     let wheel_file_name =
         uv_distribution_filename::WheelFilename::from_str(filename).into_diagnostic()?;
 
diff --git a/py/tools/unpack_bin/src/main.rs b/py/tools/unpack_bin/src/main.rs
@@ -16,7 +16,7 @@ struct UnpackArgs {
     wheel: PathBuf,
 
     /// Python version, eg 3.8.12
-    /// Must be seperated by dots.
+    /// Must be separated by dots.
     #[arg(long)]
     python_version: String,
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[default.extend-identifiers]`
	`2`	`+MODULEs = "MODULEs" # Else it becomes MODULEEs`
	`3`	`+alocation = "alocation" # Used as 'a location'`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ PyWheelInfo = provider(`
`11`	`11`	`PyVirtualInfo = provider(`
`12`	`12`	`doc = "FIXME",`
`13`	`13`	`fields = {`
`14`		`- "dependencies": "Depset of required virtual dependencies, independant of their resolution status",`
	`14`	`+ "dependencies": "Depset of required virtual dependencies, independent of their resolution status",`
`15`	`15`	`"resolutions": "FIXME",`
`16`	`16`	`},`
`17`	`17`	`)`