Skip to content

Commit

Permalink
chore: add jsdoc type annotation to rules
Browse files Browse the repository at this point in the history
  • Loading branch information
@bmish
bmish committed Nov 11, 2021
1 parent 8bde9b4 commit d6b9980
Show file tree
Hide file tree
Showing 24 changed files with 72 additions and 0 deletions.
3 changes: 3 additions & 0 deletions lib/rules/consistent-output.js
View file
Expand Up @@ -11,6 +11,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/fixer-return.js
View file
Expand Up @@ -16,6 +16,9 @@ const { getStaticValue } = require('eslint-utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'problem',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/meta-property-ordering.js
View file
Expand Up @@ -10,6 +10,9 @@ const { getKeyName, getRuleInfo } = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/no-deprecated-context-methods.js
View file
Expand Up @@ -34,6 +34,9 @@ const DEPRECATED_PASSTHROUGHS = {
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/no-deprecated-report-api.js
View file
Expand Up @@ -11,6 +11,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/no-identical-tests.js
View file
Expand Up @@ -11,6 +11,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'problem',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/no-missing-placeholders.js
View file
Expand Up @@ -12,6 +12,9 @@ const { getStaticValue } = require('eslint-utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'problem',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/no-only-tests.js
View file
Expand Up @@ -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',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/no-unused-placeholders.js
View file
Expand Up @@ -12,6 +12,9 @@ const { getStaticValue } = require('eslint-utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'problem',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/no-useless-token-range.js
View file
Expand Up @@ -11,6 +11,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/prefer-message-ids.js
View file
Expand Up @@ -7,6 +7,9 @@ const { getStaticValue } = require('eslint-utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'problem',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/prefer-object-rule.js
View file
Expand Up @@ -10,6 +10,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/prefer-output-null.js
View file
Expand Up @@ -11,6 +11,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/prefer-placeholders.js
View file
Expand Up @@ -12,6 +12,9 @@ const { findVariable } = require('eslint-utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/prefer-replace-text.js
View file
Expand Up @@ -11,6 +11,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/report-message-format.js
View file
Expand Up @@ -12,6 +12,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/require-meta-docs-description.js
View file
Expand Up @@ -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',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/require-meta-docs-url.js
View file
Expand Up @@ -16,6 +16,9 @@ const { getStaticValue } = require('eslint-utils');
// Rule Definition
// -----------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/require-meta-fixable.js
View file
Expand Up @@ -12,6 +12,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'problem',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/require-meta-has-suggestions.js
View file
Expand Up @@ -7,6 +7,9 @@ const { getStaticValue } = require('eslint-utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'problem',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/require-meta-schema.js
View file
Expand Up @@ -7,6 +7,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/require-meta-type.js
View file
Expand Up @@ -13,6 +13,9 @@ const VALID_TYPES = new Set(['problem', 'suggestion', 'layout']);
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'problem',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/test-case-property-ordering.js
View file
Expand Up @@ -11,6 +11,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/test-case-shorthand-strings.js
View file
Expand Up @@ -11,6 +11,9 @@ const utils = require('../utils');
// Rule Definition
// ------------------------------------------------------------------------------

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

0 comments on commit d6b9980

Please sign in to comment.