# mpx/valid-wx-key

强制执行有效的 wx:key 指令

⚙️ 这条规则包含在"plugin:mpx/mpx-essential"。

此规则检查每个 wx:key 指令是否有效。

# 📖 规则详情

根据wx:key规则 (opens new window)来保障key值有效性，限制使用静态字面量作为key值，且默认不允许使用如"index"、"this"等易混淆的保留关键字。

如果确定循环中存在item.index/item.this等保留关键字作为唯一key，可手动忽略报错。

<template>
  <!-- ✓ GOOD -->
  <view wx:for="{{list}}" wx:key="id"/>
  <view wx:for="{{list}}" wx:key="1"/>

  <!-- ✓ 不会报错，但不建议 -->
  <view wx:for="{{list}}" wx:key="*this"/>

  <!-- ✗ BAD -->
  <view wx:for="{{list}}"/>
  <view wx:for="{{list}}" wx:key="{{id}}"/>
  <view wx:for="{{list}}" wx:key="aaa.id"/>
  <view wx:for="{{list}}" wx:key="id_{{index}}"/>
  <view wx:for="{{list}}" wx:key:aaa="id"/>
  <view wx:for="{{list}}" wx:key=""/>
  <view wx:for="{{list}}"/>
  <view wx:key="id"/>
  <view wx:for="{{list}}" wx:key="index"/>
  <view wx:for="{{list}}" wx:key="this"/>
</template>

Now loading...

# 🔧 选项

可配置keywords选项,自定义禁止使用保留的关键字,默认为"index"、"this"

{
  "mpx/valid-wx-key": ["error", {
    "keywords": ["index", "this", "*this"] 
  }]
}

# 🔍 具体实现

← mpx/valid-wx-if mpx/valid-wx-model →