{"id":20351,"library":"prettier-plugin-drone-jsdoc","title":"prettier-plugin-drone-jsdoc","description":"A Prettier plugin for formatting JSDoc comments, forked from prettier-plugin-jsdoc. Current stable version is 1.8.0, updated regularly. Key differentiator: removes leading whitespace on the first line of multi-line block comments, aligning with the Drone style guide. Requires Prettier ^3.0.0, supports Node >=14.13.1 or >=16.0.0, and ships TypeScript type declarations.","status":"active","version":"1.8.0","language":"javascript","source_language":"en","source_url":"https://github.com/BunnyNabbit/prettier-plugin-jsdoc","tags":["javascript","typescript"],"install":[{"cmd":"npm install prettier-plugin-drone-jsdoc","lang":"bash","label":"npm"},{"cmd":"yarn add prettier-plugin-drone-jsdoc","lang":"bash","label":"yarn"},{"cmd":"pnpm add prettier-plugin-drone-jsdoc","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency required to function as a Prettier plugin","package":"prettier","optional":false}],"imports":[{"note":"CommonJS require() works as well, but ESM import is recommended for modern projects.","wrong":"const plugin = require('prettier-plugin-drone-jsdoc')","symbol":"default","correct":"import plugin from 'prettier-plugin-drone-jsdoc'"},{"note":"TypeScript type export available; use `import type` for type-only imports.","wrong":null,"symbol":"PluginOptions","correct":"import type { PluginOptions } from 'prettier-plugin-drone-jsdoc'"},{"note":"Export named 'options' is an object, not a function; use as a spread in Prettier config.","wrong":"const { options } = require('prettier-plugin-drone-jsdoc'); // options is not a function","symbol":"options","correct":"import { options } from 'prettier-plugin-drone-jsdoc'; // used within a Prettier config object"}],"quickstart":{"code":"// .prettierrc\n{\n  \"plugins\": [\"prettier-plugin-drone-jsdoc\"],\n  \"jsdocCommentLineStrategy\": \"singleLine\",\n  \"jsdocSeparateReturnsFromParams\": true\n}","lang":"javascript","description":"Shows minimal Prettier configuration to enable the plugin and customize JSDoc formatting."},"warnings":[{"fix":"Disable the plugin or adjust configuration to preserve original formatting.","message":"Plugin modifies the first line of multi-line block comments, which may not be desired for all projects.","severity":"benign","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Install the plugin via npm: 'npm install --save-dev prettier-plugin-drone-jsdoc'","cause":"Plugin not installed or not in node_modules.","error":"Error: Cannot find module 'prettier-plugin-drone-jsdoc'"},{"fix":"Add the plugin to the 'plugins' array in .prettierrc instead of calling it directly.","cause":"Incorrectly importing plugin as a function instead of using it in Prettier config.","error":"TypeError: plugin is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}