Indentation after an decorator in an example

[Ulrikop]

Expected behavior

Examples that use a decorator allow additional indentation, such as an example without a decorator.

Actual behavior

An example that has an additional indentation on a new line after a decorator throws There must be no indentation.

ESLint Config

{
  "env": {
    "es6": true
  },
  "parser": "@typescript-eslint/parser",
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/check-indentation": "error"
  }
}

ESLint sample

/**
 * @example 
 * ```
 * @MyDecorator({
 *   myOptions: 42
 * })
 * export class MyClass {}
 * ```
 *
 * @example 
 * ```
 * MyDecorator({
 *   myOptions: 42
 * })
 * ```
 */
function MyDecorator(options: { myOptions: number }) {
  return (Base: Function) => {};
}

First @example throw There must be no indentation, the second @example is fine.

Environment

• Node version: 12.18.4
• ESLint version 7.32.0
• eslint-plugin-jsdoc version: 36.1.0
• @typescript-eslint/parser version: 4.33.0

[gajus]

🎉 This issue has been resolved in version 36.1.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[Ulrikop]

Thx for your quick help @brettz9
It looks like it works like a charm, Because of your \s in the regex @\w+\s it also works for decorators without params:

/**
 * @example 
 * ```
 * @MyDecorator
 * export class MyClass {}
 * ```
 */
function MyDecorator(Base: Function) {
}

perhaps a good scenario for the tests to avoid that it will break in a future refactoring?

but I've seen a case where there is a difference between example with decorator and without decorator:

/**
 * @example ```
 * @MyDecorator({
 *   myOptions: 42
 * })
 * export class MyClass {}
 * ```
 * 
 * @example ```
 * MyDecorator({
 *   myOptions: 42
 * })
 * ```
 */
function MyDecorator(options: { myOptions: number }) {
  return (Base: Function) => {};
}

first @example still throws an error, second, it doesn't.
It is ok for me, because we always add the beginning ``` to the next line, but I just wanted to give you the feedback. 👍

[brettz9]

Thanks for the info. Am preoccupied now but hope to take a look within a couple weeks.

[gajus]

🎉 This issue has been resolved in version 37.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[brettz9]

@Ulrikop : Sorry it took longer than expected for me to get to it, but the other @example variety is now fixed too. (v37.1.0)