chore: first step towards monorepo #26

crondinini · 2021-11-29T03:21:39Z

Overview

This PR is a first step for the monorepo. It's not the complete setup since it doesn't handle the publishing/building yet, and the hooks folder is just an example but it's possible to develop on the 2 packages separately as of the changes introduced.

I chose to go forward with this despite it being incomplete so we can avoid major conflicts and we can free up people to work on things without the worry of having to solve those git conflicts.

This is what the new folder structure looks like.

├── README.md
├── package.json
├── packages
│   ├── components
│   └── hooks
└── yarn.lock

Changes

Introduced a root package.json, which includes the workspaces reference + scripts necessary
Moved lint staged to the root
Introduced a fake hooks package and used it in the component package as an example
Renamed packages to @web3-ui/components and @web3-ui/hooks
Added the @web3-ui/hooks as a dependency of @web3-ui/components

Missing

Documentation around how to use it (will do it in my next PR)
- You need to run yarn at the root level and it will link both packages
Actually building the packages and publishing flow
Test setup in the root folder (and maybe other root configs too)
Proper setup of the hooks package (I didn't consider it to be in the scope of this PR)

Dhaiwat10 · 2021-11-29T04:31:09Z

Thanks @crondinini, this is such a solid foundation for the project! Everything works perfectly. I am merging this in. If anyone wants to open a discussion regarding the monorepo setup or suggest improvements, please do so in this issue: #27.

etr2460

a few comments, not sure how many should be addressed before merging though, makes sense to iterate and move fast

etr2460 · 2021-11-29T04:26:28Z

package.json

-    "type": "git",
-    "url": "git+https://github.com/Developer-DAO/web3-ui/"
-  },
+  "private": "true",


according to https://docs.npmjs.com/creating-a-package-json-file#required-name-and-version-fields, name and version are required fields in package.json files. maybe we should keep some stuff here still for whatever commands might be run from the root directory

Suggested change

"private": "true",

"name": "@web3-ui/root",

"license": "MIT",

"version": "0.0.0",

"private": "true",

"engines": {

"node": ">=16.0.0",

"yarn": "^1.5"

},

@etr2460 From reading the resource you shared, those are all required for a published package. Since the package is private it won't be published. Would you consider all of that still required?

This is not the final version for the package in any case, but just trying to understand.

packages/components/package.json

etr2460 · 2021-11-29T04:27:28Z

packages/components/package.json

+    "node": ">=16.0.0",
+    "yarn": "^1.5"
+  },
+  "description": "React Typescript Library Boilerplate",


Suggested change

"description": "React Typescript Library Boilerplate",

"description": "React components for web3, built with Chakra-UI",

etr2460 · 2021-11-29T04:29:45Z

packages/components/package.json

+    "type": "git",
+    "url": "git+https://github.com/Developer-DAO/web3-ui/"
+  },
+  "scripts": {


maybe a future question, but do we want these scripts to live at the package level or the root level? I'd be a bit worried that the scripts for each package might diverge, and i'd rather us end up with something like yarn test packages/components at the root instead of cd packages/components && yarn test or yarn workspace @web3-ui/components test. food for thought

I wanted to raise a similar discussion. Chakra has everything in the root folder, so the test and jest config are at the root and the packages only have the test file. So at the root we'd have yarn test and this would run all tests for example.

My comment in the PR description "Test setup in the root folder (and maybe other root configs too)", was referring to those sort of things so I'm 100% with you.

etr2460 · 2021-11-29T04:30:22Z

packages/components/package.json

+    "yarn": "^1.5"
+  },
+  "description": "React Typescript Library Boilerplate",
+  "author": "Dhaiwat Pandya",


should this be Developer DAO? Not sure what you think @Dhaiwat10

Suggested change

"author": "Dhaiwat Pandya",

"author": "Developer DAO",

etr2460 · 2021-11-29T04:30:40Z

packages/hooks/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@web3-ui/hooks",
+  "version": "1.0.0",


Suggested change

"version": "1.0.0",

"version": "0.0.1",

etr2460 · 2021-11-29T04:30:50Z

packages/hooks/package.json

+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",


Suggested change

"license": "ISC",

"license": "MIT",

etr2460 · 2021-11-29T04:31:00Z

packages/hooks/package.json

+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",


Suggested change

"author": "",

"author": "Developer DAO",

etr2460 · 2021-11-29T04:31:14Z

packages/hooks/package.json

+{
+  "name": "@web3-ui/hooks",
+  "version": "1.0.0",
+  "description": "",


Suggested change

"description": "",

"description": "React hooks for web3",

etr2460 · 2021-11-29T04:32:24Z

packages/hooks/package.json

@@ -0,0 +1,19 @@
+{


looks like we're missing a decent amount of properties here that probably should be brought in from the components package.json too

Yep, we are, as I mentioned in the PR description, this was a fake package, a POC of sorts.

"Introduced a fake hooks package and used it in the component package as an example"

crondinini · 2021-11-29T11:38:24Z

Hey @etr2460, I was fast asleep when the comments were made! I see you already addressed some of them, thank you for that.

I think they all make sense, but this PR was more like an iterative step rather than a finished work. If we were working already with already published packages, I would have merged this into a feature branch for example.

crondinini added 8 commits November 28, 2021 20:50

chore: move all files to within packages

9af458d

chore: move package json

fe00aea

chore: set up workspaces with formatting hook

ca4d030

feat: example of web3 hook package

372eb5a

chore: move readme back to root

b6610fe

chore: add scripts to root so actions work

82c1e90

chore: rename components folder

3d7d63a

chore: rename hooks folder

f44367f

crondinini self-assigned this Nov 29, 2021

Dhaiwat10 mentioned this pull request Nov 29, 2021

Monorepo setup discussion #27

Closed

Dhaiwat10 merged commit 86aa5be into Developer-DAO:master Nov 29, 2021

etr2460 reviewed Nov 29, 2021

View reviewed changes

etr2460 mentioned this pull request Nov 29, 2021

Update monorepo package.jsons #28

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: first step towards monorepo #26

chore: first step towards monorepo #26

crondinini commented Nov 29, 2021

Dhaiwat10 commented Nov 29, 2021

etr2460 left a comment

etr2460 Nov 29, 2021

crondinini Nov 29, 2021

etr2460 Nov 29, 2021

etr2460 Nov 29, 2021

crondinini Nov 29, 2021

etr2460 Nov 29, 2021

etr2460 Nov 29, 2021

etr2460 Nov 29, 2021

etr2460 Nov 29, 2021

etr2460 Nov 29, 2021

etr2460 Nov 29, 2021

crondinini Nov 29, 2021

crondinini commented Nov 29, 2021

	"description": "React Typescript Library Boilerplate",
	"description": "React components for web3, built with Chakra-UI",

chore: first step towards monorepo #26

chore: first step towards monorepo #26

Conversation

crondinini commented Nov 29, 2021

Overview

Changes

Missing

Dhaiwat10 commented Nov 29, 2021

etr2460 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crondinini commented Nov 29, 2021