Add typos hook and fix typos (#921)

bazelbuild · Jan 18, 2025 · 0482d31 · 0482d31
1 parent e8cc369
commit 0482d31
Show file tree

Hide file tree

Showing 12 changed files with 23 additions and 11 deletions.
diff --git a/.bazelci/tests.yml b/.bazelci/tests.yml
@@ -61,7 +61,7 @@ win_tests: &win_tests
     - "-//pkg/legacy/tests/rpm/..."
 
 #
-# Commmon features and tests by platform
+# Common features and tests by platform
 #
 ubuntu2204: &ubuntu
   platform: ubuntu2204

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -10,3 +10,12 @@ repos:
       hooks:
           - id: buildifier
           - id: buildifier-lint
+    - repo: https://github.com/crate-ci/typos
+      rev: v1.29.4
+      hooks:
+        - id: typos
+          exclude: |
+            (?x)^(
+              CHANGELOG.md|
+              tests/testdata/|
+            )
diff --git a/.typos.toml b/.typos.toml
@@ -0,0 +1,3 @@
+[default.extend-words]
+FO = "FO"
+fo = "fo"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,7 +43,7 @@ Thanks to: Alex Bozhenko, Chuck Grindel, Diego Ortin, and Tomasz Wojno
 -   Align pkg_rpm returned files with other rules (#692)
 -   fix(pkg_tar): properly normalize paths for empty files (#760)
 -   Document that package_dir also uses package_variables (#747)
--   Fix handling paths with whitepsaces (#733)
+-   Fix handling paths with whitespaces (#733)
 -   Fix python 3.6, doesn't support compresslevel
 -   Use Gzip compress level 6 (#720)
 -   write debian Date field in UTC rather than local time (#712)
@@ -414,7 +414,7 @@ and Ulf Adams
 
 -   Author: aiuto <[email protected]>
     Date:   Fri May 22 14:50:42 2020 -0400
-    Add a minimal WORKSPACE file to the distributon. (#182)
+    Add a minimal WORKSPACE file to the distribution. (#182)
     We extract this from the top level workspace so it is easier to keep in sync.
 -   commit 808c192a0c48f292e6dfaaeb3bfa3d4378f6996d
 

diff --git a/docs/_includes/head.html b/docs/_includes/head.html
@@ -1,3 +1,3 @@
-<!-- _inclues/head.html -->
+<!-- _includes/head.html -->
 <meta charset="utf-8">
 <meta name="robots" content="noindex,nofollow">
diff --git a/examples/naming_package_files/package_upload.bzl b/examples/naming_package_files/package_upload.bzl
@@ -31,7 +31,7 @@ def _debian_upload_impl(ctx):
 
 debian_upload = rule(
     implementation = _debian_upload_impl,
-    doc = """A demonstraion of consuming OutputGroupInfo to get a file name.""",
+    doc = """A demonstration of consuming OutputGroupInfo to get a file name.""",
     attrs = {
         "package": attr.label(
             doc = "Package to upload",

diff --git a/examples/naming_package_files/readme.md b/examples/naming_package_files/readme.md
@@ -87,7 +87,7 @@ pkg_deb(
     name = "a_deb_package",
     package = "foo-tools",
     ...
-    # Note: target_cpu comes from the --cpu on the command line, and dows not
+    # Note: target_cpu comes from the --cpu on the command line, and does not
     # have to be stated in the BUILD file.
     package_file_name = "foo-tools_{version}-{revision}_{target_cpu}.deb",
     package_variables = ":my_naming_vars",

diff --git a/pkg/private/pkg_files.bzl b/pkg/private/pkg_files.bzl
@@ -544,7 +544,7 @@ def add_single_file(mapping_context, dest_path, src, origin, mode = None, user =
 def add_symlink(mapping_context, dest_path, src, origin):
     """Add a symlink to the content map.
 
-    TODO(aiuto): This is a vestage left from the pkg_tar use.  We could
+    TODO(aiuto): This is a vestige left from the pkg_tar use.  We could
     converge code by having pkg_tar be a macro that expands symlinks to
     pkg_symlink targets and srcs them in.
 

diff --git a/pkg/private/tar/build_tar.py b/pkg/private/tar/build_tar.py
@@ -74,7 +74,7 @@ def normalize_path(self, path: str) -> str:
     # paths should not have a leading ./
     if dest.startswith('./'):
       dest = dest[2:]
-    # No path should ever come in with slashs on either end, but protect
+    # No path should ever come in with slashes on either end, but protect
     # against that anyway.
     dest = dest.strip('/')
     # This prevents a potential problem for users with both a prefix_dir and

diff --git a/pkg/private/tar/tar_writer.py b/pkg/private/tar/tar_writer.py
@@ -107,7 +107,7 @@ def __init__(self,
     self.directories = set()
     # Preseed the added directory list with things we should not add. If we
     # some day need to allow '.' or '/' as an explicit member of the archive,
-    # we can adjust that here based on the setting of root_dirctory.
+    # we can adjust that here based on the setting of root_directory.
     self.directories.add('/')
     self.directories.add('./')
     self.create_parents = create_parents

diff --git a/tests/mappings/mappings_external_repo_test.bzl b/tests/mappings/mappings_external_repo_test.bzl
@@ -132,7 +132,7 @@ def mappings_external_repo_analysis_tests():
             # file, but then have it consumed by some remote package.
             "@mappings_test_external_repo//pkg:pf_local_file_in_extrepo",
             # This test is more focused around the verify_archive_test repo but is still
-            # based on using someting from another repo. In particular, ensuring the
+            # based on using something from another repo. In particular, ensuring the
             # verify_archive_test macro can be called properly from a workspace outside
             # of the main one.
             "@mappings_test_external_repo//pkg:external_archive_test",

diff --git a/toolchains/rpm/BUILD.tpl b/toolchains/rpm/BUILD.tpl
@@ -15,7 +15,7 @@ toolchain(
 )
 
 toolchain(
-    name = "zzz_rpmbuild_missing_toolchain",  # keep name lexigraphically last
+    name = "zzz_rpmbuild_missing_toolchain",  # keep name lexicographically last
     toolchain = "@rules_pkg//toolchains/rpm:no_rpmbuild",
     toolchain_type = "@rules_pkg//toolchains/rpm:rpmbuild_toolchain_type",
 )