Metadata-Version: 2.1
Name: compare-locales
Version: 9.0.1
Summary: Lint Mozilla localizations
Home-page: https://github.com/mozilla/compare-locales
Author: Axel Hecht
Author-email: axel@mozilla.com
License: MPL 2.0
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Localization
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.7, <4
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: fluent.syntax (<0.20,>=0.18.0)
Requires-Dist: six
Requires-Dist: toml

![Build tests](https://github.com/mozilla/compare-locales/workflows/test/badge.svg)
# compare-locales
Lint Mozilla localizations

Finds
* missing strings
* obsolete strings
* errors on runtime errors without false positives
* warns on possible runtime errors

It also includes `l10n-merge` functionality, which pads localizations with
missing English strings, and replaces entities with errors with English.

If you want to check your original code for errors like duplicated messages,
use `moz-l10n-lint`, which is also part of this package. You can also use
this to check for conflicts between your strings and those already exposed
to l10n.

# Configuration

You configure `compare-locales` (and `moz-l10n-lint`) through a
[project configuration](https://moz-l10n-config.readthedocs.io/en/latest/fileformat.html)
file, `l10n.toml`.

# Examples

To check all locales in a project use

```bash
compare-locales l10n.toml .
```

To check Firefox against a local check-out of l10n-central, use

```bash
compare-locales browser/locales/l10n.toml ../l10n-central
```

If you just want to check particular locales, specify them as additional
commandline parameters.

To lint your local work, use

```bash
moz-l10n-lint l10n.toml
```

To check for conflicts against already existing strings:

```bash
moz-l10n-lint --reference-project ../android-l10n/mozilla-mobile/fenix l10n.toml
moz-l10n-lint --l10n-reference ../gecko-strings browser/locales/l10n.toml
```

to check for a monolithic project like Fenix or a gecko project like Firefox,
resp.