Skip to content
代码片段 群组 项目
  • Bharat Raju's avatar
    6f8c18a9
    Update eslint configuration and adding comment to all functions which do not have them. (#1414) · 6f8c18a9
    Bharat Raju 创作于
    - 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
    Update eslint configuration and adding comment to all functions which do not have them. (#1414)
    Bharat Raju 创作于
    - 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
代码所有者
将用户和群组指定为特定文件更改的核准人。 了解更多。