Skip to content

BREAKING: Update jsdoc/require-jsdoc to require documentation for more things #394

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

BREAKING: Update jsdoc/require-jsdoc to require documentation for more things #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion packages/base/rules-snapshot.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,24 @@
"always",
{ "tags": { "returns": "never", "template": "always", "throws": "never" } }
],
"jsdoc/require-jsdoc": "error",
"jsdoc/require-jsdoc": [
"error",
{
"require": {
"ArrowFunctionExpression": true,
"ClassDeclaration": true,
"FunctionDeclaration": true,
"FunctionExpression": true,
"MethodDefinition": true
},
"contexts": [
"TSInterfaceDeclaration",
"TSTypeAliasDeclaration",
"TSEnumDeclaration",
"TSPropertySignature"
]
}
],
"jsdoc/require-param": ["error", { "unnamedRootBase": ["options"] }],
"jsdoc/require-param-description": "error",
"jsdoc/require-param-name": "error",
Expand Down
4 changes: 4 additions & 0 deletions packages/base/src/index.d.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ declare module '@metamask/eslint-config' {
* can only be used with the {@link createConfig} function.
*/
type ConfigWithExtends = Config & {
/**
* The configuration(s) to extend. This can be a single configuration, an
* array of configurations, or an array of arrays of configurations.
*/
extends?: Config | Config[] | Config[][];
};

Expand Down
19 changes: 18 additions & 1 deletion packages/base/src/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,24 @@ const rules = createConfig({
'always',
{ tags: { returns: 'never', template: 'always', throws: 'never' } },
],
'jsdoc/require-jsdoc': 'error',
'jsdoc/require-jsdoc': [
'error',
{
require: {
ArrowFunctionExpression: true,
ClassDeclaration: true,
FunctionDeclaration: true,
FunctionExpression: true,
MethodDefinition: true,
},
contexts: [
'TSInterfaceDeclaration',
'TSTypeAliasDeclaration',
'TSEnumDeclaration',
'TSPropertySignature',
],
},
],
'jsdoc/require-param-name': 'error',
'jsdoc/require-param': ['error', { unnamedRootBase: ['options'] }],
'jsdoc/require-param-description': 'error',
Expand Down
Loading