Skip to content

Commit

Permalink
chore: disable jsdoc/no-defaults & jsdoc/check-line-alignment
Browse files Browse the repository at this point in the history
the jsdoc/no-defaults rule is not compatible with the way we use
JSDoc comments.
  • Loading branch information
aladdin-add committed Jun 20, 2023
1 parent ea4575c commit 376dac4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
3 changes: 1 addition & 2 deletions lib/rule-tester/flat-rule-tester.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const { ConfigArraySymbol } = require("@humanwhocodes/config-array");
/** @typedef {import("../shared/types").Parser} Parser */
/** @typedef {import("../shared/types").LanguageOptions} LanguageOptions */

/* eslint-disable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */

/**
* A test case that is expected to pass lint.
* @typedef {Object} ValidTestCase
Expand Down Expand Up @@ -72,7 +72,6 @@ const { ConfigArraySymbol } = require("@humanwhocodes/config-array");
* @property {number} [endLine] The 1-based line number of the reported end location.
* @property {number} [endColumn] The 1-based column number of the reported end location.
*/
/* eslint-enable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */

//------------------------------------------------------------------------------
// Private Members
Expand Down
3 changes: 1 addition & 2 deletions lib/rule-tester/rule-tester.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const { SourceCode } = require("../source-code");

/** @typedef {import("../shared/types").Parser} Parser */

/* eslint-disable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */

/**
* A test case that is expected to pass lint.
* @typedef {Object} ValidTestCase
Expand Down Expand Up @@ -108,7 +108,6 @@ const { SourceCode } = require("../source-code");
* @property {number} [endLine] The 1-based line number of the reported end location.
* @property {number} [endColumn] The 1-based column number of the reported end location.
*/
/* eslint-enable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */

//------------------------------------------------------------------------------
// Private Members
Expand Down
3 changes: 2 additions & 1 deletion packages/eslint-config-eslint/default.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,13 @@ rules:
# jsdoc: adopt non-recommended rules or change recommended configuration
# jsdoc/check-examples: "error"
# jsdoc/check-indentation: "error" # Revisit if allowing configurable spaces after tag line breaks
jsdoc/check-line-alignment: ["error", "never"]
# jsdoc/check-line-alignment: ["error", "never"]
jsdoc/check-syntax: "error"
# jsdoc/check-types': ["error', { exemptTagContexts: [ { tag: "typedef", types: ["object", "GenericObject"] } ] }

jsdoc/check-values: ["error", { allowedLicenses: true }]
jsdoc/no-bad-blocks: "error"
jsdoc/no-defaults: "off"
jsdoc/require-asterisk-prefix: "error"
jsdoc/require-description: ["error", { checkConstructors: false }]
# jsdoc/require-file-overview: "error"
Expand Down

0 comments on commit 376dac4

Please sign in to comment.