Skip to content

Commit de1e2f0

Browse files
bmishbmish
authored
chore: add jsdoc type annotation to rules (#228)
1 parent 8bde9b4 commit de1e2f0

24 files changed

+24
-0
lines changed

‎lib/rules/consistent-output.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const utils = require('../utils');
1111
// Rule Definition
1212
// ------------------------------------------------------------------------------
1313

14+
/** @type {import('eslint').Rule.RuleModule} */
1415
module.exports = {
1516
meta: {
1617
type: 'suggestion',

‎lib/rules/fixer-return.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ const { getStaticValue } = require('eslint-utils');
1616
// Rule Definition
1717
// ------------------------------------------------------------------------------
1818

19+
/** @type {import('eslint').Rule.RuleModule} */
1920
module.exports = {
2021
meta: {
2122
type: 'problem',

‎lib/rules/meta-property-ordering.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const { getKeyName, getRuleInfo } = require('../utils');
1010
// Rule Definition
1111
// ------------------------------------------------------------------------------
1212

13+
/** @type {import('eslint').Rule.RuleModule} */
1314
module.exports = {
1415
meta: {
1516
type: 'suggestion',

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ const DEPRECATED_PASSTHROUGHS = {
3434
// Rule Definition
3535
// ------------------------------------------------------------------------------
3636

37+
/** @type {import('eslint').Rule.RuleModule} */
3738
module.exports = {
3839
meta: {
3940
type: 'suggestion',

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const utils = require('../utils');
1111
// Rule Definition
1212
// ------------------------------------------------------------------------------
1313

14+
/** @type {import('eslint').Rule.RuleModule} */
1415
module.exports = {
1516
meta: {
1617
type: 'suggestion',

‎lib/rules/no-identical-tests.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const utils = require('../utils');
1111
// Rule Definition
1212
// ------------------------------------------------------------------------------
1313

14+
/** @type {import('eslint').Rule.RuleModule} */
1415
module.exports = {
1516
meta: {
1617
type: 'problem',

‎lib/rules/no-missing-placeholders.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ const { getStaticValue } = require('eslint-utils');
1212
// Rule Definition
1313
// ------------------------------------------------------------------------------
1414

15+
/** @type {import('eslint').Rule.RuleModule} */
1516
module.exports = {
1617
meta: {
1718
type: 'problem',

‎lib/rules/no-only-tests.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
const utils = require('../utils');
44
const { isCommaToken, isOpeningBraceToken, isClosingBraceToken } = require('eslint-utils');
55

6+
/** @type {import('eslint').Rule.RuleModule} */
67
module.exports = {
78
meta: {
89
type: 'problem',

‎lib/rules/no-unused-placeholders.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ const { getStaticValue } = require('eslint-utils');
1212
// Rule Definition
1313
// ------------------------------------------------------------------------------
1414

15+
/** @type {import('eslint').Rule.RuleModule} */
1516
module.exports = {
1617
meta: {
1718
type: 'problem',

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const utils = require('../utils');
1111
// Rule Definition
1212
// ------------------------------------------------------------------------------
1313

14+
/** @type {import('eslint').Rule.RuleModule} */
1415
module.exports = {
1516
meta: {
1617
type: 'suggestion',

‎lib/rules/prefer-message-ids.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ const { getStaticValue } = require('eslint-utils');
77
// Rule Definition
88
// ------------------------------------------------------------------------------
99

10+
/** @type {import('eslint').Rule.RuleModule} */
1011
module.exports = {
1112
meta: {
1213
type: 'problem',

‎lib/rules/prefer-object-rule.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const utils = require('../utils');
1010
// Rule Definition
1111
// ------------------------------------------------------------------------------
1212

13+
/** @type {import('eslint').Rule.RuleModule} */
1314
module.exports = {
1415
meta: {
1516
type: 'suggestion',

‎lib/rules/prefer-output-null.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const utils = require('../utils');
1111
// Rule Definition
1212
// ------------------------------------------------------------------------------
1313

14+
/** @type {import('eslint').Rule.RuleModule} */
1415
module.exports = {
1516
meta: {
1617
type: 'suggestion',

‎lib/rules/prefer-placeholders.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ const { findVariable } = require('eslint-utils');
1212
// Rule Definition
1313
// ------------------------------------------------------------------------------
1414

15+
/** @type {import('eslint').Rule.RuleModule} */
1516
module.exports = {
1617
meta: {
1718
type: 'suggestion',

‎lib/rules/prefer-replace-text.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const utils = require('../utils');
1111
// Rule Definition
1212
// ------------------------------------------------------------------------------
1313

14+
/** @type {import('eslint').Rule.RuleModule} */
1415
module.exports = {
1516
meta: {
1617
type: 'suggestion',

‎lib/rules/report-message-format.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ const utils = require('../utils');
1212
// Rule Definition
1313
// ------------------------------------------------------------------------------
1414

15+
/** @type {import('eslint').Rule.RuleModule} */
1516
module.exports = {
1617
meta: {
1718
type: 'suggestion',

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ const utils = require('../utils');
99

1010
const DEFAULT_PATTERN = new RegExp('^(enforce|require|disallow)');
1111

12+
/** @type {import('eslint').Rule.RuleModule} */
1213
module.exports = {
1314
meta: {
1415
type: 'suggestion',

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ const { getStaticValue } = require('eslint-utils');
1616
// Rule Definition
1717
// -----------------------------------------------------------------------------
1818

19+
/** @type {import('eslint').Rule.RuleModule} */
1920
module.exports = {
2021
meta: {
2122
type: 'suggestion',

‎lib/rules/require-meta-fixable.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ const utils = require('../utils');
1212
// Rule Definition
1313
// ------------------------------------------------------------------------------
1414

15+
/** @type {import('eslint').Rule.RuleModule} */
1516
module.exports = {
1617
meta: {
1718
type: 'problem',

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ const { getStaticValue } = require('eslint-utils');
77
// Rule Definition
88
// ------------------------------------------------------------------------------
99

10+
/** @type {import('eslint').Rule.RuleModule} */
1011
module.exports = {
1112
meta: {
1213
type: 'problem',

‎lib/rules/require-meta-schema.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ const utils = require('../utils');
77
// Rule Definition
88
// ------------------------------------------------------------------------------
99

10+
/** @type {import('eslint').Rule.RuleModule} */
1011
module.exports = {
1112
meta: {
1213
type: 'suggestion',

‎lib/rules/require-meta-type.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ const VALID_TYPES = new Set(['problem', 'suggestion', 'layout']);
1313
// Rule Definition
1414
// ------------------------------------------------------------------------------
1515

16+
/** @type {import('eslint').Rule.RuleModule} */
1617
module.exports = {
1718
meta: {
1819
type: 'problem',

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const utils = require('../utils');
1111
// Rule Definition
1212
// ------------------------------------------------------------------------------
1313

14+
/** @type {import('eslint').Rule.RuleModule} */
1415
module.exports = {
1516
meta: {
1617
type: 'suggestion',

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const utils = require('../utils');
1111
// Rule Definition
1212
// ------------------------------------------------------------------------------
1313

14+
/** @type {import('eslint').Rule.RuleModule} */
1415
module.exports = {
1516
meta: {
1617
type: 'suggestion',

0 commit comments

Comments
 (0)