dprint-plugin-typescript icon indicating copy to clipboard operation
dprint-plugin-typescript copied to clipboard

Published 20 hours ago • verified publisher icon dprint

Format jsdocs

Open dsherret opened this issue 5 years ago • 3 comments

JSDocs should be formatted.

  • [ ] Configuration to force single line JS docs when able (default).

dsherret avatar Jul 31 '19 00:07 dsherret

Is anyone working on this already?

KnorpelSenf avatar Jan 03 '22 16:01 KnorpelSenf

There is prettier-plugin-jsdoc. I requested it in https://github.com/dprint/dprint-plugin-prettier/issues/21 In the meantime, it should be possible to configure dprint to use that plugin for formatting tsdoc and jsdoc.

https://www.npmjs.com/package/prettier-plugin-jsdoc https://github.com/hosseinmd/prettier-plugin-jsdoc

aminya avatar May 14 '22 04:05 aminya

We already have a plugin to format TS and a plugin to format markdown. We are able to format TS inside markdown.

What needs to be done to format markdown inside TS comments? I'm especially interested in formatting TS inside code examples inside markdown inside TS comments. This basically means that we can recurse mutually between TS and markdown.

What is necessary for this to be implemented? From a naïve standpoint it looks like we just need to stitch a few things together, but I'm sure that it's more complex in reality?

KnorpelSenf avatar Nov 04 '23 22:11 KnorpelSenf