Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add jsdoc type annotation to rules #15291

Merged
merged 5 commits into from Nov 24, 2021
Merged

chore: add jsdoc type annotation to rules #15291

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a39a99e
chore: add jsdoc type annotation to rules
bmish Nov 11, 2021
3738d9e
switch to internal eslint rule type for jsdoc comment
bmish Nov 12, 2021
7ba3747
Merge branch 'main' into rules-jsdoc-type
bmish Nov 19, 2021
e0b372b
test: ensure each rule file has jsdoc comment with rule type
bmish Nov 19, 2021
c5798da
Merge branch 'main' into rules-jsdoc-type
bmish Nov 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/developer-guide/working-with-rules.md
View file
Open in desktop
Expand Up @@ -24,9 +24,7 @@ Here is the basic format of the source file for a rule:
// Rule Definition
//------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/accessor-pairs.js
View file
Open in desktop
Expand Up @@ -134,6 +134,7 @@ function isPropertyDescriptor(node) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/array-bracket-newline.js
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/array-bracket-spacing.js
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/array-callback-return.js
View file
Open in desktop
Expand Up @@ -133,6 +133,7 @@ function getArrayMethodName(node) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "problem",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/array-element-newline.js
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/arrow-body-style.js
View file
Open in desktop
Expand Up @@ -14,6 +14,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/arrow-parens.js
View file
Open in desktop
Expand Up @@ -27,6 +27,7 @@ function hasBlockBody(node) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/arrow-spacing.js
View file
Open in desktop
Expand Up @@ -14,6 +14,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/block-scoped-var.js
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/block-spacing.js
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@ const util = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/brace-style.js
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/callback-return.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
deprecated: true,
Expand Down
1 change: 1 addition & 0 deletions lib/rules/camelcase.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/capitalized-comments.js
View file
Open in desktop
Expand Up @@ -99,6 +99,7 @@ function createRegExpForIgnorePatterns(normalizedOptions) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/class-methods-use-this.js
View file
Open in desktop
Expand Up @@ -15,6 +15,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/comma-dangle.js
View file
Open in desktop
Expand Up @@ -70,6 +70,7 @@ function normalizeOptions(optionValue, ecmaVersion) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/comma-spacing.js
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/comma-style.js
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/complexity.js
View file
Open in desktop
Expand Up @@ -17,6 +17,7 @@ const { upperCaseFirst } = require("../shared/string-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/computed-property-spacing.js
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/consistent-return.js
View file
Open in desktop
Expand Up @@ -40,6 +40,7 @@ function isClassConstructor(node) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/consistent-this.js
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/constructor-super.js
View file
Open in desktop
Expand Up @@ -116,6 +116,7 @@ function isPossibleConstructor(node) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "problem",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/curly.js
View file
Open in desktop
Expand Up @@ -14,6 +14,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/default-case-last.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/default-case.js
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ const DEFAULT_COMMENT_PATTERN = /^no default$/iu;
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/default-param-last.js
View file
Open in desktop
Expand Up @@ -5,6 +5,7 @@

"use strict";

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/dot-location.js
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/dot-notation.js
View file
Open in desktop
Expand Up @@ -20,6 +20,7 @@ const validIdentifier = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/u;
// `null` literal must be handled separately.
const literalTypesToCheck = new Set(["string", "boolean"]);

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/eol-last.js
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/eqeqeq.js
View file
Open in desktop
Expand Up @@ -15,6 +15,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/for-direction.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "problem",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/func-call-spacing.js
View file
Open in desktop
Expand Up @@ -15,6 +15,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/func-name-matching.js
View file
Open in desktop
Expand Up @@ -68,6 +68,7 @@ const optionsObject = {
additionalProperties: false
};

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/func-names.js
View file
Open in desktop
Expand Up @@ -24,6 +24,7 @@ function isFunctionName(variable) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/func-style.js
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/function-call-argument-newline.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/function-paren-newline.js
View file
Open in desktop
Expand Up @@ -14,6 +14,7 @@ const astUtils = require("./utils/ast-utils");
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/generator-star-spacing.js
View file
Open in desktop
Expand Up @@ -25,6 +25,7 @@ const OVERRIDE_SCHEMA = {
]
};

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "layout",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/getter-return.js
View file
Open in desktop
Expand Up @@ -29,6 +29,7 @@ function isReachable(segment) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "problem",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/global-require.js
View file
Open in desktop
Expand Up @@ -48,6 +48,7 @@ function isShadowed(scope, node) {
return reference && reference.resolved && reference.resolved.defs.length > 0;
}

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
deprecated: true,
Expand Down
1 change: 1 addition & 0 deletions lib/rules/grouped-accessor-pairs.js
View file
Open in desktop
Expand Up @@ -90,6 +90,7 @@ function isAccessorKind(node) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/guard-for-in.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/handle-callback-err.js
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
deprecated: true,
Expand Down
1 change: 1 addition & 0 deletions lib/rules/id-blacklist.js
View file
Open in desktop
Expand Up @@ -110,6 +110,7 @@ function isShorthandPropertyDefinition(node) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
deprecated: true,
Expand Down
1 change: 1 addition & 0 deletions lib/rules/id-denylist.js
View file
Open in desktop
Expand Up @@ -93,6 +93,7 @@ function isPropertyNameInDestructuring(node) {
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/id-length.js
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down
1 change: 1 addition & 0 deletions lib/rules/id-match.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
meta: {
type: "suggestion",
Expand Down