@croct/eslint-plugin

JavaScript 编码标准
一组 ESLint 语录 规则适用于所有 Croct JavaScript 项目.

* 释放 • 妇女 QQ 报告错误 • 妇女 请求特性

安装

建议安装软件包的方式是通过 国家预防机制它与模块捆绑器,例如 网页包或浏览器:

npm i -D @croct/eslint-plugin

此插件使用 ESLint 的 平面配置格式 (ESLint v9+) (英语).

Java 脚本

对于 JavaScript 工程, 创建 eslint.config.mjs 文件 :

import { defineConfig } from 'eslint/config';
import croct from '@croct/eslint-plugin';

export default defineConfig(
    croct.configs.javascript,
);

类型脚本

对于类型脚本项目,创建 eslint.config.mjs 文件 :

import { defineConfig } from 'eslint/config';
import croct from '@croct/eslint-plugin';

export default defineConfig(
    croct.configs.typescript,
);

TypeScript配置包括了JavaScript预设,因此没有必要同时包含两者.

反应

对于反应项目,创建 eslint.config.mjs 文件 :

import { defineConfig } from 'eslint/config';
import croct from '@croct/eslint-plugin';

export default defineConfig(
    croct.configs.react,
);

React配置包括了JavaScript预设,因此没有必要包含两者.

齐压

对于 Cypress 工程,创建 eslint.config.mjs 文件 :

import { defineConfig } from 'eslint/config';
import croct from '@croct/eslint-plugin';

export default defineConfig(
    croct.configs.cypress,
);

Cypress配置包括了JavaScript预设,因此没有必要包含两者.

自定义规则

您可以添加自定义规则或覆盖已有的规则 :

import { defineConfig } from 'eslint/config';
import croct from '@croct/eslint-plugin';

export default defineConfig(
    croct.configs.typescript,
    {
        files: ['src/**/*.ts'],
        rules: {
            '@typescript-eslint/explicit-function-return-type': 'off',
        },
    },
);

关于现有预设和规则的清单,见 参考文件。 。 。 .

基本用途

运行以下命令以检查工程是否符合编码标准:

eslint

捐款

对一揽子计划的贡献总是受到欢迎的!

• 报告任何错误或问题 问题跟踪器。 。 。 .
• 重大改动,请 打开一个问题 首先讨论你想要改变什么.
• 请确保酌情更新测试.

测试

在运行测试套件之前,开发依赖必须安装:

npm i

然后,运行所有测试:

npm run test

版权通知

版权:"2015-2021 Croct Limited","All Rights"保留地.

本文所载的所有资料均为并仍然是克罗克有限公司的财产。 本文所载的知识、设计和技术概念是Croct Limiteds专有的,可能由美国和外国专利、正在处理的专利所涵盖,并受贸易秘密或版权法的保护。 严格禁止传播这种信息或复制这种材料,除非事先得到克罗克特有限公司的书面许可.