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

Restructure directories and packages #27

Closed
2 of 5 tasks
GewoonMaarten opened this issue Feb 8, 2021 · 1 comment · Fixed by #45
Closed
2 of 5 tasks

Restructure directories and packages #27

GewoonMaarten opened this issue Feb 8, 2021 · 1 comment · Fixed by #45
Assignees
Labels
3 Story points bug Something isn't working high Priority

Comments

@GewoonMaarten
Copy link
Contributor

GewoonMaarten commented Feb 8, 2021

Currently, if you install the root package you'll get all components three times. This is because of the nested package structure we currently have. This is not desirable. In addition, component's .tsx files are provided as is, meaning that the developer who installs the components gets the raw .tsx files. Usually you want to transpile the ts to js and provide a Typescript type file and/or transpile esx to es2017, which 90% of the browser support. This way developers can use both Javascript and Typescript.

Tasks:

  • Flatten the directory structure such that every component is directly in the src/components directory. The group components like surfaces and input can be moved to src/groups (for example) for clarity as their only purpose is to group components.
  • consolidate some components into one package as it makes little sense to use one without the other:
    • Components into tab
      • tab
      • tabcontext
      • tablist
      • tabpanel
      • tabs
      • tabscrollbutton
    • Components into menu
      • menuitem
      • menulist
      • popover
      • popper
    • Components into list
      • listitem
      • listitemavatar
      • listitemicon
      • listitemsecondaryaction
      • listitemtext
      • listsubheader
    • Components into avatar
      • avatargroup
    • Components into card
      • cardactions
      • cardcontent
      • cardheader
      • paper
    • Components into accordion
      • accordionactions
      • accordiondetails
      • accordionsummary
  • Create an index.tsx files when needed.
  • Fix installed package files. TBD
  • Test if components install correctly.
@GewoonMaarten GewoonMaarten added enhancement New feature or request triage Needs to get a priority needs refinement This story needs more information or needs to be scored labels Feb 8, 2021
@GewoonMaarten GewoonMaarten added high Priority and removed triage Needs to get a priority labels Feb 17, 2021
@GewoonMaarten GewoonMaarten changed the title Restructure directory structure Restructure directories and packages Feb 20, 2021
@bddjong bddjong added 3 Story points and removed needs refinement This story needs more information or needs to be scored labels Feb 20, 2021
@bddjong
Copy link
Contributor

bddjong commented Feb 20, 2021

Scoped to only flattening the directory structure

@GewoonMaarten GewoonMaarten added this to Product Backlog in MDH RYSST Sprint 11 via automation Feb 20, 2021
@GewoonMaarten GewoonMaarten added this to the Sprint 6 milestone Feb 20, 2021
@GewoonMaarten GewoonMaarten moved this from Product Backlog to Sprint backlog in MDH RYSST Sprint 11 Feb 20, 2021
@GewoonMaarten GewoonMaarten added bug Something isn't working and removed enhancement New feature or request labels Feb 20, 2021
@GewoonMaarten GewoonMaarten self-assigned this Feb 20, 2021
@GewoonMaarten GewoonMaarten linked a pull request Feb 20, 2021 that will close this issue
@GewoonMaarten GewoonMaarten moved this from Sprint backlog to Review in progress in MDH RYSST Sprint 11 Feb 20, 2021
@GewoonMaarten GewoonMaarten moved this from Review in progress to Reviewer approved in MDH RYSST Sprint 11 Feb 20, 2021
@bddjong bddjong moved this from Reviewer approved to Done in MDH RYSST Sprint 11 Feb 27, 2021
@bddjong bddjong removed this from Released in MDH RYSST Sprint 11 Jun 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 Story points bug Something isn't working high Priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants