Skip to content

Commit 9e3aeb9

Browse files
committed
change underscores to dash and add to readme
1 parent 748d7bf commit 9e3aeb9

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,16 +97,23 @@ After adding a hook to your pre-commit config, it's not a bad idea to run `pre-c
9797

9898
This hook checks Munki pkginfo files to ensure they are valid.
9999

100-
- Specify your preferred list of pkginfo catalogs, if you wish to enforce it, followed by `--` to signal the end of the list:
100+
- Specify your preferred list of pkginfo catalogs, if you wish to enforce it, followed by `--` to signal the end of the list:
101101
`args: ['--catalogs', 'testing', 'stable', '--']`
102102

103-
- Specify your preferred list of pkginfo categories, if you wish to enforce it, followed by `--`:
103+
- Specify your preferred list of pkginfo categories, if you wish to enforce it, followed by `--`:
104104
`args: ['--categories', 'Productivity', 'Design', 'Utilities', 'Web Browsers', '--']`
105105

106-
- Specify required pkginfo keys, followed by `--`:
107-
`args: ['--required-keys', 'category', 'description', 'developer', 'name', 'version', '--']`
106+
- Specify required pkginfo keys, followed by `--`:
107+
`args: ['--required-keys', 'category', 'description', 'developer', 'name', 'version', '--']`
108108
(default: description, name)
109109

110+
- Specify an alternate munki repo location by passing the argument:
111+
`args: ['--munki-repo', './my_repo_location']`
112+
(default: ".")
113+
114+
- Choose to just warn on missing icons with a flag, note if no other issues exist this will allow pre-commit to pass without seeing the warnings:
115+
`args: ['--warn-on-missing-icons]`
116+
110117
- __check-munkiadmin-scripts__
111118

112119
This hook ensures MunkiAdmin scripts are executable.

pre_commit_hooks/check_munki_pkgsinfo.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ def build_argument_parser():
3636
)
3737
parser.add_argument("filenames", nargs="*", help="Filenames to check.")
3838
parser.add_argument(
39-
"--munki_repo",
39+
"--munki-repo",
4040
default=".",
4141
help="path to local munki repo defaults to '.'"
4242
)
4343
parser.add_argument(
44-
"--warn_on_missing_icons",
44+
"--warn-on-missing-icons",
4545
help="If added, this will only warn on missing icons.",
4646
action="store_true",
4747
default=False,

0 commit comments

Comments
 (0)