亮层 UI ESLint 配置

这个软件包包含了用于Typescript和TSX项目的Brightlayer UI ESLint配置. ESLint用于执行跨越Brightlayer UI应用程序的代码质量.

注: Brightlayer UI ESLint 配置包只兼容 TypeScript 项目.

所有执行代码样式的ESLint规则都被禁用,有利于使用更漂亮的代码格式化. 参见 @ brightlayer- ui/ pretier- config 在您的应用程序中加入更漂亮的.

安装

从您的软件包根部安装亮层用户界面配置 :

yarn add --dev @brightlayer-ui/eslint-config

您还需要安装以下对等依赖 :

yarn add --dev eslint eslint-config-prettier @typescript-eslint/eslint-plugin @typescript-eslint/parser

如果您的工程正在使用 TSX 文件扩展名 React, 您还需要安装 :

yarn add --dev eslint-plugin-react

配置

添加 Linting 脚本

将以下脚本添加到您的 package.json。 。 。 .

"scripts": {
    "lint": "eslint \"src/**/**.ts\"",
    "lint:fix": "eslint \"src/**/**.ts\" --fix",
}

TSX项目: 确定将.tsx文件扩展名包含在您提示的命令中(例如. eslint '**/**.{tsx,ts}'(中文(简体) )

这个 --fix 旗帜将自动尝试修正报告的错误。 如果不这样做,将报告错误/警告,而不试图纠正错误/警告.

导入 Linting 配置

Blightlayer UI配置需要导入到ESLint. 添加以下内容: .eslintrc.js 到您的项目根部.

module.exports =  {
    parser:  '@typescript-eslint/parser',
    extends:  [ '@brightlayer-ui/eslint-config/ts' ],
    parserOptions:  {
        project: "./tsconfig.json",
    },
    env: {
        browser: true
    }
};

TSX项目: 从 @brightlayer-ui/eslint-config/tsx。 。 。 .

使用量

要在您的工程中插入所有打字符文件, 请运行 yarn lint。 。 。 .

要自动修正您工程中嵌入错误, 请运行 yarn lint:fix 或者说 yarn lint --fix。 。 。 .