ESLint 插件 `eslint-plugin-import-access` 使用教程

ESLint 插件 eslint-plugin-import-access 使用教程

eslint-plugin-import-access项目地址:https://gitcode.com/gh_mirrors/es/eslint-plugin-import-access

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

eslint-plugin-import-access 是一个用于控制 TypeScript 项目中导入访问权限的 ESLint 插件。以下是该项目的目录结构及其介绍：

eslint-plugin-import-access/
├── docs/
│   └── rule-jsdoc.md
├── src/
│   ├── rules/
│   │   └── jsdoc.ts
│   └── index.ts
├── tests/
│   └── lib/
│       └── rules/
│           └── jsdoc.test.ts
├── .eslintrc.js
├── package.json
├── README.md
└── tsconfig.json

• docs/: 包含插件的文档，特别是关于 jsdoc 规则的详细说明。
• src/: 插件的主要源代码目录。
  • rules/: 包含具体的 ESLint 规则实现。
  • index.ts: 插件的入口文件。
• tests/: 包含插件的测试代码。
  • lib/: 测试代码的主要目录。
  • rules/: 包含具体的规则测试。
• .eslintrc.js: 项目的 ESLint 配置文件。
• package.json: 项目的 npm 配置文件，包含依赖和脚本。
• README.md: 项目的介绍和使用说明。
• tsconfig.json: TypeScript 的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，它是插件的入口点。该文件导入了插件的所有规则，并将其注册到 ESLint 中。以下是 src/index.ts 的简要内容：

import { rules } from './rules';

export = {
  rules,
  configs: {
    recommended: {
      plugins: ['import-access'],
      rules: {
        'import-access/jsdoc': 'error',
      },
    },
  },
};

3. 项目的配置文件介绍

.eslintrc.js

.eslintrc.js 是 ESLint 的配置文件，用于配置 ESLint 的行为。以下是该文件的内容：

module.exports = {
  parser: '@typescript-eslint/parser',
  parserOptions: {
    project: true,
    sourceType: 'module',
  },
  plugins: [
    'import-access',
  ],
  rules: {
    'import-access/jsdoc': 'error',
  },
};

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，用于配置 TypeScript 编译器的行为。以下是该文件的内容：

{
  "compilerOptions": {
    "target": "ES2018",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "outDir": "./dist",
    "declaration": true
  },
  "include": [
    "src/**/*"
  ]
}

以上是 eslint-plugin-import-access 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该插件。

eslint-plugin-import-access项目地址:https://gitcode.com/gh_mirrors/es/eslint-plugin-import-access