pre-commit hooks for PO files
Project description
pre-commit-po-hooks
Hooks for pre-commit useful working with PO files.
Example configuration
- repo: https://github.com/mondeja/pre-commit-po-hooks
rev: v1.6.0
hooks:
- id: obsolete-messages
- id: untranslated-messages
- id: remove-django-translators
- id: standard-metadata
- id: max-lines
args: ["10000"]
Hooks
obsolete-messages
Checks for obsolete messages printing their line numbers if found.
untranslated-messages
Checks for untranslated messages printing their line numbers if found.
Parameters
-m/--min
: Minimum number of messages that must be translated in each file to pass this check. Can be defined as a percentage of the messages translated appending a character%
at the end of the value.
lreplace-extracted-comments
Replaces a matching string at the beginning of extracted comments.
Parameters
-m/--match "STRING"
: Matching string to be replaced.-r/--replacement "STRING"
: Replacement for the match at the beginning of the extracted comment. If you want to remove the matching beginning you can pass an empty string""
.-d/--dry-run
: Don't do the replacements, only writes to stderr the locations of the extracted comments to be replaced.
remove-django-translators
Same as lreplace-extracted-comments
passing --match "Translators: " --replacement ""
. Useful to remove the string
prepended by Django extracting messages with xgettext (see more about this
problem in django-rosetta#245).
check-metadata
Check that metadata fields matches a set of regular expressions.
Parameters
-h/--header HEADER
: Header name to match in metadata. This argument can be passed multiple times, but after each-h/--header
argument must be a-v/--value
that indicates the regular expression for that header.-v/--value REGEX
: Can be passed multiple times. Indicates the regular expression that the last header passed in the argument-h/--header
must match in the checked PO files.-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.-r/--remove/--remove-metadata
: When this option is passed the metadata will be removed from the files instead of being trated as a lint error.
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=[0-9a-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.
For example, if your version includes the character v
at the beginning:
-h "Project-Id-Version" -v "v\d+\.\d+\.\d"
no-metadata
It will check if PO files has metadata. If has metadata, it will fail the check returning exit code 1.
Parameters
-r/--remove/--remove-metadata
: When this option is passed the metadata will be removed from the files instead of being treated as a lint error.
remove-metadata
Remove metadata headers from your PO files. This is an alias for
no-metadata
hook passing --remove-metadata
argument.
max-messages
Define a maximum number of entries for each PO file. Pass an interger in the first argument:
- id: max-messages
args:
- "5000"
Parameters
- Maximum number of messages allowed for each PO file.
max-lines
Define a maximum number of lines for each PO file. Pass an interger in the first argument:
- id: max-lines
args:
- "10000"
Parameters
- Maximum number of lines allowed for each PO file.
min-translated
Define a minimum number of files that must be translated in order to pass.
Pass a float or a value ending with %
character if you wan to compare
against the percentage of translated files:
- id: min-translated
args:
- "95%"
Parameters
- Minimum number or percentage of messages which must be translated in each PO file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pre_commit_po_hooks-1.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b712a6d21b3b6147cfdc2cd3379c0c1c205ae26bcfdbaceaf6a182936f55874f |
|
MD5 | c48354ec1968b56d4adac009baf72f55 |
|
BLAKE2b-256 | f39194d967d78340423c1b2575801d2147b020544f0ddcd738786704fec8b344 |
Hashes for pre_commit_po_hooks-1.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4fd9c7bb2b389bbf7b23d88e6613f9bd167759b9a0604b1c71b8eeabaa44984d |
|
MD5 | f72d77f48a616efbd5c53951adfa5d91 |
|
BLAKE2b-256 | 9153f97a7f8230b613aa5841b286997db090e047bbfe0fe2a1ab059c3c4d5fc4 |