eslint-plugin-sme

0.0.3 • Public • Published

eslint-plugin-sme

  • sme/no-iconfont 禁止使用 iconfont 的图标格式

安装

  1. 安装 eslint:
npm i eslint --save-dev
  1. 安装 eslint-plugin-sme:
npm install eslint-plugin-sme --save-dev

使用

sme添加到.eslintrc配置文件的extends部分:

{
  "extends": ["plugin:sme/recommended"]
}

插件中的默认的推荐配置

"recommended": {
    "plugins": ["sme"],
    "parserOptions": {
      "ecmaFeatures": {
        "jsx": true,
      },
    },
    "rules": {
      "sme/no-iconfont": "error",
    },
  }

然后在规则部分下配置您想要使用的规则。

参数 说明 默认值
fontFamily 检测已使用字体的className(fontFamily)匹配 iconfont
componentName 工程中自定义的icon组件的名称 Icon
pathPrefix 自动修复时导入的import路径的前缀(文件路径) src/icon
fixImportFileName 自动修复时的自定义文件名 index.js
customFullImportPath 自定义import的导入的路径,例如使用了alias后直接使用import Icon from '@/icon' ''

简洁配置:

{
    "rules": {
        "sme/rule-name": 2
    }
}

自定义配置:

{
    "rules": {
        "sme/rule-name": [2, {
          "fontFamily": "ide-confont",
          "componentName": "selfIcon",
          "pathPrefix": "src/component/icon",
          "fixImportFileName": "index.js",
          "customFullImportPath": "@/icon",
        }]
    }
}

Package Sidebar

Install

npm i eslint-plugin-sme

Weekly Downloads

1

Version

0.0.3

License

ISC

Unpacked Size

11.6 kB

Total Files

7

Last publish

Collaborators

  • tony0712