chore: add jsdoc type annotation to rules

Author: bmish

lib/rules/consistent-output.js

@@ -11,6 +11,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/fixer-return.js

@@ -16,6 +16,9 @@ const { getStaticValue } = require('eslint-utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/meta-property-ordering.js

@@ -10,6 +10,9 @@ const { getKeyName, getRuleInfo } = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-deprecated-context-methods.js

@@ -34,6 +34,9 @@ const DEPRECATED_PASSTHROUGHS = {
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-deprecated-report-api.js

@@ -11,6 +11,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-identical-tests.js

@@ -11,6 +11,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-missing-placeholders.js

@@ -12,6 +12,9 @@ const { getStaticValue } = require('eslint-utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-only-tests.js

@@ -3,6 +3,9 @@
 const utils = require('../utils');
 const { isCommaToken, isOpeningBraceToken, isClosingBraceToken } = require('eslint-utils');
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-unused-placeholders.js

@@ -12,6 +12,9 @@ const { getStaticValue } = require('eslint-utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-useless-token-range.js

@@ -11,6 +11,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/prefer-message-ids.js

@@ -7,6 +7,9 @@ const { getStaticValue } = require('eslint-utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/prefer-object-rule.js

@@ -10,6 +10,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/prefer-output-null.js

@@ -11,6 +11,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/prefer-placeholders.js

@@ -12,6 +12,9 @@ const { findVariable } = require('eslint-utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/prefer-replace-text.js

@@ -11,6 +11,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/report-message-format.js

@@ -12,6 +12,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/require-meta-docs-description.js

@@ -9,6 +9,9 @@ const utils = require('../utils');
 
 const DEFAULT_PATTERN = new RegExp('^(enforce|require|disallow)');
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/require-meta-docs-url.js

@@ -16,6 +16,9 @@ const { getStaticValue } = require('eslint-utils');
 // Rule Definition
 // -----------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/require-meta-fixable.js

@@ -12,6 +12,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/require-meta-has-suggestions.js

@@ -7,6 +7,9 @@ const { getStaticValue } = require('eslint-utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/require-meta-schema.js

@@ -7,6 +7,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/require-meta-type.js

@@ -13,6 +13,9 @@ const VALID_TYPES = new Set(['problem', 'suggestion', 'layout']);
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/test-case-property-ordering.js

@@ -11,6 +11,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/test-case-shorthand-strings.js

@@ -11,6 +11,9 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',