Registry / testing / prettier-plugin-drone-jsdoc

prettier-plugin-drone-jsdoc

library1.8.0jsnpmunverified

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.

testing

npm install prettier-plugin-drone-jsdoc

github ↗package ↗

INSTALL

IMPORT

SIG · PRETTIER-PLUGIN-DR

prettier-plugin-drone-jsdoc

testingjavascriptv1.8.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import plugin from 'prettier-plugin-drone-jsdoc'

✗ const plugin = require('prettier-plugin-drone-jsdoc')

CommonJS require() works as well, but ESM import is recommended for modern projects.

PluginOptions

✓ import type { PluginOptions } from 'prettier-plugin-drone-jsdoc'

TypeScript type export available; use `import type` for type-only imports.

options

✓ import { options } from 'prettier-plugin-drone-jsdoc'; // used within a Prettier config object

✗ const { options } = require('prettier-plugin-drone-jsdoc'); // options is not a function

Export named 'options' is an object, not a function; use as a spread in Prettier config.

Shows minimal Prettier configuration to enable the plugin and customize JSDoc formatting.

// .prettierrc { "plugins": ["prettier-plugin-drone-jsdoc"], "jsdocCommentLineStrategy": "singleLine", "jsdocSeparateReturnsFromParams": true }

Debug

Known issues

benignPlugin modifies the first line of multi-line block comments, which may not be desired for all projects.

fix

Disable the plugin or adjust configuration to preserve original formatting.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'prettier-plugin-drone-jsdoc'

Plugin not installed or not in node_modules.

fix

Install the plugin via npm: 'npm install --save-dev prettier-plugin-drone-jsdoc'

TypeError: plugin is not a function

Incorrectly importing plugin as a function instead of using it in Prettier config.

fix

Add the plugin to the 'plugins' array in .prettierrc instead of calling it directly.

Upgrade

Version history

1.8.0latest on npm

Audit

Dependencies

prettierrequiredpeer dependency required to function as a Prettier plugin

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/BunnyNabbit/prettier-plugin-jsdoc ↗

packagehttps://www.npmjs.com/package/prettier-plugin-drone-jsdoc ↗