Merge pull request #95 from homebysix/dev

1.21.0 merge to main

Author: homebysix

.coveragerc

@@ -1,5 +1,5 @@
 [run]
-include = pre_commit_hooks/*
+include = pre_commit_macadmin_hooks/*
 
 [report]
 exclude_lines =

.gitignore

@@ -10,6 +10,11 @@ __pycache__/
 coverage.xml
 htmlcov/
 
+# Package development
+*.egg-info/
+build/
+dist/
+
 # Virtual environments
 .venv/
 venv/

.pre-commit-config.yaml

@@ -1,15 +1,15 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-ast
-      - id: check-byte-order-marker
       - id: check-case-conflict
       - id: check-docstring-first
       - id: check-executables-have-shebangs
       - id: check-merge-conflict
       - id: check-yaml
       - id: end-of-file-fixer
+      - id: fix-byte-order-marker
       - id: mixed-line-ending
       - id: no-commit-to-branch
         args: [--branch, main]
@@ -29,6 +29,6 @@ repos:
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 25.1.0
+    rev: 25.9.0
     hooks:
       - id: black

CHANGELOG.md

@@ -14,6 +14,16 @@ All notable changes to this project will be documented in this file. This projec
 
 Nothing yet.
 
+## [1.21.0] - 2025-09-21
+
+### Added
+
+- `check-munki-pkgsinfo` now detects the incorrect key `condition` and suggests using `installable_condition` instead.
+
+### Changed
+
+- Renamed internal package from `pre_commit_hooks` to `pre_commit_macadmin_hooks` to resolve namespace collision with the official `pre_commit_hooks` [package](https://github.com/pre-commit/pre-commit-hooks). (#78)
+
 ## [1.20.0] - 2025-08-09
 
 ### Added
@@ -425,7 +435,10 @@ Nothing yet.
 
 - Initial release
 
-[Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.18.0...HEAD
+[Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.21.0...HEAD
+[1.21.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.20.0...v1.21.0
+[1.20.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.19.0...v1.20.0
+[1.19.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.18.0...v1.19.0
 [1.18.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.17.0...v1.18.0
 [1.17.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.16.2...v1.17.0
 [1.16.2]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.16.1...v1.16.2

README.md

@@ -15,7 +15,7 @@ For any hook in this repo you wish to use, add the following to your pre-commit
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.20.0
+    rev: v1.21.0
     hooks:
     -   id: check-plists
     # -   id: ...
@@ -147,7 +147,7 @@ When combining arguments that take lists (for example: `--required-keys`, `--cat
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.20.0
+    rev: v1.21.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--']
@@ -157,7 +157,7 @@ But if you also use the `--categories` argument, you would move the trailing `--
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.20.0
+    rev: v1.21.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--categories', 'Design', 'Engineering', 'Web Browsers', '--']
@@ -169,7 +169,7 @@ If it looks better to your eye, feel free to use a multi-line list for long argu
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.20.0
+    rev: v1.21.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: [

pre_commit_hooks/__init__.py pre_commit_macadmin_hooks/__init__.pypre_commit_hooks/__init__.py renamed to pre_commit_macadmin_hooks/__init__.py

@@ -8,14 +8,15 @@
 import argparse
 import json
 import plistlib
+from typing import List, Optional
 from xml.parsers.expat import ExpatError
 
 import ruamel.yaml
 
 yaml = ruamel.yaml.YAML(typ="safe")
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -25,7 +26,7 @@ def build_argument_parser():
     return parser
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.

…ommit_hooks/check_autopkg_recipe_list.py …admin_hooks/check_autopkg_recipe_list.pypre_commit_hooks/check_autopkg_recipe_list.py renamed to pre_commit_macadmin_hooks/check_autopkg_recipe_list.py pre_commit_hooks/check_autopkg_recipe_list.py renamed to pre_commit_macadmin_hooks/check_autopkg_recipe_list.py

@@ -6,10 +6,11 @@
 import os
 import sys
 from contextlib import contextmanager
+from typing import Any, Dict, List
 
 from packaging.version import Version
 
-from pre_commit_hooks.util import (
+from pre_commit_macadmin_hooks.util import (
     detect_deprecated_keys,
     detect_typoed_keys,
     load_autopkg_recipe,
@@ -23,7 +24,7 @@
 
 # Import AutoPkg libraries, but ignore any warnings generated by the import.
 @contextmanager
-def suppress_stdout():
+def suppress_stdout() -> Any:
     with open(os.devnull, "w", encoding="utf-8") as devnull:
         old_stdout = sys.stdout
         sys.stdout = devnull
@@ -36,15 +37,18 @@ def suppress_stdout():
 sys.path.append("/Library/AutoPkg")
 try:
     with suppress_stdout():
-        from autopkglib import get_processor, processor_names
+        from autopkglib import (  # type: ignore[import-not-found]
+            get_processor,
+            processor_names,
+        )
 
     HAS_AUTOPKGLIB = True
 except ImportError:
     # Silently skip checks that require autopkglib.
     HAS_AUTOPKGLIB = False
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -83,7 +87,9 @@ def build_argument_parser():
     return parser
 
 
-def validate_recipe_prefix(recipe, filename, prefix):
+def validate_recipe_prefix(
+    recipe: Dict[str, Any], filename: str, prefix: List[str]
+) -> bool:
     """Verify that the recipe identifier starts with the expected prefix."""
 
     passed = True

pre_commit_hooks/check_autopkg_recipes.py …_macadmin_hooks/check_autopkg_recipes.pypre_commit_hooks/check_autopkg_recipes.py renamed to pre_commit_macadmin_hooks/check_autopkg_recipes.py pre_commit_hooks/check_autopkg_recipes.py renamed to pre_commit_macadmin_hooks/check_autopkg_recipes.py

@@ -3,9 +3,10 @@
 
 import argparse
 import subprocess
+from typing import List, Optional
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -19,7 +20,7 @@ def build_argument_parser():
     return parser
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.

…e_commit_hooks/check_git_config_email.py …macadmin_hooks/check_git_config_email.pypre_commit_hooks/check_git_config_email.py renamed to pre_commit_macadmin_hooks/check_git_config_email.py pre_commit_hooks/check_git_config_email.py renamed to pre_commit_macadmin_hooks/check_git_config_email.py

@@ -3,11 +3,12 @@
 
 import argparse
 import re
+from typing import List, Optional
 
-from pre_commit_hooks.util import validate_shebangs
+from pre_commit_macadmin_hooks.util import validate_shebangs
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -23,7 +24,7 @@ def build_argument_parser():
     return parser
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.