Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update eslint configuration and adding comment to all functions which do not have them. #1414

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Update eslint configuration and adding comment to all functions which do not have them. #1414

merged 1 commit into from
Sep 5, 2024

Conversation

brdandu
Copy link
Collaborator

@brdandu brdandu commented Aug 30, 2024

  • Update eslint to throw errors when functions don't have documentation.
  • Ignoring eslint missing comments for spa, generated-html and src-electron/generator/matter
  • Update comments on all the js functions
  • Add eslint to pre-commit hook
  • JIRA: ZAPP-1143

@brdandu brdandu force-pushed the improvement/enforceAPIDocumentationForAllFunctions/ZAPP-1143 branch 3 times, most recently from 18537bc to 1ad1c35 Compare September 4, 2024 19:45
@brdandu
Update eslint configuration and adding comment to all functions which…
d24455f 
… do not have them.

- Update eslint to throw errors when functions don't have documentation.
- Ignoring eslint missing comments for spa, generated-html and src-electron/generator/matter
- Update comments on all the js functions
- Add eslint to pre-commit hook
- Adding api documentation update to pre-commit hook
- Using npx jsdoc2md src-shared/**/*.js src-electron/**/*.js > docs/api.md for api.md update on each commit
- Updating API documentation
- Updating the modules for all files in src-shared and src-electron such that their documentation is generated properly using jsdoc2md
- Adding 2 scripts to generate api documentation  and helper documentation such that users can now have one place to know about every helper available.
- The 2 scripts are called as part of the pre-commit hook and fails if documentation is not added for any function.
- The documentation for api.md and helpers.md is updated as part of the commit using the pre-commit hook
- Clean up all the associated files and functions such that jsdoc2md works efficiently
- Ignoring src directory for eslint
- Updating the README.md with the template helper documentation link
- Adding vue files to the ignore list in eslint
- JIRA: ZAPP-1143

- Adding comments for the one missing file
@brdandu brdandu force-pushed the improvement/enforceAPIDocumentationForAllFunctions/ZAPP-1143 branch from 928a719 to d24455f Compare September 4, 2024 19:59
tecimovic
tecimovic approved these changes Sep 5, 2024
View reviewed changes
Copy link
Collaborator

@tecimovic tecimovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff.

@brdandu brdandu merged commit 6f8c18a into project-chip:master Sep 5, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tecimovic tecimovic tecimovic approved these changes

@paulr34 paulr34 Awaiting requested review from paulr34

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@brdandu @tecimovic