Skip to content

Require documentation for exported variables #437

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
mcmire wants to merge 1 commit into
base: loosen-jsdoc-rules
Choose a base branch
from
+5 −1
Draft

Require documentation for exported variables #437

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
3 changes: 2 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 @@ -186,7 +186,8 @@
},
"contexts": [
":not(Property, NewExpression, CallExpression) > ArrowFunctionExpression",
":not(Property, NewExpression, CallExpression) > FunctionExpression"
":not(Property, NewExpression, CallExpression) > FunctionExpression",
"ExportNamedDeclaration:has(> VariableDeclaration)"
]
}
],
Expand Down
2 changes: 2 additions & 0 deletions packages/base/src/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,8 @@ const rules = createConfig({
// Function expressions that are not contained within plain objects
// or are not arguments to functions or methods
':not(Property, NewExpression, CallExpression) > FunctionExpression',
// Exported variables
'ExportNamedDeclaration:has(> VariableDeclaration)',
],
},
],
Expand Down
1 change: 1 addition & 0 deletions packages/typescript/rules-snapshot.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@
"contexts": [
":not(Property, NewExpression, CallExpression) > ArrowFunctionExpression",
":not(Property, NewExpression, CallExpression) > FunctionExpression",
"ExportNamedDeclaration:has(> VariableDeclaration)",
":not(TSModuleBlock) > TSInterfaceDeclaration",
":not(TSModuleBlock) > TSTypeAliasDeclaration",
"TSEnumDeclaration"
Expand Down
Loading