Add checkVueTemplate to simplify create rule for Vue SFC (#1362)

Author: fisker

index.js

@@ -1,6 +1,6 @@
 'use strict';
 const createDeprecatedRules = require('./rules/utils/create-deprecated-rules.js');
-const {loadRules} = require('./rules/utils/load-rule.js');
+const {loadRules} = require('./rules/utils/rule.js');
 
 const deprecatedRules = createDeprecatedRules({
 	// {ruleId: ReplacementRuleId | ReplacementRuleId[]}, if no replacement, use `{ruleId: []}`

rules/explicit-length-check.js

@@ -1,5 +1,6 @@
 'use strict';
 const {isParenthesized, getStaticValue} = require('eslint-utils');
+const {checkVueTemplate} = require('./utils/rule.js');
 const isLiteralValue = require('./utils/is-literal-value.js');
 const isLogicalExpression = require('./utils/is-logical-expression.js');
 const {isBooleanNode, getBooleanAncestor} = require('./utils/boolean.js');
@@ -141,11 +142,10 @@ function create(context) {
 			];
 		}
 
-		// TODO[@fisker]: Make `return problem` work for `vue-eslint-parser`
-		context.report(problem);
+		return problem;
 	}
 
-	const listeners = {
+	return {
 		[lengthSelector](lengthNode) {
 			if (lengthNode.object.type === 'ThisExpression') {
 				return;
@@ -183,13 +183,6 @@ function create(context) {
 			}
 		}
 	};
-
-	// `vue-eslint-parser`
-	if (context.parserServices && context.parserServices.defineTemplateBodyVisitor) {
-		return context.parserServices.defineTemplateBodyVisitor(listeners, listeners);
-	}
-
-	return listeners;
 }
 
 const schema = [
@@ -205,7 +198,7 @@ const schema = [
 ];
 
 module.exports = {
-	create,
+	create: checkVueTemplate(create),
 	meta: {
 		type: 'problem',
 		docs: {

rules/utils/load-rule.js renamed to rules/utils/rule.js

@@ -5,7 +5,7 @@ const getDocumentationUrl = require('./get-documentation-url.js');
 
 const isIterable = object => typeof object[Symbol.iterator] === 'function';
 
-function reportProblems(listener, context) {
+function reportListenerProblems(listener, context) {
 	// Listener arguments can be `codePath, node` or `node`
 	return function (...listenerArguments) {
 		let problems = listener(...listenerArguments);
@@ -27,15 +27,51 @@ function reportProblems(listener, context) {
 	};
 }
 
-function wrapCreateFunction(create) {
-	return function (context) {
+// `checkVueTemplate` function will wrap `create` function, there is no need to wrap twice
+const wrappedFunctions = new Set();
+function reportProblems(create) {
+	if (wrappedFunctions.has(create)) {
+		return create;
+	}
+
+	const wrapped = context => Object.fromEntries(
+		Object.entries(create(context))
+			.map(([selector, listener]) => [selector, reportListenerProblems(listener, context)])
+	);
+
+	wrappedFunctions.add(wrapped);
+
+	return wrapped;
+}
+
+function checkVueTemplate(create, options) {
+	const {
+		visitScriptBlock
+	} = {
+		visitScriptBlock: true,
+		...options
+	};
+
+	create = reportProblems(create);
+
+	const wrapped = context => {
 		const listeners = create(context);
 
-		return Object.fromEntries(
-			Object.entries(listeners)
-				.map(([selector, listener]) => [selector, reportProblems(listener, context)])
-		);
+		// `vue-eslint-parser`
+		if (
+			context.parserServices &&
+			context.parserServices.defineTemplateBodyVisitor
+		) {
+			return visitScriptBlock ?
+				context.parserServices.defineTemplateBodyVisitor(listeners, listeners) :
+				context.parserServices.defineTemplateBodyVisitor(listeners);
+		}
+
+		return listeners;
 	};
+
+	wrappedFunctions.add(wrapped);
+	return wrapped;
 }
 
 function loadRule(ruleId) {
@@ -52,7 +88,7 @@ function loadRule(ruleId) {
 				url: getDocumentationUrl(ruleId)
 			}
 		},
-		create: wrapCreateFunction(rule.create)
+		create: reportProblems(rule.create)
 	};
 }
 
@@ -67,4 +103,8 @@ function loadRules() {
 	);
 }
 
-module.exports = {loadRule, loadRules};
+module.exports = {
+	loadRule,
+	loadRules,
+	checkVueTemplate
+};

test/utils/test.mjs

@@ -3,7 +3,7 @@ import url from 'node:url';
 import {createRequire} from 'node:module';
 import test from 'ava';
 import avaRuleTester from 'eslint-ava-rule-tester';
-import {loadRule} from '../../rules/utils/load-rule.js';
+import {loadRule} from '../../rules/utils/rule.js';
 import snapshotRuleTester from './snapshot-rule-tester.mjs';
 import defaultParserOptions from './default-parser-options.mjs';