eslint-plugin-i18n-json 使用教程

2024-09-01 11:45:40作者：咎岭娴Homer

1. 项目的目录结构及介绍

eslint-plugin-i18n-json/
├── src/
│   └── 各种源代码文件
├── index.js
├── formatter.js
├── package.json
├── eslintrc.json
└── 其他辅助文件和目录

src/: 包含项目的核心源代码文件。
index.js: 项目的入口文件。
formatter.js: 用于格式化的辅助文件。
package.json: 项目的配置文件，包含依赖、脚本等信息。
eslintrc.json: ESLint 的配置文件。

2. 项目的启动文件介绍

index.js 是项目的启动文件，负责初始化和配置 ESLint 插件。以下是 index.js 的基本结构：

// index.js 文件内容概览
module.exports = {
  configs: {
    recommended: {
      plugins: ['i18n-json'],
      rules: {
        'i18n-json/valid-json': 2,
        'i18n-json/valid-message-syntax': 2,
        'i18n-json/sorted-keys': 2,
        'i18n-json/identical-keys': 2
      }
    }
  },
  rules: {
    'valid-json': require('./src/rules/valid-json'),
    'valid-message-syntax': require('./src/rules/valid-message-syntax'),
    'sorted-keys': require('./src/rules/sorted-keys'),
    'identical-keys': require('./src/rules/identical-keys')
  }
};

3. 项目的配置文件介绍

`package.json`

package.json 文件包含了项目的元数据和依赖信息。以下是 package.json 的主要内容：

{
  "name": "eslint-plugin-i18n-json",
  "version": "4.0.0",
  "description": "Fully extendable eslint plugin for JSON i18n translation files",
  "main": "index.js",
  "scripts": {
    "lint": "eslint index.js formatter.js src/ --fix",
    "test": "npm run lint && jest --coverage"
  },
  "files": [
    "src",
    "index.js",
    "formatter.js"
  ],
  "repository": {
    "type": "git",
    "url": "git@github.com:godaddy/eslint-plugin-i18n-json.git"
  },
  "keywords": [
    "eslint",
    "json",
    "i18n",
    "translations",
    "internationalization",
    "intl",
    "linter"
  ],
  "author": "GoDaddy Operating Company LLC",
  "license": "MIT",
  "engines": {
    "node": ">=6.0.0"
  },
  "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": "^23.0.4",
    "strip-ansi": "^4.0.0"
  },
  "dependencies": {
    "@formatjs/icu-messageformat-parser": "^2.0.18",
    "chalk": "^2.3.2",
    "indent-string": "^3.2.0",
    "jest-diff": "^22.0.3",
    "lodash.get": "^4.4.2",
    "lodash.isequal": "^4.5.0",
    "lodash.isplainobject": "^4.0.6",
    "lodash.set": "^4.3.2",
    "log-symbols": "^2.2.0",
    "parse-json": "^5.2.0",
    "plur": "^2.1.2