New: Add vue/require-shorthand-boolean-prop rule

Author: inker

docs/rules/README.md

@@ -157,6 +157,7 @@ For example:
 | [vue/no-restricted-syntax](./no-restricted-syntax.md) | disallow specified syntax |  |
 | [vue/object-curly-spacing](./object-curly-spacing.md) | enforce consistent spacing inside braces | :wrench: |
 | [vue/require-direct-export](./require-direct-export.md) | require the component to be directly exported |  |
+| [vue/require-shorthand-boolean-prop](./require-shorthand-boolean-prop.md) | enforce or ban passing `true` value to a prop |  |
 | [vue/script-indent](./script-indent.md) | enforce consistent indentation in `<script>` | :wrench: |
 | [vue/space-infix-ops](./space-infix-ops.md) | require spacing around infix operators | :wrench: |
 | [vue/space-unary-ops](./space-unary-ops.md) | enforce consistent spacing before or after unary operators | :wrench: |

docs/rules/require-shorthand-boolean-prop.md

@@ -0,0 +1,66 @@
+---
+pageClass: rule-details
+sidebarDepth: 0
+title: vue/require-shorthand-boolean-prop
+description: enforce or ban passing `true` value to a prop
+---
+# vue/require-shorthand-boolean-prop
+> enforce or ban passing `true` value to a prop
+
+## :book: Rule Details
+
+This rule aims at enforcing usage of shorthand properties for `true` values in Vue templates.
+
+<eslint-code-block :rules="{'vue/require-shorthand-boolean-prop': ['error']}">
+
+```vue
+<template>
+  <!-- ✓ GOOD -->
+  <component
+    isValid
+  />
+  
+  <!-- ✗ BAD -->
+  <component
+    :isValid="true"
+  />
+</template>
+```
+
+</eslint-code-block>
+
+## :wrench: Options
+
+```json
+{
+  "vue/require-shorthand-boolean-prop": ["error", "always" | "never"]
+}
+```
+- `"always"` (default) ... Always use shorthand prop.
+- `"never"` ... Never use shorthand prop. Instead pass `true` explicitly.
+
+### `"never"`
+
+<eslint-code-block :rules="{'vue/require-shorthand-boolean-prop': ['error', 'never']}">
+
+```vue
+<template>
+  <!-- ✓ GOOD -->
+  <component
+    :isValid="true"
+    isValid
+  />
+  
+  <!-- ✗ BAD -->
+  <component
+    isValid
+  />
+</template>
+```
+
+</eslint-code-block>
+
+## :mag: Implementation
+
+- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/require-shorthand-boolean-prop.js)
+- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/require-shorthand-boolean-prop.js)

lib/index.js

@@ -63,6 +63,7 @@ module.exports = {
     'require-prop-type-constructor': require('./rules/require-prop-type-constructor'),
     'require-prop-types': require('./rules/require-prop-types'),
     'require-render-return': require('./rules/require-render-return'),
+    'require-shorthand-boolean-prop': require('./rules/require-shorthand-boolean-prop'),
     'require-v-for-key': require('./rules/require-v-for-key'),
     'require-valid-default-prop': require('./rules/require-valid-default-prop'),
     'return-in-computed-property': require('./rules/return-in-computed-property'),

lib/rules/require-shorthand-boolean-prop.js

@@ -0,0 +1,61 @@
+/**
+ * @fileoverview Enforces or bans passing `true` value to a prop
+ * @author Anton Veselev
+ */
+'use strict'
+
+const utils = require('../utils')
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'enforce or ban passing `true` value to a prop',
+      categories: ['vue3-uncategorized', 'uncategorized'],
+      recommended: false,
+      url: 'https://eslint.vuejs.org/rules/require-shorthand-boolean-prop.html'
+    },
+    fixable: null,  // or "code" or "whitespace"
+    schema: [
+      {
+        enum: ['always', 'never']
+      }
+    ]
+  },
+
+  create (context) {
+    const isAlways = context.options[0] !== 'never'
+
+    return utils.defineTemplateBodyVisitor(context, {
+      VStartTag (node) {
+        for (const attr of node.attributes) {
+          if (attr.value === null) {
+            if (!isAlways) {
+              context.report({
+                node,
+                loc: node.loc,
+                message: 'Unexpected shorthand prop.'
+              })
+            }
+            continue
+          }
+          const { expression } = attr.value
+          if (expression && expression.value === true) {
+            if (isAlways) {
+              context.report({
+                node,
+                loc: node.loc,
+                message: "Unexpected 'true' value."
+              })
+            }
+            continue
+          }
+        }
+      }
+    })
+  }
+}

tests/lib/rules/require-shorthand-boolean-prop.js

@@ -0,0 +1,157 @@
+/**
+ * @fileoverview Enforces or bans passing `true` value to a prop
+ * @author Anton Veselev
+ */
+'use strict'
+
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+const rule = require('../../../lib/rules/require-shorthand-boolean-prop')
+
+const { RuleTester } = require('eslint')
+
+// ------------------------------------------------------------------------------
+// Tests
+// ------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('vue-eslint-parser'),
+  parserOptions: { ecmaVersion: 2015 }
+})
+
+ruleTester.run('require-shorthand-boolean-prop', rule, {
+
+  valid: [
+    {
+      code: `
+        <template>
+          <component />
+        </template>
+      `
+    },
+    {
+      code: `
+        <template>
+          <component
+            isValid
+          />
+        </template>
+      `
+    },
+    {
+      code: `
+        <template>
+          <component
+            isValid
+          />
+        </template>
+      `,
+      options: ['always']
+    },
+    {
+      code: `
+        <template>
+          <component
+            :isValid="false"
+          />
+        </template>
+      `,
+      options: ['always']
+    },
+    {
+      code: `
+        <template>
+          <component
+            :isValid="true"
+          />
+        </template>
+      `,
+      options: ['never']
+    },
+    {
+      code: `
+        <template>
+          <component
+            :isValid="false"
+          />
+        </template>
+      `,
+      options: ['never']
+    },
+    {
+      code: `
+        <template>
+          <component
+            str="true"
+          />
+        </template>
+      `
+    },
+    {
+      code: `
+        <template>
+          <component
+            str="true"
+          />
+        </template>
+      `,
+      options: ['always']
+    },
+    {
+      code: `
+        <template>
+          <component
+            str="true"
+          />
+        </template>
+      `,
+      options: ['never']
+    }
+  ],
+
+  invalid: [
+    {
+      code: `
+        <template>
+          <component
+            :isValid="true"
+          />
+        </template>
+      `,
+      errors: [{
+        message: "Unexpected 'true' value.",
+        type: 'VStartTag'
+      }]
+    },
+    {
+      code: `
+        <template>
+          <component
+            isValid
+          />
+        </template>
+      `,
+      options: ['never'],
+      errors: [{
+        message: 'Unexpected shorthand prop.',
+        type: 'VStartTag'
+      }]
+    },
+    {
+      code: `
+        <template>
+          <component
+            :isValid="true"
+          />
+        </template>
+      `,
+      options: ['always'],
+      errors: [{
+        message: "Unexpected 'true' value.",
+        type: 'VStartTag'
+      }]
+    }
+  ]
+})