Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koral--/plural_lint
plural_lint is a developer tool to check plural translations in your project. It detects both missing and unused plural quantities in the ARB files.
https://github.com/koral--/plural_lint
dart flutter i18n l10n
Last synced: about 1 month ago
JSON representation
plural_lint is a developer tool to check plural translations in your project. It detects both missing and unused plural quantities in the ARB files.
- Host: GitHub
- URL: https://github.com/koral--/plural_lint
- Owner: koral--
- License: bsd-3-clause
- Created: 2023-10-21T17:33:34.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-04T17:33:14.000Z (2 months ago)
- Last Synced: 2024-09-06T00:49:31.185Z (2 months ago)
- Topics: dart, flutter, i18n, l10n
- Language: Dart
- Homepage:
- Size: 69.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# plural_lint
[](https://pub.dev/packages/plural_lint)
[](https://pub.dev/packages/plural_lint/publisher)
**plural_lint** is a developer tool to check plural translations in your project.
It detects both missing and unused plural quantities in the ARB files for each locale according to
the Unicode CLDR plural rules.
## Installing plural_lint
plural_lint bases on [custom_lint]. To use it, you have 2 options.
Either add the dependencies to your `pubspec.yaml`:
```yaml
dev_dependencies:
custom_lint:
plural_lint:
```
Or install them from the command line:
```sh
flutter pub add --dev custom_lint plural_lint
```
Next, enable the `custom_lint` analyzer plugin in your `analysis_options.yaml`:
```yaml
analyzer:
plugins:
- custom_lint
```
## All the lints
### missing_quantity
This lint detects missing plural quantities in your translations. For example in English (`en`),
you need to provide translations for `one` and `other` quantities. In Polish (`pl`),
you need `one`, `few`, `many` and `other`.
If you don't provide all the required quantities the lint will report that as a warning.
For instance, the following entry in English ARB file:
```json
{ "things" : "{count, plural, other{things}}" }
```
Will trigger a warning:
```
warning: These quantities: [one] are missing for locale: en (missing_quantity at [app] lib/l10n/intl_en.arb:3)
```
### unused_quantity
This lint detects unused plural quantities in your translations. For example in English (`en`),
`few` and `many` quantities will never be used. Note that `zero`, `one` and `two`
are supported by dart's [intl](https://pub.dev/packages/intl) package in all languages. Even if
they are not listed in CLDR rules.
For example you can provide `zero` quantity in English despite that English doesn't distinguish
a special case for zero. See [intl implementation](https://github.com/dart-lang/i18n/blob/main/pkgs/intl/lib/intl.dart#L323)
for more details.
For instance, the following entry in English ARB file:
```json
{ "things2" : "{count, plural, one{thing} few{things} many{things} other{things}}" }
```
Will trigger a warning:
```
info: These quantities: [few, many] are not used in locale: en (unused_quantity at [app] lib/l10n/intl_en.arb:4)
```
### Data source
This package has embedded CLDR rules for plural forms in [plurals.xml](lib/src/cldr/plurals.xml).
That file is taken from the official [Unicode CLDR repository](https://github.com/unicode-org/cldr/blob/main/common/supplemental/plurals.xml).
### Disabling specific rules
By default all the lints are be enabled. You can disable specific rules by modifying
the `analysis_options.yaml` file like this:
```yaml
custom_lint:
rules:
- unused_quantity: false
- missing_quantity: false
```
## Running plural_lint from the terminal/CI
Custom lint rules may not show-up in `dart analyze`.
To fix this, invoke a `custom_lint` in the terminal:
```sh
dart run custom_lint
```
[custom_lint]: https://pub.dev/packages/custom_lint