Naver ESLint 配置项目教程

Naver ESLint 配置项目教程

eslint-config-naverNaver JavaScript Coding Conventions rules for eslint项目地址:https://gitcode.com/gh_mirrors/es/eslint-config-naver

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

eslint-config-naver/
├── LICENSE
├── README.md
├── STYLE_GUIDE.md
├── es5.js
├── index.js
├── package-lock.json
└── package.json

• LICENSE: 项目的许可证文件，遵循 MIT 许可证。
• README.md: 项目的基本介绍和使用说明。
• STYLE_GUIDE.md: 项目的编码风格指南。
• es5.js: 针对 ES5 的 ESLint 配置文件。
• index.js: 针对 ES6+ 的 ESLint 配置文件。
• package-lock.json: 锁定依赖版本的文件。
• package.json: 项目的依赖和脚本配置文件。

2. 项目的启动文件介绍

项目的主要启动文件是 index.js 和 es5.js，分别用于 ES6+ 和 ES5 的 ESLint 配置。

index.js

// 针对 ES6+ 的 ESLint 配置
module.exports = {
  extends: [
    'eslint-config-airbnb-base',
    './rules/best-practices',
    './rules/errors',
    './rules/node',
    './rules/style',
    './rules/variables',
    './rules/es6',
    './rules/imports',
  ].map(require.resolve),
  parserOptions: {
    ecmaVersion: 2018,
    sourceType: 'module',
  },
  rules: {
    strict: 'error',
  },
};

es5.js

// 针对 ES5 的 ESLint 配置
module.exports = {
  extends: [
    'eslint-config-airbnb-base/legacy',
    './rules/best-practices',
    './rules/errors',
    './rules/node',
    './rules/style',
    './rules/variables',
  ].map(require.resolve),
  parserOptions: {
    ecmaVersion: 5,
    sourceType: 'script',
  },
  rules: {
    strict: 'error',
  },
};

3. 项目的配置文件介绍

package.json

{
  "name": "eslint-config-naver",
  "version": "1.0.0",
  "description": "Naver JavaScript Coding Conventions rules for eslint",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/naver/eslint-config-naver.git"
  },
  "keywords": [
    "eslint",
    "eslintconfig",
    "naver",
    "javascript",
    "coding",
    "conventions"
  ],
  "author": "NAVER Corp.",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/naver/eslint-config-naver/issues"
  },
  "homepage": "https://github.com/naver/eslint-config-naver#readme",
  "peerDependencies": {
    "eslint": "^4.19.1 || ^5.3.0",
    "eslint-plugin-import": "^2.14.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 主入口文件。
• scripts: 可执行的脚本命令。
• repository: 项目仓库地址。
• keywords: 项目关键词。
• author: 项目作者。
• license: 项目许可证。
• bugs: 问题跟踪地址。
• homepage: 项目主页。
• peerDependencies: 项目依赖的其他库。

以上是 Naver ESLint 配置项目的详细教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

eslint-config-naverNaver JavaScript Coding Conventions rules for eslint项目地址:https://gitcode.com/gh_mirrors/es/eslint-config-naver