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

chore: restructuring design system react component code into folders #114

Merged
merged 3 commits into from
Nov 15, 2024

Conversation

georgewrmarshall
Copy link
Contributor

@georgewrmarshall georgewrmarshall commented Nov 14, 2024

Description

This PR restructures the existing example components within the design-system-react package by moving them into individual component folders. This organization update aims to prepare for the addition of Text and other new components, promoting better organization and modularity within the component library. This change facilitates easier navigation and scalability as new components are added.

Related Issues

Fixes: N/A

Manual Testing Steps

  1. Run storybook locally yarn storybook
  2. Confirm that each component still renders correctly without any errors.
  3. Run yarn build ensure that components are still built

Screenshots/Recordings

Before

before720.mov

After

after720.mov

Pre-merge Author Checklist

Pre-merge Reviewer Checklist

  • Manually tested the PR by pulling and building the branch, running the app, and confirming the functionality of all updated components.
  • Verified that this PR addresses all outlined acceptance criteria and includes necessary evidence (screenshots/recordings if applicable).

@georgewrmarshall georgewrmarshall self-assigned this Nov 14, 2024
@georgewrmarshall georgewrmarshall marked this pull request as ready for review November 14, 2024 21:54
@georgewrmarshall georgewrmarshall requested a review from a team as a code owner November 14, 2024 21:54
@@ -14,6 +14,9 @@ module.exports = merge(baseConfig, {
// The display name when running multiple projects
displayName,

// Add coverage ignore patterns
coveragePathIgnorePatterns: ['/node_modules/', 'index.ts'],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ignoring index files from testing coverage

@@ -14,6 +14,9 @@ module.exports = merge(baseConfig, {
// The display name when running multiple projects
displayName,

// Add coverage ignore patterns
coveragePathIgnorePatterns: ['index.ts'],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ignoring index files from test coverage as they only re-export components. We could add tests for these in the future, but will ignore them for now.

@@ -0,0 +1,2 @@
export { Button } from './Button';
export type { ButtonProps } from './Button';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding index file for Button

export type { TextProps } from './text';

export { Button } from './button';
export type { ButtonProps } from './button';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding root index file in components folder

@@ -0,0 +1,2 @@
export { Text, TextVariant } from './Text';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Exporting Text and Text types

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removing unnecessary index test file as we are now ignoring index files from testing coverage

@georgewrmarshall georgewrmarshall merged commit 74e8e05 into main Nov 15, 2024
26 checks passed
@georgewrmarshall georgewrmarshall deleted the part/react-text-1 branch November 15, 2024 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants