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: Directory based components and widgets #390

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

C-Valen
Copy link
Member

@C-Valen C-Valen commented Aug 27, 2024

Chore - Directory based components and widgets

Checklist:

  • Commits consolidated
  • [N/A] Changelog updated
  • Test cases added/updated
  • [N/A] Jira ticket updated

Summary:

As discussed in internal team calls this PR converts @/components and @/widgets into to directory based vue components.
This allows to break down large components in smaller parts providing more flexibility and an easier maintainability, aiming to adopt an atomic component design pattern.

Changes:

  • Use directories for components under @/components and @/widgets
  • Relocate @/widgets to /src
  • Changes replace aliases on vite config to array format
  • Removes WidgetTestView
  • Updates snapshots

Considerations:

  • This PR only provides the initial structure for directory based components, it will be required to refactor and adapt individual components that can benefit from this new format.
  • widgets directory made sense to me to be relocated at ./src to be at same level as views and components

@C-Valen C-Valen added the internal Skip Jira CI label Aug 27, 2024
@C-Valen C-Valen self-assigned this Aug 27, 2024
@C-Valen C-Valen force-pushed the chore/directory-based-components-preparation branch 2 times, most recently from 93c3e35 to 3d03e7c Compare September 2, 2024 09:23
@C-Valen
Copy link
Member Author

C-Valen commented Sep 2, 2024

Update: Use named component index templates.

.eslintrc.json Outdated
@@ -76,7 +76,7 @@
"vue/multi-word-component-names": [
"error",
{
"ignores": ["Modal", "Tabs", "Toast", "Login", "Navbar", "Settings"]
"ignores": ["Modal", "Tabs", "Toast", "Login", "Navbar", "Settings", "index"]
Copy link
Member

Choose a reason for hiding this comment

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

Is this change needed?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not really, it was for previous approach but is not required now.

@C-Valen C-Valen force-pushed the chore/directory-based-components-preparation branch from 3d03e7c to bd230c7 Compare September 9, 2024 12:37
@C-Valen C-Valen force-pushed the chore/directory-based-components-preparation branch 2 times, most recently from 077d159 to 0a6235c Compare September 11, 2024 13:10
@C-Valen C-Valen force-pushed the chore/directory-based-components-preparation branch from 0a6235c to ab4acda Compare September 11, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Skip Jira CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants