Support `eslint-disable-next-line` or `eslint-disable-line`

[gian1200]

Motivation

Support standard ESLint exceptions per line (eslint-disable-next-line and/or eslint-disable-line)

Current behavior

It's only possible to add an exception for the whole file, not for specific lines/comments.

Desired behavior

To be able to skip jsdoc rules validation for specific lines

Alternatives considered

Given jsdoc/reject-any-type rule, I've tried // eslint-disable-next-line jsdoc/reject-any-type and // eslint-disable-line jsdoc/reject-any-type without success.

/**
 * Example JSDOC
 * @param {Response} response Repuesta
// eslint-disable-next-line jsdoc/reject-any-type
 * @returns {Promise<any>|void} Promesa // eslint-disable-line jsdoc/reject-any-type
 */
export const dummy = response => {
	if (response.ok) {
		return response.json();
	}
};

  5:1  warning  Prefer a more specific type to `any`  jsdoc/reject-any-type

Additional information

Related: #658

[brettz9]

These directives are handled by ESLint itself. While you cannot disable individual lines, you can disable the whole block and then reenable after the block, e.g.,

/* eslint-disable jsdoc/reject-any-type */
/**
 * Example JSDOC
 * @param {Response} response Repuesta
 * @returns {any} Promesa
 */
export const dummy = response => {
	/* eslint-enable jsdoc/reject-any-type */
	return response;
};

[gian1200]

Awesome! Ugly workaround, it doesn't handle all scenarios (2 "anys" in same block, where only 1 should be excluded), but it works!

If I understand you correctly, this is a bug (or an edge case) on ESLint, where those "flags" do not work when they are inside a block comment, correct? I'll report it to them.

PS: In my environment, this also works:

/* eslint-disable jsdoc/reject-any-type */
/**
 * Example JSDOC
 * @param {Response} response Repuesta
 * @returns {any} Promesa
 */
/* eslint-enable jsdoc/reject-any-type */
export const dummy = response => {
	return response;
};

[brettz9]

I would be skeptical that ESLint would implement a fix to allow these inside JSDoc block comments. In addition, our comment parser wouldn't really handle parsing line comments inside the block.

One other thing you can do is define a @typedef like so:

/* eslint-disable jsdoc/reject-any-type */
/**
 * @typedef {any} AnyType
 */
/* eslint-enable jsdoc/reject-any-type */

/**
 * Example JSDOC
 * @param {Response} response Repuesta
 * @returns {AnyType} Promesa
 */
export const dummy = response => {
	return response;
};

An advantage of this is that you can also use the name (in this case "AnyType") to indicate why it is set to "any" (e.g., you could call it "BadArgument" if you were deliberately supplying a bad argument in test cases or call it "ArbitraryType" if it truly can be arbitrary).

[gian1200]

Interesting approach. It's an overkill approach for us, but it definitely covers all scenarios (+ makes explicit the usage of any).

In the meantime I opened a discussion on ESLint eslint/eslint#20213

Thanks for your time!