Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romanrostislavovich/ngx-translate-lint
Simple CLI tools for check `ngx-translate` keys
https://github.com/romanrostislavovich/ngx-translate-lint
angular checker cli hacktoberfest lint linting ngx-translate translate typescript validator
Last synced: about 1 month ago
JSON representation
Simple CLI tools for check `ngx-translate` keys
- Host: GitHub
- URL: https://github.com/romanrostislavovich/ngx-translate-lint
- Owner: romanrostislavovich
- License: mit
- Created: 2019-05-22T15:51:12.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-28T08:41:29.000Z (about 2 months ago)
- Last Synced: 2024-10-28T10:43:35.016Z (about 2 months ago)
- Topics: angular, checker, cli, hacktoberfest, lint, linting, ngx-translate, translate, typescript, validator
- Language: TypeScript
- Homepage:
- Size: 874 KB
- Stars: 32
- Watchers: 1
- Forks: 9
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-angular - ngx-translate-lint - Simple CLI tools for check `ngx-translate` keys. (Table of contents / Angular)
- fucking-awesome-angular - ngx-translate-lint - Simple CLI tools for check `ngx-translate` keys. (Table of contents / Angular)
README
# ngx-translate-lint
> Simple tools for check ngx-translate keys in Angular applications in whole app which use regexp.
[](https://travis-ci.com/svoboda-rabstvo/ngx-translate-lint)
[](https://github.com/semantic-release/semantic-release)
[](https://www.npmjs.com/package/ngx-translate-lint)
[](https://www.npmjs.com/package/ngx-translate-lint)
> for `react-intl` use [`react-intl-lint`](https://www.npmjs.com/package/react-intl-lint)
>
> for `react-i18next` use [`react-i18next-lint`](https://www.npmjs.com/package/react-i18next-lint)
## Table of Contents
- [Background](#background)
- [Installation](#installation)
- [Usage](#usage)
- [CLI](#cli)
- [TypeScript](#typescript)
- [Contribute](#contribute)
- [Used By](#used-by)
- [License](#license)
## Background
There are a lot of translation [`ngx-translate`][ngx-translate] keys in the whole app.
This repository contains a proposal to check all translation keys in the whole app
which should exist in all languages files.
## Installation
### NPM
```bash
npm install ngx-translate-lint -g
```
### GitHub
The source code are available for download
at [GitHub Releases][github-release-url] and
[GitHub pages][github-pages-url] as well.
## Usage
### CLI
```text
Usage: ngx-translate-lint [options]
Simple CLI tools for check `ngx-translate` keys in app
Options:
-p, --project [glob] (required)
The path to project folder
Possible Values:
(default: "./src/app/**/*.{html,ts}")
-l, --languages [glob] (required)
The path to languages folder
Possible Values:
(default: "./src/assets/i18n/*.json")
-kv, --keysOnViews [enum]
Described how to handle the error of missing keys on view
Possible Values:
(default: "error")
-zk, --zombieKeys [enum]
Described how to handle the error of zombies keys.
Zombie keys are keys that doesn't exist on any languages file but exist on project,
or exist languages but doesn't exist on project
Possible Values:
(default: "warning")
-ek, --emptyKeys [enum]
Described how to handle empty value on translate keys.
Empty keys are keys that doesn't have any value on languages files
Possible Values:
(default: "warning")
-i, --ignore [glob]
Ignore projects and languages files
Possible Values:
--maxWarning [glob]
Max count of warnings in all files. If this value more that count of warnings, then an error is return
Possible Values:
(default: "0")
-mk, --misprintKeys [enum]
Try to find matches with misprint keys on views and languages keys. CCan be longer process!!
Possible Values:
(default: "disable")
-ds, --deepSearch [enum]
Add each translate key to global regexp end try to find them on project. Can be longer process!!
Possible Values:
(default: "disable")
-mc, --misprintCoefficient [number]
Coefficient for misprint option can be from 0 to 1.0.
(default: "0.9")
-c, --config [path]
Path to the config file.
-V, --version output the version number
-h, --help output usage information
Examples:
$ npx ngx-translate-lint -p ./src/app/**/*.{html,ts} -l ./src/assets/i18n/*.json
$ ngx-translate-lint -p ./src/app/**/*.{html,ts} -l ./src/assets/i18n/*.json
$ ngx-translate-lint -p ./src/app/**/*.{html,ts} -z disable -v error
```
> NOTE: For `project` and `languages` options need to include file types like on the example.
Default Config is:
```json
{
"rules": {
"keysOnViews": "error",
"zombieKeys": "warning",
"misprintKeys": "disable",
"deepSearch": "disable",
"emptyKeys": "warning",
"maxWarning": "0",
"misprintCoefficient": "0.9",
"ignoredKeys": [ "IGNORED.KEY.(.*)" ], // can be string or RegExp
"ignoredMisprintKeys": [],
"customRegExpToFindKeys": [ "(?<=marker\\(['\"])([A-Za-z0-9_\\-.]+)(?=['\"]\\))"], // to find: marker('TRSNLATE.KEY');
},
"project": "./src/app/**/*.{html,ts}",
"languages": "./src/assets/i18n/*.json"
}
```
#### How to write Custom RegExp
We have `(?<=marker\\(['\"])([A-Za-z0-9_\\-.]+)(?=['\"]\\))` RegExp witch contains of 3 parts:
- Prefix - `(?<=marker\\(['\"])`
- This construction tells that what we need matching before translate key
- start with `(?<=` and end `)`.
- `marker\\(['\"]` - tells that we try to find word `market` witch have on the second character `'`or `"`
- To summarize, we are trying to find keys before each word to be `market` and commas `'` or `"`
- Matching for key: `([A-Za-z0-9_\\-.]+)`
- This construction tells that we find and save all words which contain alphabet, numbers, and `_` or `-`.
- We recommend using this part of RegExp to find and save translated keys
- But you can also use `(.*)` If it's enough for your project
- Postfix - `(?=['\"]\\))` (the same as prefix, but need to be ended)
- This construction tells that what we need matching after translate key
- start with `(?=` and end `)`
- `['\"]\\)` - tells that we try to find word comas `'` or `"` and ended with `)`
- To summarize, we are trying to find keys ended each word to be commas `'` or `"` and `)`
Example RegExp will find following keys
- `marker('TRSNLATE.KEY')`
- `marker("TRSNLATE.KEY-2")`
#### Exit Codes
The CLI process may exit with the following codes:
- `0`: Linting succeeded without errors (warnings may have occurred)
- `1`: Linting failed with one or more rule violations with severity error
- `2`: An invalid command line argument or combination thereof was used
### TypeScript
```typescript
import { ToggleRule, NgxTranslateLint, IRulesConfig, ResultCliModel, ErrorTypes, LanguagesModel } from 'ngx-translate-lint';
const viewsPath: string = './src/app/**/*.{html,ts}';
const languagesPath: string = './src/assets/i18n/*.json';
const ignoredLanguagesPath: string = "./src/assets/i18n/ru.json, ./src/assets/i18n/ru-RU.json";
const ruleConfig: IRulesConfig = {
keysOnViews: ErrorTypes.error,
zombieKeys: ErrorTypes.warning,
misprintKeys: ErrorTypes.disable,
deepSearch: ToggleRule.disable,
emptyKeys: ErrorTypes.warning,
maxWarning: 0,
misprintCoefficient: 0.9,
ignoredKeys: [ 'EXAMPLE.KEY', 'IGNORED.KEY.(.*)' ], // can be string or RegExp
ignoredMisprintKeys: [],
customRegExpToFindKeys: [ "(?<=marker\\(['\"])([A-Za-z0-9_\\-.]+)(?=['\"]\\))" ] // to find: marker('TRSNLATE.KEY');
};
const ngxTranslateLint = new NgxTranslateLint(viewsPath, languagesPath, ignoredLanguagesPath, ruleConfig)
const resultLint: ResultCliModel = ngxTranslateLint.lint(); // Run Lint
const languages: LanguagesModel[] = ngxTranslateLint.getLanguages() // Get Languages with all keys and views
```
#### NOTE!
If you have error `Can't resolve 'fs' in ...`. Please add next setting to you project:
- webpack.js: (`angular.webpack.json`)
```javascript
config.externals = {
...config.externals,
"fs": 'require("fs")',
"path": 'require("path")'
};
```
- tsconfig.json
```json
{
"skipLibCheck": true
}
```
## Contribute
You may contribute in several ways like requesting new features,
adding tests, fixing bugs, improving documentation or examples.
Please check our [contributing guidelines][contributing].
## Used By
Here can be your extensions:
- [ngx-translate-editor](https://github.com/svoboda-rabstvo/ngx-translate-editor) - Simple GUI for CRUD translate keys of ngx-translate, which included ngx-translate-lint
- [121 Platform](https://github.com/global-121/121-platform) - 121 is an open source platform for Cash based Aid built with Digital Identity & Local/Global Financial service partners.
## License
[MIT][license-url]
[ngx-translate]: https://github.com/ngx-translate/core
[travis-shield]: https://img.shields.io/travis/svoboda-rabstvo/ngx-translate-lint/master.svg
[travis-url]: https://travis-ci.com/svoboda-rabstvo/ngx-translate-lint/branches
[semantic-shield]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[npm-shield]: https://img.shields.io/npm/v/svoboda-rabstvo/ngx-translate-lint.svg
[npm-url]: https://www.npmjs.com/package/ngx-translate-lint
[npm]: https://www.npmjs.com
[node-js]: https://nodejs.org
[github-shield]: https://img.shields.io/github/release/svoboda-rabstvo/ngx-translate-lint.svg?label=github
[github-url]: https://github.com/svoboda-rabstvo/ngx-translate-lint
[github-release-url]: https://github.com/svoboda-rabstvo/ngx-translate-lint/releases
[github-pages-url]: https://svoboda-rabstvo.github.io/ngx-translate-lint/
[schema-url]: http://json-schema.org/
[web-url]: https://schema.linterhub.com
[doc-url]: https://github.com/svoboda-rabstvo/ngx-translate-lint/blob/develop/doc
[license-url]: https://github.com/svoboda-rabstvo/ngx-translate-lint/blob/develop/LICENSE.md
[meta-url]: https://en.wikipedia.org/wiki/List_of_software_package_management_systems#Meta_package_managers
[contributing]: https://github.com/svoboda-rabstvo/ngx-translate-lint/blob/develop/.github/CONTRIBUTING.md