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

feat: bump jsdoccomment, devDeps. #1168

Merged
merged 5 commits into from
Nov 10, 2023
Merged

feat: bump jsdoccomment, devDeps. #1168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5020ece
chore: update comment-parser and devDeps.
brettz9 Oct 26, 2023
1be3f7e
docs(`require-param`): method example
brettz9 Oct 30, 2023
d47b820
chore: update devDep. and lint
brettz9 Oct 30, 2023
9b1a7c1
chore: update devDeps
brettz9 Nov 6, 2023
66a430c
feat: bump jsdoccomment, devDeps.; fixes #1167
brettz9 Nov 10, 2023
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
23 changes: 23 additions & 0 deletions docs/rules/require-description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,29 @@ class quux {
// Settings: {"jsdoc":{"implementsReplacesDocs":false}}
// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[tag=\"implements\"])","context":"any"}],"descriptionStyle":"tag"}]
// Message: Missing JSDoc @description declaration.

app.use(
/** @type {express.ErrorRequestHandler} */
(err, req, res, next) => {
// foo
}
);
// Message: Missing JSDoc block description.

app.use(
/** @type {express.ErrorRequestHandler} */
(
(err, req, res, next) => {
// foo
}
)
);
// Message: Missing JSDoc block description.

/** @type {TreeViewItemData[]} */
this.treeViewSelection = [];
// "jsdoc/require-description": ["error"|"warn", {"contexts":["AssignmentExpression"]}]
// Message: Missing JSDoc block description.
````


Expand Down
16 changes: 16 additions & 0 deletions docs/rules/require-param.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1143,6 +1143,22 @@ function foo(a, b, c) {}
export function myPublicFunction(foo: number, bar: number, baz: number) {}
// "jsdoc/require-param": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag[tag=\"param\"])","context":"FunctionDeclaration"}]}]
// Message: Missing JSDoc @param "baz" declaration.

/**
* [A description]
*/
class A {
/**
* openConfirmModal
* @memberof CreateEditTestWizardComponent
*/
public openConfirmModal(btnState: string) {
this.modalBtnState = btnState;
this.openModal();
}
}
// "jsdoc/require-param": ["error"|"warn", {"contexts":["MethodDefinition"]}]
// Message: Missing JSDoc @param "btnState" declaration.
````


Expand Down
50 changes: 25 additions & 25 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
"url": "http://gajus.com"
},
"dependencies": {
"@es-joy/jsdoccomment": "~0.40.1",
"@es-joy/jsdoccomment": "~0.41.0",
"are-docs-informative": "^0.0.2",
"comment-parser": "1.4.0",
"comment-parser": "1.4.1",
"debug": "^4.3.4",
"escape-string-regexp": "^4.0.0",
"esquery": "^1.5.0",
Expand All @@ -18,52 +18,52 @@
"description": "JSDoc linting rules for ESLint.",
"devDependencies": {
"@babel/cli": "^7.23.0",
"@babel/core": "^7.23.2",
"@babel/eslint-parser": "^7.22.15",
"@babel/core": "^7.23.3",
"@babel/eslint-parser": "^7.23.3",
"@babel/node": "^7.22.19",
"@babel/plugin-syntax-class-properties": "^7.12.13",
"@babel/plugin-transform-flow-strip-types": "^7.22.5",
"@babel/preset-env": "^7.23.2",
"@babel/plugin-transform-flow-strip-types": "^7.23.3",
"@babel/preset-env": "^7.23.3",
"@babel/register": "^7.22.15",
"@es-joy/escodegen": "^3.5.1",
"@es-joy/jsdoc-eslint-parser": "^0.19.0",
"@hkdobrev/run-if-changed": "^0.3.1",
"@semantic-release/commit-analyzer": "^11.0.0",
"@semantic-release/github": "^9.2.1",
"@semantic-release/npm": "^11.0.0",
"@types/chai": "^4.3.9",
"@types/debug": "^4.1.10",
"@types/eslint": "^8.44.6",
"@types/esquery": "^1.5.2",
"@types/estree": "^1.0.3",
"@types/json-schema": "^7.0.14",
"@types/lodash.defaultsdeep": "^4.6.8",
"@types/mocha": "^10.0.3",
"@types/node": "^20.8.7",
"@types/semver": "^7.5.4",
"@types/spdx-expression-parse": "^3.0.4",
"@typescript-eslint/parser": "^6.8.0",
"@semantic-release/commit-analyzer": "^11.1.0",
"@semantic-release/github": "^9.2.3",
"@semantic-release/npm": "^11.0.1",
"@types/chai": "^4.3.10",
"@types/debug": "^4.1.12",
"@types/eslint": "^8.44.7",
"@types/esquery": "^1.5.3",
"@types/estree": "^1.0.5",
"@types/json-schema": "^7.0.15",
"@types/lodash.defaultsdeep": "^4.6.9",
"@types/mocha": "^10.0.4",
"@types/node": "^20.9.0",
"@types/semver": "^7.5.5",
"@types/spdx-expression-parse": "^3.0.5",
"@typescript-eslint/parser": "^6.10.0",
"babel-plugin-add-module-exports": "^1.0.4",
"babel-plugin-istanbul": "^6.1.1",
"camelcase": "^6.3.0",
"chai": "^4.3.10",
"cross-env": "^7.0.3",
"decamelize": "^5.0.1",
"eslint": "8.51.0",
"eslint-config-canonical": "~42.0.1",
"eslint": "8.53.0",
"eslint-config-canonical": "~42.3.0",
"espree": "^9.6.1",
"gitdown": "^3.1.5",
"glob": "^10.3.10",
"husky": "^8.0.3",
"jsdoc-type-pratt-parser": "^4.0.0",
"json-schema": "^0.4.0",
"lint-staged": "^15.0.1",
"lint-staged": "^15.0.2",
"lodash.defaultsdeep": "^4.6.1",
"mocha": "^10.2.0",
"nyc": "^15.1.0",
"open-editor": "^3.0.0",
"rimraf": "^5.0.5",
"semantic-release": "^22.0.5",
"semantic-release": "^22.0.7",
"typescript": "5.2.2"
},
"engines": {
Expand Down
Loading
Loading