Add 'standard-metadata' hook

Author: mondeja

.bumpversion.cfg

@@ -1,4 +1,4 @@
 [bumpversion]
-current_version = 1.3.1
+current_version = 1.3.2
 
 [bumpversion:file:setup.cfg]

.pre-commit-hooks.yaml

@@ -28,3 +28,9 @@
   description: Checks that the metadata values of your PO files matchs against some regexes
   files: \.po$
   language: python
+- id: standard-metadata
+  name: standard-metadata
+  entry: check-metadata-hook --standard-headers
+  description: Checks that the metadata of your PO files fits a set of standard requirements.
+  files: \.po$
+  language: python

README.md

@@ -51,7 +51,7 @@ Replaces a matching string at the beginning of extracted comments.
 
 Same as [`lreplace-extracted-comments`][lreplace-extracted-comments-link]
 passing `--match "Translators: " --replacement ""`. Useful to remove the string
-prepended by Django extracting messages with gettext (see more about this
+prepended by Django extracting messages with xgettext (see more about this
 problem in [django-rosetta#245][django-rosetta-lstrip]).
 
 ### **`check-metadata`**
@@ -69,6 +69,28 @@ Check that metadata fields matches a set of regular expressions.
 - `-n/--no-metadata`: When this option is passed, the hook instead checks that
  there is no metadata in the files, so it will exit with code 1 if some
  metadata is found in a file or 0 if there is no metadata in any files.
+
+### **`standard-metadata`**
+
+Check that the metadata of your PO files fits some standard requirements based
+on the next regular expressions:
+
+- `Project-Id-Version`: `\d+\.\d+\.\d`
+- `Report-Msgid-Bugs-To`: `.+\s<.+@.+\..+>`
+- `Last-Translator`: `.+\s<.+@.+\..+>`
+- `Language-Team`: `.+\s<.+@.+\..+>`
+- `Language`: `\w\w_?\w?\w?(@\w+)?`
+- `Content-Type`: `text/plain; charset=[a-zA-Z\-]+`
+- `Content-Transfer-Encoding`: `\d+bits?`
+
+If you need to replace some fields with other regular expressions, you can do
+it passing the `-h` and `-v` arguments of the
+[`check-metadata` hook][check-metadata-link].
+
+For example, if your version
+includes the character `v` at the beginning:
+`-h "Project-Id-Version" -v "v\d+\.\d+\.\d"`
+
 
 [pypi-link]: https://pypi.org/project/pre-commit-po-hooks
 [pypi-version-badge-link]: https://img.shields.io/pypi/v/pre-commit-po-hooks
@@ -79,4 +101,5 @@ Check that metadata fields matches a set of regular expressions.
 [tests-link]: https://github.com/mondeja/pre-commit-po-hooks/actions?query=workflow%CI
 
 [lreplace-extracted-comments-link]: https://github.com/mondeja/pre-commit-po-hooks#lreplace-extracted-comments
+[check-metadata-link]: https://github.com/mondeja/pre-commit-po-hooks#check-metadata
 [django-rosetta-lstrip]: https://github.com/mbi/django-rosetta/pull/245

hooks/check_metadata.py

@@ -128,6 +128,23 @@ def main():
             " information, exits with code 1."
         ),
     )
+    parser.add_argument(
+        "-s",
+        "--standard-headers",
+        action="store_true",
+        dest="standard_headers",
+        help=(
+            "A common standard set of headers will be defined as specification."
+            " Each value can be overwritten using '-h' and '-v' arguments."
+            "\n\n- 'Project-Id-Version': \\d+\\.\\d+\\.\\d\n"
+            "- 'Report-Msgid-Bugs-To': .+\\s<.+@.+\\..+>\n"
+            "- 'Last-Translator': .+\\s<.+@.+\\..+>\n"
+            "- 'Language-Team': .+\\s<.+@.+\\..+>\n"
+            "- 'Language': \\w\\w_?\\w?\\w?(@\\w+)?\n"
+            "- 'Content-Type': text/plain; charset=[A-Z\\-]+\n"
+            r"- 'Content-Transfer-Encoding': \d+bits?"
+        ),
+    )
     parser.add_argument("-q", "--quiet", action="store_true", help="Supress output")
     args = parser.parse_args()
 
@@ -137,6 +154,27 @@ def main():
             " but both can't be non false."
         )
 
+    if args.no_metadata and args.standard_headers:
+        raise ValueError(
+            "You must pass either '--no-metadata' or standard headers regexes"
+            " specification."
+        )
+
+    if args.standard_headers:
+        new_headers_spec = {
+            "Project-Id-Version": r"\d+\.\d+\.\d",
+            "Report-Msgid-Bugs-To": r".+\s<.+@.+\..+>",
+            "Last-Translator": r".+\s<.+@.+\..+>",
+            "Language-Team": r".+\s<.+@.+\..+>",
+            "Language": r"\w\w_?\w?\w?(@\w+)?",
+            "Content-Type": r"text/plain; charset=[a-zA-Z\-]+",
+            "Content-Transfer-Encoding": r"\d+bits?",
+        }
+        if headers_spec:
+            new_headers_spec.update(headers_spec)
+
+        headers_spec = new_headers_spec
+
     return check_metadata(
         args.filenames,
         headers_spec,

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pre_commit_po_hooks
-version = 1.3.1
+version = 1.3.2
 description = pre-commit hooks for PO files
 long_description = file: README.md
 long_description_content_type = text/markdown