eslint-plugin-vue/lib/rules/html-end-tags.js

Official ESLint plugin for Vue.js

/**
 * @author Toru Nagashima
 * @copyright 2017 Toru Nagashima. All rights reserved.
 * See LICENSE file in root directory for full license.
 */
'use strict'

// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------

const utils = require('../utils')

// ------------------------------------------------------------------------------
// Helpers
// ------------------------------------------------------------------------------

/**
 * Creates AST event handlers for html-end-tags.
 *
 * @param {RuleContext} context - The rule context.
 * @returns {Object} AST event handlers.
 */
function create (context) {
  utils.registerTemplateBodyVisitor(context, {
    VElement (node) {
      const name = node.name
      const isVoid = utils.isVoidElementName(name)
      const hasEndTag = node.endTag != null

      if (isVoid && hasEndTag) {
        context.report({
          node: node.endTag,
          loc: node.endTag.loc,
          message: "'<{{name}}>' should not have end tag.",
          data: { name },
          fix: (fixer) => fixer.remove(node.endTag)
        })
      }
      if (!isVoid && !hasEndTag) {
        context.report({
          node: node.startTag,
          loc: node.startTag.loc,
          message: "'<{{name}}>' should have end tag.",
          data: { name },
          fix: (fixer) => fixer.insertTextAfter(node, `</${name}>`)
        })
      }
    }
  })

  return {}
}

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------

module.exports = {
  create,
  meta: {
    docs: {
      description: 'enforce end tag style.',
      category: 'Best Practices',
      recommended: false
    },
    fixable: 'code',
    schema: []
  }
}