Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilib-js/ilib-lint-python-gnu
An ilib-lint plugin that allows it to parse po files and to define rules appropriate for resources from python using the gnu gettext library
https://github.com/ilib-js/ilib-lint-python-gnu
Last synced: 3 days ago
JSON representation
An ilib-lint plugin that allows it to parse po files and to define rules appropriate for resources from python using the gnu gettext library
- Host: GitHub
- URL: https://github.com/ilib-js/ilib-lint-python-gnu
- Owner: iLib-js
- License: apache-2.0
- Created: 2022-12-27T20:43:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T04:34:43.000Z (7 months ago)
- Last Synced: 2024-04-25T05:08:10.117Z (7 months ago)
- Language: JavaScript
- Size: 64.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ilib-lint-python-gnu
An ilib-lint plugin that provides the ability to check resources that come
from code written in python using the gnu gettext library.
## Installation
```
npm install --save-dev ilib-lint-python-gnu
or
yarn add --dev ilib-lint-python-gnu
```
Then, in your `ilib-lib-config.json`, add a script:
```
"plugins": [
"python-gnu"
],
```
Please note: nodejs version 14 or above is required to run ilib-lint, as it
is written with ESM modules.
## Parser
This plugin provides a class that can parse PO files and convert them into
resources. This class depends on the ilib-loctool-po plugin to do the heavy
lifting.
## Rules
The following rules apply to any resources from any file type, but are
designed to check resources that come from python code using the gnu gettext
library.
- resource-printf-params-match - check that any printf-style substitution
parameters (like "%s" or "%d") that appear in the source string also appear
in the target strings.
- resource-printf-params-numbered - check that if the source string contains more
than one substitution parameter, then the parameters are properly numbered
so that the translators can rearrange them as needed by the
grammar of the target language.
## RuleSets
This plugin defines one ruleset `python-gnu` that will turn on all the rules
that this plugin supports. Users may rely on this ruleset when defining their
file types.
## License
Copyright © 2022-2024, JEDLSoft
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Release Notes
### v2.0.1
- Fixed a bug where the exports were not properly set up in the package.json
### v2.0.0
- Updated dependency from i18nlint-common to ilib-lint-common
- IntermediateRepresentation now takes a SourceFile as an
parameter to the constructor instead of a file path
- can now be loaded by ilib-lint >= v2
### v1.2.0
- updated dependencies, including updating to i18nlint-common 2.x
- parser now returns an array of IntermediateRepresentation objects
### v1.1.0
- updated dependencies
- added getType() method to the POParser plugin
- now return the results of parsing from the POParser.parse() method
### v1.0.0
- initial version
- PO parser for gnu .po and .pot files
- Python rules for gnu gettext resources