Skip to content
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

Jump to bottom

Add more precise types in the JSDoc #818

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add more precise types in the JSDoc #818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2570e4e
Add more precise JSDoc for arrays
stof Aug 3, 2020
c5473a9
Add more precise types for arguments forwarded to webpack
stof Aug 3, 2020
28e4634
Add more precise JSDoc for the options callbacks
stof Aug 3, 2020
dfc6c80
Add more precise JSDoc for objects used as maps
stof Aug 3, 2020
e8ac09f
Add more precise JSDoc for Encore options
stof Aug 3, 2020
609fd3d
Migrate to eslint-plugin-jsdoc
stof Dec 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 13 additions & 3 deletions .eslintrc.js
View file
Open in desktop
Expand Up @@ -9,8 +9,8 @@

module.exports = {
"root": true,
"plugins": ["node", "header"],
"extends": ["eslint:recommended", "plugin:node/recommended"],
"plugins": ["node", "header", "jsdoc"],
"extends": ["eslint:recommended", "plugin:node/recommended", "plugin:jsdoc/recommended"],
"env": {
"node": true,
"es6": true,
Expand Down Expand Up @@ -49,7 +49,12 @@ module.exports = {
"after": true
}],
"no-console": "off",
"valid-jsdoc": ["error", { "requireParamDescription": false, "requireReturnDescription": false }],
"jsdoc/require-jsdoc": "off",
"jsdoc/require-param-description": "off",
"jsdoc/require-property-description": "off",
"jsdoc/require-returns-description": "off",
// We use typescript-like literal `false` for some signatures, which is not yet supported natively by eslint-plugin-jsdoc
"jsdoc/no-undefined-types": ["error", { definedTypes: ["false"] }],
"node/no-unsupported-features": ["error", { version: 8 }],
"node/no-deprecated-api": "error",
"node/no-missing-import": "error",
Expand All @@ -66,6 +71,11 @@ module.exports = {
"node/process-exit-as-throw": "error",
"header/header": [2, "block", { "pattern": "This file is part of the Symfony Webpack Encore package" }]
},
"settings": {
"jsdoc": {
"mode": "typescript"
}
},
"overrides": [
{
"files": [".eslintrc.js"],
Expand Down