Add jsdoc type annotation to rules (#1606)

sindresorhus · Nov 12, 2021 · df4295b · df4295b
1 parent 70ae05a
commit df4295b
Show file tree

Hide file tree

Showing 96 changed files with 164 additions and 0 deletions.
diff --git a/rules/better-regex.js b/rules/better-regex.js
@@ -14,6 +14,7 @@ const newRegExp = [
 	'[arguments.0.type="Literal"]',
 ].join('');
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const {sortCharacterClasses} = context.options[0] || {};
 
@@ -111,6 +112,7 @@ const schema = [
 	},
 ];
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/catch-error-name.js b/rules/catch-error-name.js
@@ -32,6 +32,7 @@ const selector = matches([
 	].join(''),
 ]);
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const options = {
 		name: 'error',
@@ -113,6 +114,7 @@ const schema = [
 	},
 ];
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/consistent-destructuring.js b/rules/consistent-destructuring.js
@@ -51,6 +51,7 @@ const isChildInParentScope = (child, parent) => {
 	return false;
 };
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const source = context.getSourceCode();
 	const declarations = new Map();
@@ -149,6 +150,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/consistent-function-scoping.js b/rules/consistent-function-scoping.js
@@ -149,6 +149,7 @@ function checkNode(node, scopeManager) {
 	return checkReferences(scope, parentScope, scopeManager);
 }
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const {checkArrowFunctions} = {checkArrowFunctions: true, ...context.options[0]};
 	const sourceCode = context.getSourceCode();
