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.

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

feat(build): issues/231 code documentation, linting #232

Merged
merged 1 commit into from
Mar 20, 2020

Conversation

cdcabrera
Copy link
Member

@cdcabrera cdcabrera commented Mar 18, 2020

What's included

  • feat(build): issues/231 code documentation, linting

    • build, apply jsdoc eslint
    • router, expand on missing propTypes
    • i18n, snapshot updated

Notes

  • Behind the scenes update.
  • Apply code annotations.
  • Creating a separate issue to "generate" the documentation.
  • JSDoc annotations are now "linted". Incorrect annotations will be called out. A lack of annotations will be ignored.

How to test

Example

...

Updates issue/story

#231

cdcabrera added a commit to cdcabrera/curiosity-frontend that referenced this pull request Mar 18, 2020
* build, apply jsdoc eslint
* router, expand on missing propTypes
* i18n, snapshot update
cdcabrera added a commit to cdcabrera/curiosity-frontend that referenced this pull request Mar 19, 2020
* build, apply jsdoc eslint
* router, expand on missing propTypes
* i18n, snapshot update
* build, apply jsdoc eslint
* router, expand on missing propTypes
* i18n, snapshot update
@cdcabrera cdcabrera changed the title WIP feat(build): issues/231 code documentation, linting feat(build): issues/231 code documentation, linting Mar 19, 2020
@codecov-io
Copy link

Codecov Report

Merging #232 into ci will not change coverage.
The diff coverage is 99.25%.

Impacted file tree graph

@@           Coverage Diff           @@
##               ci     #232   +/-   ##
=======================================
  Coverage   92.71%   92.71%           
=======================================
  Files          42       42           
  Lines         837      837           
  Branches      207      207           
=======================================
  Hits          776      776           
  Misses         57       57           
  Partials        4        4
Impacted Files Coverage Δ
src/components/messageView/messageView.js 100% <ø> (ø) ⬆️
src/redux/types/userTypes.js 100% <ø> (ø) ⬆️
src/components/chartArea/chartArea.js 90.97% <ø> (ø) ⬆️
src/components/authentication/authentication.js 55.55% <ø> (ø) ⬆️
src/services/rhsmServices.js 100% <ø> (ø) ⬆️
src/redux/types/appTypes.js 100% <ø> (ø) ⬆️
src/components/router/redirect.js 70.58% <ø> (ø) ⬆️
src/components/graphCard/graphCardTypes.js 100% <ø> (ø) ⬆️
src/common/dateHelpers.js 100% <ø> (ø) ⬆️
src/services/platformServices.js 100% <ø> (ø) ⬆️
... and 37 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dab8fb3...762e212. Read the comment docs.

@cdcabrera cdcabrera merged commit bb46552 into RedHatInsights:ci Mar 20, 2020
This was referenced Mar 25, 2020
cdcabrera added a commit that referenced this pull request Apr 2, 2020
* build, apply jsdoc eslint
* router, expand on missing propTypes
* i18n, snapshot update
This was referenced Apr 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants