Merge pull request #80 from homebysix/dev

1.16.1 merge to main

Author: homebysix

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-ast
       - id: check-byte-order-marker
@@ -17,6 +17,6 @@ repos:
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
   - repo: https://github.com/python/black
-    rev: 24.1.1
+    rev: 24.4.2
     hooks:
       - id: black

.pre-commit-hooks.yaml

@@ -125,6 +125,14 @@
   files: '\.recipe(\.plist|\.yaml|\.json)?$'
   types: [text]
 
+- id: format-xml-plist
+  name: Auto-format plist [XML]
+  description: Auto-format a Property List (plist) as XML.
+  entry: plutil -convert xml1
+  language: system
+  files: '\.(mobileconfig|pkginfo|plist|recipe)$'
+  types: [text]
+
 - id: munki-makecatalogs
   name: Run Munki Makecatalogs
   description: This hook runs the "makecatalogs" command to ensure all referenced packages are present and catalogs are up to date.

CHANGELOG.md

@@ -14,16 +14,33 @@ All notable changes to this project will be documented in this file. This projec
 
 Nothing yet.
 
+## [1.16.1] - 2024-06-08
+
+### Added
+
+- New `format-xml-plist` hook to auto-format XML property list (plist) files to use tabs instead of spaces, and will alphabetically sort keys. (#79, thanks to n8felton)
+- New `--valid-shebangs` parameter to specify additional custom shebangs in use for your environment. Works with the `check-munki-pkgsinfo`, `check-jamf-scripts`, `check-jamf-extension-attributes`, `check-outset-scripts`, and `check-munkiadmin-scripts` hooks. (#75, thanks to @kbrewersq)
+- Checks to ensure the MinimumVersion key in AutoPkg recipes is a string. (If quotes are omitted in yaml-formatted recipes, this key could be interpreted as a float.)
+
+### Removed
+
+- No longer warn when using AutoPkg MinimumVersion greater than 2.0.
+- Python 2 support deprecated and will be removed in the future.
+
+### Changed
+
+- Hook output rewritten to use f-strings instead of `.format()`.
+
 ## [1.15.0] - 2024-02-11
 
 ### Added
 
-- Now validates that all XML `<result>` tags are closed in Jamf extension attributes (#76, thanks to @WardsParadox).
+- Now validates that all XML `<result>` tags are closed in Jamf extension attributes. (#76, thanks to @WardsParadox)
 
 ### Fixed
 
 - Fixed a bug in the `munki-makecatalogs` hook (#72, thanks to @kbrewersq).
-- Added optional `--munki-repo` parameter to `check-munki-pkgsinfo` and `munki-makecatalogs` hooks, in order to specify a path to your Munki repo. Useful for situations where the Munki repo is a subdirectory of the Git repo itself. (#73 and #74, thanks to @kbrewersq).
+- Added optional `--munki-repo` parameter to `check-munki-pkgsinfo` and `munki-makecatalogs` hooks, in order to specify a path to your Munki repo. Useful for situations where the Munki repo is a subdirectory of the Git repo itself. (#73 and #74, thanks to @kbrewersq)
 
 ## [1.14.1] - 2023-11-20
 
@@ -35,8 +52,8 @@ Nothing yet.
 
 ### Added
 
-- `check-preference-manifests` hook now outputs more specific error message if `pfm_documentation_url` is empty (#67, thanks to @relgit).
-- `check-munki-pkgsinfo` hook now detects path mismatches on case-sensitive filesystems (#66, thanks to @AaronBurchfield).
+- `check-preference-manifests` hook now outputs more specific error message if `pfm_documentation_url` is empty. (#67, thanks to @relgit)
+- `check-munki-pkgsinfo` hook now detects path mismatches on case-sensitive filesystems. (#66, thanks to @AaronBurchfield)
 
 ## [1.13.0] - 2023-11-18
 
@@ -335,7 +352,8 @@ Nothing yet.
 
 - Initial release
 
-[Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.15.0...HEAD
+[Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.16.1...HEAD
+[1.16.1]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.15.0...v1.16.1
 [1.15.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.14.1...v1.15.0
 [1.14.1]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.14.0...v1.14.1
 [1.14.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.13.0...v1.14.0

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.15.0
+    rev: v1.16.1
     hooks:
     -   id: check-plists
     # -   id: ...
@@ -32,10 +32,6 @@ After adding a hook to your pre-commit config, it's not a bad idea to run `pre-c
     This hook checks to ensure the Git config email matches one of the specified domains:
         `args: ['--domains', 'pretendco.com', 'contoso.com', '--']`
 
-- __check-plists__
-
-    This hook checks XML property list (plist) files for basic syntax errors.
-
 - __check-munkipkg-buildinfo__
 
     This hook checks [MunkiPkg](https://github.com/munki/munki-pkg) build-info files to ensure they are valid.
@@ -44,6 +40,16 @@ After adding a hook to your pre-commit config, it's not a bad idea to run `pre-c
 
     This hook checks [Outset](https://github.com/chilcote/outset) scripts to ensure they're executable.
 
+- __check-plists__
+
+    This hook checks XML property list (plist) files for basic syntax errors. Does not modify or autoformat these files; see the `format-xml-plist` hook below if you want autoformatting.
+
+- __format-xml-plist__
+
+    This hook will auto-format XML property list (plist) files to use tabs instead of spaces, and will alphabetically sort keys.
+
+    __NOTE__: This will remove any HTML-style comments `<!--like this-->` in your plist files, so convert those to `<key>Comment</key>` format first.
+
 ### [AutoPkg](https://github.com/autopkg/autopkg)
 
 - __check-autopkg-recipe-list__
@@ -135,7 +141,7 @@ When combining arguments that take lists (for example: `--required-keys`, `--cat
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.15.0
+    rev: v1.16.1
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--']
@@ -145,7 +151,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.15.0
+    rev: v1.16.1
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--categories', 'Design', 'Engineering', 'Web Browsers', '--']
@@ -157,7 +163,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.15.0
+    rev: v1.16.1
     hooks:
     -   id: check-munki-pkgsinfo
         args: [

pre_commit_hooks/check_autopkg_recipe_list.py

@@ -48,7 +48,7 @@ def main(argv=None):
                 with open(filename, "rb") as openfile:
                     recipe_list = plistlib.load(openfile).get("recipes")
             except (ExpatError, ValueError) as err:
-                print("{}: plist parsing error: {}".format(filename, err))
+                print(f"{filename}: plist parsing error: {err}")
                 retval = 1
         elif filename.endswith((".yaml", ".yml")):
             # AutoPkg does not support YAML recipe lists, but AutoPkg users
@@ -57,7 +57,7 @@ def main(argv=None):
                 with open(filename, "r", encoding="utf-8") as openfile:
                     recipe_list = yaml.load(openfile)
             except Exception as err:
-                print("{}: yaml parsing error: {}".format(filename, err))
+                print(f"{filename}: yaml parsing error: {err}")
                 retval = 1
         elif filename.endswith(".json"):
             # AutoPkg does not support JSON recipe lists, but AutoPkg users
@@ -66,11 +66,11 @@ def main(argv=None):
                 with open(filename, "r", encoding="utf-8") as openfile:
                     recipe_list = json.load(openfile)
             except Exception as err:
-                print("{}: json parsing error: {}".format(filename, err))
+                print(f"{filename}: json parsing error: {err}")
                 retval = 1
 
         if not recipe_list or not isinstance(recipe_list, list):
-            print("{}: invalid recipe list".format(filename))
+            print(f"{filename}: invalid recipe list")
             retval = 1
         else:
             if any((".munki" in recipe for recipe in recipe_list)):