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 f93b4be commit 6ff0e73
Show file tree
Hide file tree
Showing 96 changed files with 288 additions and 0 deletions.
3 changes: 3 additions & 0 deletions rules/better-regex.js
View file
Expand Up @@ -111,6 +111,9 @@ const schema = [
},
];

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/catch-error-name.js
View file
Expand Up @@ -113,6 +113,9 @@ const schema = [
},
];

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/consistent-destructuring.js
View file
Expand Up @@ -149,6 +149,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/consistent-function-scoping.js
View file
Expand Up @@ -206,6 +206,9 @@ const schema = [
},
];

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/custom-error-definition.js
View file
Expand Up @@ -188,6 +188,9 @@ const create = context => ({
'AssignmentExpression[left.type="MemberExpression"][left.object.type="Identifier"][left.object.name="exports"]': node => customErrorExport(context, node),
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/empty-brace-spaces.js
View file
Expand Up @@ -44,6 +44,9 @@ const create = context => ({
},
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/error-message.js
View file
Expand Up @@ -82,6 +82,9 @@ const create = context => ({
},
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/escape-case.js
View file
Expand Up @@ -47,6 +47,9 @@ const create = () => ({
},
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/expiring-todo-comments.js
View file
Expand Up @@ -534,6 +534,9 @@ const schema = [
},
];

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/explicit-length-check.js
View file
Expand Up @@ -195,6 +195,9 @@ const schema = [
},
];

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create: checkVueTemplate(create),
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/filename-case.js
View file
Expand Up @@ -253,6 +253,9 @@ const schema = [
},
];

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/import-index.js
View file
Expand Up @@ -47,6 +47,9 @@ const schema = [
},
];

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

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/new-for-builtins.js
View file
Expand Up @@ -66,6 +66,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-abusive-eslint-disable.js
View file
Expand Up @@ -34,6 +34,9 @@ const create = () => ({
},
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-array-callback-reference.js
View file
Expand Up @@ -220,6 +220,9 @@ const create = context => {
return rules;
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-array-for-each.js
View file
Expand Up @@ -416,6 +416,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-array-method-this-argument.js
View file
Expand Up @@ -159,6 +159,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-array-push-push.js
View file
Expand Up @@ -120,6 +120,9 @@ const schema = [
},
];

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-array-reduce.js
View file
Expand Up @@ -81,6 +81,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-await-expression-member.js
View file
Expand Up @@ -70,6 +70,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-console-spaces.js
View file
Expand Up @@ -71,6 +71,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-document-cookie.js
View file
Expand Up @@ -28,6 +28,9 @@ const create = context => ({
},
});

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

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-for-loop.js
View file
Expand Up @@ -411,6 +411,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-hex-escape.js
View file
Expand Up @@ -30,6 +30,9 @@ const create = context => ({
TemplateElement: node => checkEscape(context, node, node.value.raw),
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-instanceof-array.js
View file
Expand Up @@ -48,6 +48,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create: checkVueTemplate(create),
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-invalid-remove-event-listener.js
View file
Expand Up @@ -40,6 +40,9 @@ const create = context => ({
},
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-keyword-prefix.js
View file
Expand Up @@ -189,6 +189,9 @@ const schema = [
},
];

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-lonely-if.js
View file
Expand Up @@ -134,6 +134,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-nested-ternary.js
View file
Expand Up @@ -32,6 +32,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-new-array.js
View file
Expand Up @@ -81,6 +81,9 @@ const create = context => ({
},
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-new-buffer.js
View file
Expand Up @@ -77,6 +77,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-null.js
View file
Expand Up @@ -103,6 +103,9 @@ const schema = [
},
];

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-object-as-default-parameter.js
View file
Expand Up @@ -32,6 +32,9 @@ const create = () => ({
},
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-process-exit.js
View file
Expand Up @@ -75,6 +75,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-static-only-class.js
View file
Expand Up @@ -215,6 +215,9 @@ function create(context) {
};
}

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-this-assignment.js
View file
Expand Up @@ -31,6 +31,9 @@ const create = () => ({
},
});

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-unreadable-array-destructuring.js
View file
Expand Up @@ -66,6 +66,9 @@ const create = context => {
};
};

/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
create,
meta: {
Expand Down
3 changes: 3 additions & 0 deletions rules/no-unsafe-regex.js
View file
Expand Up @@ -56,6 +56,9 @@ const create = () => ({
},
});

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

0 comments on commit 6ff0e73

Please sign in to comment.