Prettier plugin for autoformatting
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
In the past I've used:
- https://github.com/homer0/packages/tree/main/packages/public/prettier-plugin-jsdoc
- https://github.com/hosseinmd/prettier-plugin-jsdoc
But neither have good support for TSDoc.
The primary features I am after in such a plugin are:
- Auto-format code blocks. This is a massive time saver. It is not practical to do without (at scale).
- Auto-format general lines. So I can just start writing text and get food line length enforcement.
And then sure all the other details like adjacent empty lines and so on.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No implementation files or tests are named. Start by reviewing the TSDoc format and the two referenced plugin examples; done should include autoformatted code blocks, line-length handling for general text, and appropriate spacing such as adjacent empty lines.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100