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.

Sign up for GitHub

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

Separate framework entry points #3

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+36 −0
Open

Separate framework entry points #3

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
21f79b0
Added RFC for separating framework entry points
dominikwilkowski Aug 13, 2021
752e816
Merge branch 'main' into separate-components
dominikwilkowski Aug 13, 2021
ed21618
finished RFC
dominikwilkowski Dec 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions RFC-by-stage/1-approved/separate-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
Status: `Proposal` # Please do not change this.
Implementer: # It will be changed upon merging and as it moves through the RFC stages
---

# Separate components between React, jQuery and Vanilla

## The issue to be solved

We currently share a lot of code between the vanilla, jQuery and React components.
This has led to a bunch of issues including the fact that we're not using each framework to its fullest potential.

## A short description of the solution

I propose we create separate entry-points for each language and maintain a separation for the JavaScript used in each.
We should still re-use the same CSS though or aim to at least use the same token base (which isn't insufficiently separated yet either).

## Technical details

The implementation would be split in separate entry points.
So inside the monorepo we would have a structure like this:

```sh
.
└── packages
├── react
Copy link
Contributor

Choose a reason for hiding this comment

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

rather than packages/buttons/react ? in your example, are you proposing new npm names?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not set on the naming. I proposed this structure because it would make dependency management across the same architecture easier. I would assume with what I propose you would only ever use the react entry point for npm which would remain unchanged. Vanilla or jquery does not use need npm packages and does not have them now.

│ └── ... (a folder per component that is supported in react)
├── jquery
│ └── ... (a folder per component that is supported in jquery)
└── vanilla
└── ... (a folder per component that is supported in vanilla)
```

This will make it easier to make changes to each entry-point.

we will work to re-use the tokens wherever we can and since the workspaces are visible to each other this should be simple enough.