Simplify monorepo #2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| Status: `Proposal` # Please do not change this. | ||
| Implementer: # It will be changed upon merging and as it moves through the RFC stages | ||
| --- | ||
|
|
||
| # Simplify the monorepo | ||
|
|
||
| ## The issue to be solved | ||
|
|
||
| The tool [lerna](https://lerna.js.org/) we have been using to power the monorepo has become incredibly slow and difficult to deal with. | ||
| We need to simplify the structure to allow us to fix things faster. | ||
|
|
||
| ## A short description of the solution | ||
|
|
||
| I propose we remove lerna, move to [npm workspaces](https://docs.npmjs.com/cli/v8/using-npm/workspaces) | ||
| and de-tangle the reasons the `bootstrap` process is currently so dependent on a very specific order | ||
| at which what dependency has to be installed. | ||
|
|
||
| ## Technical details | ||
|
|
||
| This RFC depends on [Remove pancake #1](https://github.com/designsystemau/RFCs/pull/1). | ||
|
|
||
| Once we have done away with the build of pancake we can de-tangle the install process and since there won't | ||
| be any more `postinstall` scripts per component we will be able to install the dependencies per component | ||
| without having to worry about the order of what is installed when. | ||
|
|
||
| We will still have the test sites we have now running as those do not require any changes and don't depend on anything. | ||
| That means we can leave the testing infrastructure in place which is good. | ||
|
|
||
| It does however also include the inclusion of the below tools: | ||
|
|
||
| - [prettier](https://prettier.io/) | ||
| - [manypkgs](https://github.com/Thinkmill/manypkg) | ||
| - [preconstruct](https://preconstruct.tools/) | ||
| - The docs website | ||
|
|
||
| The docs website will be included into this monorepo so that docs are drawn from the readme of each component. | ||
| That way we won't have to deal duplicating docs in two places. | ||
|
|
||
| This depends on [Docs site improvements #4](https://github.com/designsystemau/RFCs/pull/4). | ||
|
Contributor
|
||
|
|
||
| The structure of the monorepo would look like this then: | ||
|
|
||
| ```sh | ||
| . | ||
| ├── CODE_OF_CONDUCT.md | ||
| ├── CONTRIBUTING.md | ||
| ├── DEVELOPING.md | ||
| ├── LICENSE | ||
| ├── README.md | ||
| ├── SUPPORT.md | ||
| ├── auds.json | ||
| ├── docs | ||
| │ └── ... (the docs site published at https://gold.designsystemau.org) | ||
| ├── package-lock.json | ||
| ├── package.json | ||
| └── packages | ||
| └── ... (a directory per component) | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Turborepo could replace npm + preconstruct, or Parcel 2 which might be a lighter touch here.