Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

unexpected new line has been added within example

See original GitHub issue

reproduce:

npm i prettier-plugin-jsdoc@latest
VScode reload window
write some code

/**
 * ABCCCC
 *
 * @example <caption>DDDD</caption>
 *
 *   const MyHook = () => {
 *     const config useConfig(state => state.config)
 *     return <span></span>
 *   }
 *
 *   const useMyHook = () => {
 *     const config useConfig(state => state.config)
 *     return config
 *   }
 *
 * @example <caption>AAAA</caption>
 *   const config = useConfig.getState().config
 */

save
it’s become

/**
 * ABCCCC
 *
 * @example <caption>DDDD</caption>
 *
 *                                                    <------here, a new line has been added
 *   const MyHook = () => {
 *   const config useConfig(state => state.config)
 *   return <span></span>
 *   }
 *
 *   const useMyHook = () => {
 *   const config useConfig(state => state.config)
 *   return config
 *   }
 *
 * @example <caption>AAAA</caption>
 *   const config = useConfig.getState().config
 */

video

context

node -v v14.16.0
.prettierrc.js

// @ts-check

/**
 * @type{{ overrides: { files: string | string[], options: import('prettier').Options }[] }}
 */
const overrides = {
  overrides: [
    {
      files: '*.js',
      options: {
        parser: 'babel',
        printWidth: 100,
      },
    },
    {
      files: ['*.json', '.*rc'],
      options: {
        parser: 'json',
        printWidth: 100,
      },
    },
    {
      files: '*.vue',
      options: {
        parser: 'vue',
        printWidth: 100,
      },
    },
    {
      files: '*.htmlx',
      options: {
        htmlWhitespaceSensitivity: 'strict',
        parser: 'html',
        printWidth: 100,
      },
    },
    {
      files: '*.scss',
      options: {
        parser: 'scss',
        printWidth: 100,
      },
    },
  ],
}

/**
 * @type{import('prettier').Options}
 */
const config = {
  arrowParens: 'avoid',
  bracketSpacing: true,
  insertPragma: false,
  jsxBracketSameLine: false,
  jsxSingleQuote: true,
  parser: 'typescript',
  proseWrap: 'preserve',
  requirePragma: false,
  semi: false,
  singleQuote: true,
  tabWidth: 2,
  trailingComma: 'all',
  useTabs: false,
  printWidth: 100,
}

module.exports = { ...config, ...overrides }