New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

eslint-plugin-i18n-json

Package Overview
Dependencies
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

eslint-plugin-i18n-json - npm Package Compare versions

Comparing version

0.0.1-security
to
2.0.0

index.js
LICENSE
src/__snapshots__/identical-keys.test.js.snap
src/__snapshots__/valid-message-syntax.test.js.snap
src/identical-keys.js
src/identical-keys.test.js
src/message-validators/icu.js
src/message-validators/is-string.js
src/message-validators/not-empty.js
src/sort-translations.js
src/sort-translations.test.js
src/util/compare-translations-structure.js
src/util/deep-for-own.js
src/util/deep-for-own.test.js
src/valid-json.js
src/valid-json.test.js
src/valid-message-syntax.js
src/valid-message-syntax.test.js

63

package.json
{
"name": "eslint-plugin-i18n-json",
"version": "0.0.1-security",
"description": "security holding package",
"repository": "npm/security-holder",
"dependencies": {}
"version": "2.0.0",
"description": "Fully extendable eslint plugin for JSON i18n translation files.",
"main": "index.js",
"scripts": {
"lint": "eslint index.js src/ --fix",
"test": "jest --coverage"
},
"files": [
"src",
"README.md",
"index.js"
],
"repository": {
"type": "git",
"url": "git@github.com:godaddy/eslint-plugin-i18n-json"
},
"keywords": [
"eslint",
"json",
"i18n",
"translations",
"internationalization",
"intl",
"linter"
],
"author": "GoDaddy Operating Company, LLC",
"contributors": [
"Mayank Jethva <mjethva@godaddy.com>"
],
"jest": {
"roots": [
"src/"
],
"collectCoverageFrom": [
"src/**/*.js"
]
},
"license": "MIT",
"peerDependencies": {
"eslint": ">=4.0.0"
},
"devDependencies": {
"eslint": "^4.15.0",
"eslint-config-airbnb-base": "^12.1.0",
"eslint-plugin-import": "^2.8.0",
"espree": "^3.5.2",
"jest": "^22.0.4",
"strip-ansi": "^4.0.0"
},
"dependencies": {
"intl-messageformat-parser": "^1.4.0",
"jest-diff": "^22.0.3",
"jsonlint": "^1.6.2",
"lodash.get": "^4.4.2",
"lodash.isequal": "^4.5.0",
"lodash.isplainobject": "^4.0.6",
"lodash.set": "^4.3.2",
"pretty-format": "^22.0.3"
}
}

250

README.md

@@ -1,9 +0,245 @@

