chore: add jsdoc type annotation to rules

eslint · Nov 11, 2021 · b47d925 · b47d925
1 parent 1055f16
commit b47d925
Show file tree

Hide file tree

Showing 285 changed files with 855 additions and 0 deletions.
diff --git a/lib/rules/accessor-pairs.js b/lib/rules/accessor-pairs.js
@@ -134,6 +134,9 @@ function isPropertyDescriptor(node) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/array-bracket-newline.js b/lib/rules/array-bracket-newline.js
@@ -11,6 +11,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/array-bracket-spacing.js b/lib/rules/array-bracket-spacing.js
@@ -10,6 +10,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/array-callback-return.js b/lib/rules/array-callback-return.js
@@ -133,6 +133,9 @@ function getArrayMethodName(node) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "problem",

diff --git a/lib/rules/array-element-newline.js b/lib/rules/array-element-newline.js
@@ -11,6 +11,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/arrow-body-style.js b/lib/rules/arrow-body-style.js
@@ -14,6 +14,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/arrow-parens.js b/lib/rules/arrow-parens.js
@@ -27,6 +27,9 @@ function hasBlockBody(node) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/arrow-spacing.js b/lib/rules/arrow-spacing.js
@@ -14,6 +14,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/block-scoped-var.js b/lib/rules/block-scoped-var.js
@@ -8,6 +8,9 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/block-spacing.js b/lib/rules/block-spacing.js
@@ -11,6 +11,9 @@ const util = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/brace-style.js b/lib/rules/brace-style.js
@@ -11,6 +11,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/callback-return.js b/lib/rules/callback-return.js
@@ -9,6 +9,9 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         deprecated: true,

diff --git a/lib/rules/camelcase.js b/lib/rules/camelcase.js
@@ -9,6 +9,9 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/capitalized-comments.js b/lib/rules/capitalized-comments.js
@@ -99,6 +99,9 @@ function createRegExpForIgnorePatterns(normalizedOptions) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/class-methods-use-this.js b/lib/rules/class-methods-use-this.js
@@ -15,6 +15,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/comma-dangle.js b/lib/rules/comma-dangle.js
@@ -70,6 +70,9 @@ function normalizeOptions(optionValue, ecmaVersion) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/comma-spacing.js b/lib/rules/comma-spacing.js
@@ -10,6 +10,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/comma-style.js b/lib/rules/comma-style.js
@@ -11,6 +11,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/complexity.js b/lib/rules/complexity.js
@@ -17,6 +17,9 @@ const { upperCaseFirst } = require("../shared/string-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/computed-property-spacing.js b/lib/rules/computed-property-spacing.js
@@ -10,6 +10,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/consistent-return.js b/lib/rules/consistent-return.js
@@ -40,6 +40,9 @@ function isClassConstructor(node) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/consistent-this.js b/lib/rules/consistent-this.js
@@ -8,6 +8,9 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/constructor-super.js b/lib/rules/constructor-super.js
@@ -116,6 +116,9 @@ function isPossibleConstructor(node) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "problem",

diff --git a/lib/rules/curly.js b/lib/rules/curly.js
@@ -14,6 +14,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/default-case-last.js b/lib/rules/default-case-last.js
@@ -9,6 +9,9 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/default-case.js b/lib/rules/default-case.js
@@ -10,6 +10,9 @@ const DEFAULT_COMMENT_PATTERN = /^no default$/iu;
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/default-param-last.js b/lib/rules/default-param-last.js
@@ -5,6 +5,9 @@
 
 "use strict";
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/dot-location.js b/lib/rules/dot-location.js
@@ -11,6 +11,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/dot-notation.js b/lib/rules/dot-notation.js
@@ -20,6 +20,9 @@ const validIdentifier = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/u;
 // `null` literal must be handled separately.
 const literalTypesToCheck = new Set(["string", "boolean"]);
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/eol-last.js b/lib/rules/eol-last.js
@@ -8,6 +8,9 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/eqeqeq.js b/lib/rules/eqeqeq.js
@@ -15,6 +15,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/for-direction.js b/lib/rules/for-direction.js
@@ -9,6 +9,9 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "problem",

diff --git a/lib/rules/func-call-spacing.js b/lib/rules/func-call-spacing.js
@@ -15,6 +15,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/func-name-matching.js b/lib/rules/func-name-matching.js
@@ -68,6 +68,9 @@ const optionsObject = {
     additionalProperties: false
 };
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/func-names.js b/lib/rules/func-names.js
@@ -24,6 +24,9 @@ function isFunctionName(variable) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/func-style.js b/lib/rules/func-style.js
@@ -8,6 +8,9 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "suggestion",

diff --git a/lib/rules/function-call-argument-newline.js b/lib/rules/function-call-argument-newline.js
@@ -9,6 +9,9 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/function-paren-newline.js b/lib/rules/function-paren-newline.js
@@ -14,6 +14,9 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/generator-star-spacing.js b/lib/rules/generator-star-spacing.js
@@ -25,6 +25,9 @@ const OVERRIDE_SCHEMA = {
     ]
 };
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "layout",

diff --git a/lib/rules/getter-return.js b/lib/rules/getter-return.js
@@ -29,6 +29,9 @@ function isReachable(segment) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
     meta: {
         type: "problem",