hosseinmd / prettier-plugin-jsdoc

A Prettier plugin to format JSDoc comments.
MIT License
232 stars 28 forks source link

chore: export Options to better assist type checking for .prettierrc.js #210

Closed aqzhyi closed 1 year ago

aqzhyi commented 1 year ago

This change enables developers to import the Options type in their .prettierrc.js file to assist them in making type checking on Options.

For example,

// import prettier-plugin-jsdoc Options

/** @type {import('prettier-plugin-jsdoc').Options} } */
const prettierPluginJsdocOptions = {
  jsdocCapitalizeDescription: false,
}

// import prettier Options

/** @type {import('prettier').Options} */
const config = {
  plugins: ['prettier-plugin-jsdoc'],
  ...prettierPluginJsdocOptions,
  singleAttributePerLine: true,
  arrowParens: 'always',
}

CleanShot 2023-10-07 at 12 31 02

hosseinmd commented 1 year ago

Thank you

hosseinmd commented 1 year ago

v1.1.1