# Security holding package
# eslint-plugin-i18n-json
This package name is not currently in use, but was formerly occupied
by another package. To avoid malicious use, npm is hanging on to the
package name, but loosely, and we'll probably give it to you if you
want it.
> Fully extendable eslint plugin for JSON i18n translation files.
You may adopt this package by contacting support@npmjs.com and
requesting the name.
![](assets/logo.png)
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Examples](#examples)
- [Rules](#example)
- [i18n-json/valid-json](#i18n-jsonvalid-json)
- [i18n-json/valid-message-syntax](#i18n-jsonvalid-message-syntax)
- [i18n-json/identical-keys](#i18n-jsonidentical-keys)
- [Special Thanks](#special-thanks)
- [License](#license)
## Features
- lint JSON translation files
- rule: `i18n-json/valid-json`
- configure a custom linter in case the default doesn't fit your needs.
- validate syntax per message
- rule: `i18n-json/valid-message-syntax`
- default syntax check is for ICU Message Syntax
- can support any message syntax through custom validators. (link to customer message validator example)
- ensure translation files have identical keys
- `i18n-json/identical-keys`
- supports different custom mappings and on the fly key structure generation
- sort translation keys in ascending order through eslint auto-fix
- supports **any level of nesting** in the translation file. (escapes `.` in key names)
**Note: Check out the [Examples](examples/) folder to see different use cases and project setups.
Requires eslint 4.0+**
## Getting Started
Right out of the box you get the following through our recommended ruleset `i18n-json/recommended`:
- i18n-json/valid-json
- linting of each JSON translation file
- default severity: error | 2
- i18n-json/valid-message-syntax
- default ICU Message syntax validation (using `intl-messageformat-parser`)
- default severity: error | 2
- automatic ascending sort of all keys in the translation file. (supports sorting nested objects)
Let's say your translations project directory looks like the following, (project name: simple)
```
> tree simple -I node_modules
simple
├── package.json
├── readme.md
└── translations
├── en-US
│   └── index.json
└── es-MX
└── index.json
```
**In this project directory, do the following:**
1) >npm install --save-dev eslint-plugin-i18n-json
2) Create a `.eslintrc.js` file in the root dir of your project.
3) paste in the following:
```javascript
{
"extends": [
"plugin:i18n-json/recommended"
],
}
```
4) add this npm script to your `package.json` file.
- **note: without the `--fix` option, sorting the translation file won't work**
```JSON
{
"scripts": {
"lint": "eslint --fix --ext .json translations"
}
}
```
5) >npm run lint
6) **Profit!** Relax knowing that each change to the translations project will go through strict checks by eslint plugin.
*Example where we have invalid ICU message syntax.*
**(ascii cinema link)**
<a align="center" href="https://asciinema.org/a/jIu2dJVuVucawqaFmgjuSUPg0" target="_blank"><img src="https://asciinema.org/a/jIu2dJVuVucawqaFmgjuSUPg0.png" /></a>
## Examples
Check out the [Examples](examples/) folder to see different use cases.
## Configuring the rules
- Simply update your `.eslintrc.*` with overrides for the individual rules.
- Eslint severities: 2 = error, 1 = warning, 0 = off
## Rules
### i18n-json/valid-json
- linting of each JSON translation file
- builtin linter uses `json-lint`
- default severity: error | 2
- **options**
- `linter`: String (Optional)
- Absolute path to a module which exports a JSON linting function.
- `Function(source: String)`
- This function will be passed the source of the current file being processed.
- It **should throw an Error**, just like `JSON.parse`.
```javascript
// .eslintrc.js
rules: {
"i18n-json/valid-json": [2, {
linter: path.resolve('path/to/custom-linter.js')
}]
}
```
```javascript
//custom-linter.js
module.exports = (source) => {
if(isBad(source)){
throw new SyntaxError('invalid syntax');
}
}
```
### i18n-json/valid-message-syntax
- default ICU Message syntax validation (using `intl-messageformat-parser`)
- default severity: error | 2
- **options**
- `syntax`: String (Optional). Default value: `icu`.
- **Can be a built in validator: `icu`, `non-empty-string`.**
```javascript
// .eslintrc.js
rules: {
"i18n-json/valid-message-syntax": [2, {
syntax: 'non-empty-string'
}]
}
```
- **Can be an absolute path to a module which exports a Syntax Validator Function.**
- `Function(message: String, key: String)`
- This function will be invoked with each `message` and its corresponding `key`
- It **should throw an Error**, just like `JSON.parse` on invalid syntax.
```javascript
// .eslintrc.js
rules: {
"i18n-json/valid-message-syntax": [2, {
syntax: path.resolve('path/to/custom-syntax-validator.js')
}]
}
```
```javascript
//custom-syntax-validator.js example
module.exports = (message, key) => {
// each message should be in all caps.
if(message.toLowercase() !== message.toUppercase()){
throw new SyntaxError('MESSAGE MUST BE IN ALL CAPS!')
}
}
```
- Output from the `custom-message-syntax` example where each message must have the word 'PIZZA' prepended to it.
**(ascii cinema link)**
<a href="https://asciinema.org/a/J7dGuSfQ2yoyUHfS95EFcInfU" target="_blank"><img src="https://asciinema.org/a/J7dGuSfQ2yoyUHfS95EFcInfU.png" /></a>
### i18n-json/identical-keys
- compare each translation file's key structure with a reference translation file to ensure consistency
- severity: 0 | off , this rule is OFF by default
- Can turn this rule on by specifying options for it through your `.eslintrc.*` file.
- **options**
- `filePath` : String | Object (Required)
- **Can be an absolute path to the reference translation file.**
```javascript
// .eslintrc.js
rules: {
"i18n-json/identical-keys": [2, {
filePath: path.resolve('path/to/locale/en-US.json')
}]
}
```
- **Can be an Object which contains a Mapping for how to choose a reference translation file. (chosen by suffix match)**
```javascript
// .eslintrc.js
rules: {
"i18n-json/identical-keys": [2, {
filePath: {
'login.json': path.resolve('./translations/en-US/login.json'),
'search-results.json': path.resolve('./translations/en-US/search-results.json'),
'todos.json': path.resolve('./translations/en-US/todos.json')
}
}]
}
```
- values in the path must be the absolute file path to the reference translation file.
- the plugin will do a **suffix** match on the current file's path to determine which reference translation file to choose.
- **Can be an absolute path to an exported function which generates the reference key structure on the fly.** The function will be passed the parsed JSON translations object and absolute path of the current file being processed.
- `Function(translations: Object, currentFileAbsolutePath: String) : Object`
```javascript
// .eslintrc.js
rules: {
"i18n-json/identical-keys": [2, {
filePath: path.resolve('path/to/key-structure-generator.js')
}]
}
```
```javascript
// key-structure-generator.js example
module.exports = (translations, currentFileAbsolutePath) => {
// identity key structure generator
return translations;
};
```
- Output from the `multiple-files-per-locale` example where we removed/added some keys at `es-MX/login.json` which should have the same key structure as `en-US/login.json`.
**(ascii cinema link)**
<a href="https://asciinema.org/a/upyyqbbz2eRT1knDCLcBVMeZv" target="_blank"><img src="https://asciinema.org/a/upyyqbbz2eRT1knDCLcBVMeZv.png" /></a>
## Special Thanks
- Jest platform packages
- intl-messageformat-parser
- iconmonstr for the globe icon: https://iconmonstr.com/language-11-svg
## License
MIT