CareEvolution / MyDataHelpsUI

MyDataHelps UI React Component Library
MIT License
1 stars 2 forks source link

Reduce rollup script noise - remove ComponentMeta use in views. #360

Closed reneefromhold closed 1 week ago

reneefromhold commented 2 weeks ago

Overview

Running npm run rollup locally results in a lot of noise/warnings that make it more time consuming to determine if a change has broken the build.

This is the first step at cutting back the noise starting with out of the box views.

A description for the view was added as part of the update. This description will show as part of the component's default story.

Security

REMINDER: All file contents are public.

Describe briefly what security risks you considered, why they don't apply, or how they've been mitigated.

Checklist

Testing

Documentation

Consider "Squash and merge" as needed to keep the commit history reasonable on main.

Reviewers

Assign to the appropriate reviewer(s). Minimally, a second set of eyes is needed ensure no non-public information is published. Consider also including:

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve updates to multiple Storybook stories and component files across various views. Key modifications include restructuring story exports to utilize a meta object, introducing a render function for consistent layout presentation, and adding JSDoc comments for improved documentation. Function signatures have been explicitly named for clarity. The internal logic of the components remains unchanged, ensuring that their functionality is preserved while enhancing the organization and clarity of the codebase.

Changes

File Path Change Summary
src/components/view/ConnectEhrView/ConnectEhrView.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, refactored story templates to use a render function, and updated story exports.
src/components/view/ConnectEhrView/ConnectEhrView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/DeviceDataView/DeviceDataView.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, replaced Template function with a render function, and updated story exports.
src/components/view/DeviceDataView/DeviceDataView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/EhrNewsFeedView/EhrNewsFeedView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/ExternalAccountsView/ExternalAccountsView.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, replaced Template function with a render function, and updated story exports.
src/components/view/ExternalAccountsView/ExternalAccountsView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/FitbitView/FitbitView.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, replaced Template function with a render function, and updated story exports.
src/components/view/FitbitView/FitbitView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/GarminView/GarminView.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, replaced Template function with a render function, and updated story exports.
src/components/view/GarminView/GarminView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/HealthAndWellnessView/HealthAndWellnessView.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, replaced Template function with a render function, and updated story exports.
src/components/view/HealthAndWellnessView/HealthAndWellnessView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/HomeView/HomeView.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, replaced Template function with a render function, and updated story exports.
src/components/view/HomeView/HomeView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/NotificationsView/NotificationsView.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, replaced Template function with a render function, and added new story exports.
src/components/view/NotificationsView/NotificationsView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/SurveyTasksView/SurveyTasksView.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, replaced Template function with a render function, and updated story exports.
src/components/view/SurveyTasksView/SurveyTasksView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/AllergiesView/AllergiesView.tsx Changed function signature to a named export and added JSDoc comment.
src/components/view/NewPointsView/NewPointsView.tsx Changed function signature to a named export, added JSDoc comment, and made minor formatting changes.
tsconfig.json Added compiler options and an include section to specify files for compilation.
src/components/step/StepNextButton/StepNextButton.stories.tsx Updated imports, restructured default export to a meta object, added type declarations, replaced Template function with a render function, and updated story exports.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` or `@coderabbitai title` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.