@@ -206,6 +207,7 @@ const schema = [
 	},
 ];
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/custom-error-definition.js b/rules/custom-error-definition.js
@@ -182,12 +182,14 @@ const customErrorExport = (context, node) => {
 	};
 };
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => ({
 	ClassDeclaration: node => customErrorDefinition(context, node),
 	'AssignmentExpression[right.type="ClassExpression"]': node => customErrorDefinition(context, node.right),
 	'AssignmentExpression[left.type="MemberExpression"][left.object.type="Identifier"][left.object.name="exports"]': node => customErrorExport(context, node),
 });
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/empty-brace-spaces.js b/rules/empty-brace-spaces.js
@@ -44,6 +44,7 @@ const create = context => ({
 	},
 });
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/error-message.js b/rules/error-message.js
@@ -25,6 +25,7 @@ const selector = callOrNewExpressionSelector([
 	'AggregateError',
 ]);
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => ({
 	[selector](expression) {
 		if (isShadowed(context.getScope(), expression.callee)) {
@@ -82,6 +83,7 @@ const create = context => ({
 	},
 });
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/escape-case.js b/rules/escape-case.js
@@ -20,6 +20,7 @@ const getProblem = ({node, original, regex = escapeWithLowercase, fix}) => {
 	}
 };
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = () => ({
 	Literal(node) {
 		if (typeof node.value !== 'string') {
@@ -47,6 +48,7 @@ const create = () => ({
 	},
 });
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/expiring-todo-comments.js b/rules/expiring-todo-comments.js
@@ -242,6 +242,7 @@ function semverComparisonForOperator(operator) {
 	}[operator];
 }
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const options = {
 		terms: ['todo', 'fixme', 'xxx'],
@@ -534,6 +535,7 @@ const schema = [
 	},
 ];
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/explicit-length-check.js b/rules/explicit-length-check.js
@@ -195,6 +195,7 @@ const schema = [
 	},
 ];
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create: checkVueTemplate(create),
 	meta: {

diff --git a/rules/filename-case.js b/rules/filename-case.js
@@ -142,6 +142,7 @@ function englishishJoinWords(words) {
 	return `${words.slice(0, -1).join(', ')}, or ${words[words.length - 1]}`;
 }
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const options = context.options[0] || {};
 	const chosenCases = getChosenCases(options);
@@ -253,6 +254,7 @@ const schema = [
 	},
 ];
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/import-index.js b/rules/import-index.js
@@ -20,6 +20,7 @@ const importIndex = (context, node, argument) => {
 	}
 };
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const options = context.options[0] || {};
 
@@ -47,6 +48,7 @@ const schema = [
 	},
 ];
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/import-style.js b/rules/import-style.js
@@ -150,6 +150,7 @@ const assignedRequireTemplate = templates.template`
 	${variableDeclarationVariable} ${assignmentTargetVariable} = require(${moduleNameVariable});
 `;
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	let [
 		{
@@ -364,6 +365,7 @@ const schema = {
 	},
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/new-for-builtins.js b/rules/new-for-builtins.js
@@ -12,6 +12,7 @@ const messages = {
 	disallow: 'Use `{{name}}()` instead of `new {{name}}()`.',
 };
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const sourceCode = context.getSourceCode();
 
@@ -66,6 +67,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-abusive-eslint-disable.js b/rules/no-abusive-eslint-disable.js
@@ -7,6 +7,7 @@ const messages = {
 
 const disableRegex = /^eslint-disable(?:-next-line|-line)?(?<ruleId>$|(?:\s+(?:@(?:[\w-]+\/){1,2})?[\w-]+)?)/;
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = () => ({
 	* Program(node) {
 		for (const comment of node.comments) {
@@ -34,6 +35,7 @@ const create = () => ({
 	},
 });
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-array-callback-reference.js b/rules/no-array-callback-reference.js
@@ -187,6 +187,7 @@ const ignoredFirstArgumentSelector = [
 	'[arguments.0.type!="ArrowFunctionExpression"]',
 ].join('');
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const sourceCode = context.getSourceCode();
 	const rules = {};
@@ -220,6 +221,7 @@ const create = context => {
 	return rules;
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-array-for-each.js b/rules/no-array-for-each.js
@@ -364,6 +364,7 @@ const ignoredObjects = [
 	'R',
 ];
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const functionStack = [];
 	const callExpressions = [];
@@ -416,6 +417,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-array-method-this-argument.js b/rules/no-array-method-this-argument.js
@@ -159,6 +159,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-array-push-push.js b/rules/no-array-push-push.js
@@ -120,6 +120,7 @@ const schema = [
 	},
 ];
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-array-reduce.js b/rules/no-array-reduce.js
@@ -48,6 +48,7 @@ const schema = [
 	},
 ];
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const {allowSimpleOperations} = {allowSimpleOperations: true, ...context.options[0]};
 
@@ -81,6 +82,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-await-expression-member.js b/rules/no-await-expression-member.js
@@ -70,6 +70,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-console-spaces.js b/rules/no-console-spaces.js
@@ -27,6 +27,7 @@ const hasLeadingSpace = value => value.length > 1 && value.charAt(0) === ' ' &&
 // Find exactly one trailing space, allow exactly one space
 const hasTrailingSpace = value => value.length > 1 && value.charAt(value.length - 1) === ' ' && value.charAt(value.length - 2) !== ' ';
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const sourceCode = context.getSourceCode();
 	const getProblem = (node, method, position) => {
@@ -71,6 +72,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-document-cookie.js b/rules/no-document-cookie.js
@@ -28,6 +28,7 @@ const create = context => ({
 	},
 });
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-empty-file.js b/rules/no-empty-file.js
@@ -13,6 +13,7 @@ const isEmpty = node =>
 	|| node.type === 'EmptyStatement'
 	|| (node.type === 'ExpressionStatement' && 'directive' in node);
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const filename = context.getPhysicalFilename().toLowerCase();
 
@@ -34,6 +35,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-for-loop.js b/rules/no-for-loop.js
@@ -260,6 +260,7 @@ const someVariablesLeakOutOfTheLoop = (forStatement, variables, forScope) =>
 const getReferencesInChildScopes = (scope, name) =>
 	getReferences(scope).filter(reference => reference.identifier.name === name);
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const sourceCode = context.getSourceCode();
 	const {scopeManager, text: sourceCodeText} = sourceCode;
@@ -411,6 +412,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-hex-escape.js b/rules/no-hex-escape.js
@@ -21,6 +21,7 @@ function checkEscape(context, node, value) {
 	}
 }
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => ({
 	Literal: node => {
 		if (node.regex || typeof node.value === 'string') {
@@ -30,6 +31,7 @@ const create = context => ({
 	TemplateElement: node => checkEscape(context, node, node.value.raw),
 });
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-instanceof-array.js b/rules/no-instanceof-array.js
@@ -16,6 +16,7 @@ const selector = [
 	'[right.name="Array"]',
 ].join('');
 
+/** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	const sourceCode = context.getSourceCode();
 
@@ -48,6 +49,7 @@ const create = context => {
 	};
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create: checkVueTemplate(create),
 	meta: {

diff --git a/rules/no-invalid-remove-event-listener.js b/rules/no-invalid-remove-event-listener.js
@@ -40,6 +40,7 @@ const create = context => ({
 	},
 });
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {

diff --git a/rules/no-keyword-prefix.js b/rules/no-keyword-prefix.js
@@ -189,6 +189,7 @@ const schema = [
 	},
 ];
 
+/** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
 	create,
 	meta: {