LivelyKernel / LivelyKernel/lively.next
Uniform Formatting of DocStrings
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 90
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
Our Linter is quite good at enforcing a uniform code style. However, this does not (or very rudimentary) apply to DocStrings.
I propose the following:
- Use https://eslint.org/docs/latest/rules/max-len to generally enforce a maximum line length. Our code is quite good in that regard, but for comments this would be useful.
- Set up https://github.com/gajus/eslint-plugin-jsdoc to take care of the rest.
I think, that with the ESLint-JSDoc-Plugin and a dry run with require-jsdoc enabled inside of a GitHub Action we can also get a good approximation on the status of our documentation with regards to completeness.
@merryman thoughts? What line-length would you propose? A lot of people use 80, that might be a bit aggressive, I propose 100? :D
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
No files are named. Start by locating the repository's ESLint configuration and GitHub Actions workflows, then review how comments and DocStrings are currently linted. Compare the proposed max-len and eslint-plugin-jsdoc setup, including require-jsdoc in a dry run; done means the chosen rules run in CI without unexpectedly failing existing code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, github-actions, javascript
- Domain
- ci-cd, documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100