ecomfe / eslint-plugin-san Goto Github PK

View Code? Open in Web Editor NEW

0.0 15.0 6.0 5.99 MB

Home Page: https://ecomfe.github.io/eslint-plugin-san

License: Other

JavaScript 96.73% TypeScript 3.27%

eslint eslint-plugin san sanjs

eslint-plugin-san's Introduction

eslint-plugin-san

Official ESLint plugin for San. Inspired by eslint-plugin-vue

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-san:

$ npm install eslint-plugin-san --save-dev

Usage

Add san to the plugins section of your .eslintrc configuration file.

{
    "extends": ["plugin:san/essential"],
    "parserOptions": {
        "parser": "babel-eslint"
    }
}

Then configure the rules you want to use under the rules section.

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

Supported on `VS Code`

On VS Code using ESlint extension to support. By default, Eslint extension is NOT support San, you shoud config eslint.validate option like this in settings.json:

{
    "eslint.validate": [
        "san"
    ]
}

Supported Rules

Fill in provided rules here

eslint-plugin-san's People

Contributors

Watchers

Forkers

kidnes glen1021 merlin-liu buptlhuanyu jinjingxuan

eslint-plugin-san's Issues

注意：双向绑定仅支持普通变量和属性访问表达式

https://baidu.github.io/san/tutorial/template/#%E8%A1%A8%E8%BE%BE%E5%BC%8F

使用san.defineComponent定义的组件，lint报错

Bug: san/html-quotes 规则自动修复后出现HTML实体编码

规则文档地址：
https://ecomfe.github.io/eslint-plugin-san/rules/html-quotes.html

项目中问题 case 如截图所示：

期望的结果：

文档代码预览中也可复现：

注意： get 方法获取的数据不能直接修改，否则可能导致不一致的问题。数据修改请使用本文下面的 set 、 splice 等方法

https://baidu.github.io/san/tutorial/data-method/#get

Feature Request: 提议升级 @typescript-eslint/parser 依赖版本 v5+

在 eslint-plugin-san 工程尝试升级 @typescript-eslint/parser 到 5.8.1 版本后，测试用例不通过

对比 eslint-plugin-vue 已经将升级了对应依赖的版本。
实际项目中，也期望升级对应依赖的版本，结果是升级该依赖项之后 eslint-plugin-san 就失效了，与预期不符。

template 中 s-for 中包含 index时会解析报错

san-ssr 模板中不支持类型转换

下面语法在 ssr 中是不允许的：

<custom-copm prop="{{+a}}" />

注意：过滤器仅在插值替换时支持

https://baidu.github.io/san/tutorial/template/#%E6%95%B0%E6%8D%AE%E7%9A%84%E8%A7%86%E5%9B%BE%E5%8F%98%E6%8D%A2

Feature Request: 提议san/order-in-components规则对自定义成员方法进行排序检测

在该 san/order-in-components 规则下，san 组件中自定义的成员方法在 checkOrder 的排序检测方法中没有相应的处理。
在默认配置下，如有下列属性，排序检测是符合预期的：
['template', 'initData', 'attached']

但是，当为 san 组件自定义了成员方法，由于 getOrderPosition 方法在 orderMap 中没有记录或配置，那么就不会被正确检测。比如['template', 'customMethod1', 'customMethod2', 'initData', 'attached']，示例：

主要代码逻辑：
https://github.com/ecomfe/eslint-plugin-san/blob/main/lib/rules/order-in-components.js#L51
https://github.com/ecomfe/eslint-plugin-san/blob/main/lib/rules/order-in-components.js#L221

期望的结果是，开发者自定义的成员方法，应该独立形成一个 group，在定义的 order 指定位置处参与排序检测，group 内部可以支持 alpabeta 排序，类似san/attributes-order规则。

提议配置规则添加 CUSTOM_METHODS，指代自定义的成员方法，示例：

{
  "san/order-in-components": ["error", {
    "order": [
      // 视图
      "template",
      "components",
      "trimWhitespace",

      // 事件
      "messages",

      // 数据
      "dataTypes",
      "computed",
      "filters",
      "initData",

      // 生命周期
      "LIFECYCLE_HOOKS",

      // 自定义的成员方法
      "CUSTOM_METHODS"
    ]
  }]
}