# wxml/forbid-tags

# Background

Forbid Tags

This rule checks all wxml tags and verifies that no forbidden tags are used. This rule is off by default. If on, no tags are forbidden by default. same with eslint-plugin-react's forbid-elements (opens new window) rule, but for wxml.

# Motivation

You may want to forbid usage of certain tags in favor of others, (e.g. forbid all <div /> and use <view /> instead). This rule allows you to configure a list of forbidden tags and to specify their desired replacements.

// following code use this config
{
  "wxml/forbid-tags": [
    "error",
    {
      "forbid":
      [
        "div",
        "span",
        {
          "tag": "p",
          "message": "please use <text />"
        }
      ]
    }
  ]
}

<!-- ✓ GOOD -->
<view />text</view>
<view /><sub /></view>

<!-- ✗ BAD -->
<div>{{name}}</div>
<span>{{title}}</span>
<!-- hint use <text />  -->
<p>{{title}}</p>

Now loading...

// following code use this config
{
  "wxml/forbid-tags": [
    "error",
    {
      "forbid":
      [
        {
          "tag": "view",
          "message": "If you need use hover-class you should use <view /> otherwise use <v />",
          "skipAttrs": ["hover-class"]
        }
      ]
    }
  ]
}

<!-- ✓ GOOD -->
<view hover-class='button'>text</view>

<!-- ✗ BAD -->
<view class='button'>text</view>

Now loading...

// following code use this config
{
  "wxml/forbid-tags": [
    "error",
    {
      "forbid":
      [
        {
          "tag": "v",
          "message": "If you need use hover-class you should use <view /> otherwise use <v />",
          "disableAttrs": ["hover-class"]
        }
      ]
    }
  ]
}

<!-- ✓ GOOD -->
<v class='button' />
<v class='button' />text</v>

<!-- ✗ BAD -->
<v hover-class='button' />
<v hover-class='button'>text</v>

Now loading...

💡 tips

You can edit code via online editor, it's online REPL, try to fix eslint problem !

# History

Version	Changes
v0.7.5	Add `disableAttrs` and `skipAttrs` config support

# Config

"wxml/forbid-tags": [<enabled>, { "forbid": [<string|{ tag: string, message?: string, disableAttrs?: string[], skipAttrs?: string[] }>] }]

# Version

This rule was introduced in eslint-plugin-wxml v0.2.1

# Implementation

← wxml/forbid-attributes wxml/max-depth →