parse-community / parse-community/parse-server
Add prettier for JSDoc
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 21.4k
- Forks
- 4.8k
- Avg merge
- 7h 45m
- Merged PRs (30d)
- 11
Description
New Feature / Enhancement Checklist
- I am not disclosing a vulnerability.
- I am not just asking a question.
- I have searched through existing issues.
Current Limitation
Currently, prettier is not applied to JSDoc comments.
Feature / Enhancement Description
Add prettier for JSDoc comments. We need to make sure it doesn't break anything though, because some comments may have a distinct style for interpretation such as the options builder.
Example Use Case
n/a
Alternatives / Workarounds
Keep the current mix of comment styles.
3rd Party References
n/a
Contributor guide
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
Inspect the repository's existing Prettier setup and JSDoc comments, paying particular attention to the options builder mentioned in the issue. Verify the formatter's behavior on representative comments and run the existing checks; done means JSDoc is formatted without breaking comments whose style affects interpretation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100