You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+3-25
Original file line number
Diff line number
Diff line change
@@ -34,23 +34,6 @@ project.
34
34
- Having a unified set of developer tooling (linting rules, deployment automation, etc.) also improves developer QoL and code reliability.
35
35
36
36
37
-
## TODO:
38
-
This is still a work in progress. Before we're ready to release,
39
-
the following need to be resolved
40
-
41
-
-[x] Setup the readme for how to install, build, manage workspaces, etc.
42
-
-[ ] Setup global pre-commit hooks for linting and type checks
43
-
-[x] Setup with all latest versions of repos with typescript
44
-
-[x] Coordinate/centralize engines and npmrcs
45
-
-[ ] Setup automation: changeset, CI, release process, etc.
46
-
-[x] Finish cleanup of old build related dependencies
47
-
-[ ] Lock in old repos and deploy first versions of @caravan packages
48
-
-[x] Get prettier auto formatting working
49
-
-[x] Make sure all tests pass
50
-
-[x] Improve sharing of configs for jest, tsconfig, and eslint
51
-
-[ ] Cleanup package.jsons
52
-
-[ ] Setup documentation generation
53
-
54
37
## Developers
55
38
The monorepo setup should make it easier for developers to test their changes
56
39
in a more realistic environment, especially when making changes to libraries
@@ -115,7 +98,7 @@ Note:
115
98
> After you've declared a task in turbo.json, it's up to you to implement it in your package.json manifests. You can add scripts all at once, or one workspace at a time. Turborepo will gracefully skip workspaces that don't include the task in their respective package.json manifest.
116
99
117
100
The main scripts to be run are defined in this config file:
118
-
build, lint, test, and dev.
101
+
`build`, `lint`, `test`, and `dev`.
119
102
120
103
## Development
121
104
One of the main benefits of a monorepo for this type of project is
@@ -152,7 +135,6 @@ and write a fully functioning package yourself.
152
135
#### Manually adding a new package
153
136
`packages/caravan-psbt` is a good starting point for a simple package.
154
137
155
-
#### Example Walk-thru
156
138
Let's make a package `@caravan/clients`. This is code that's being added
157
139
to caravan in [this PR](https://github.com/unchained-capital/caravan/pull/365)
158
140
but would be a good candidate for a standalone package.
@@ -204,15 +186,13 @@ This will initialize a package.json for you. But we want to add a few more field
204
186
}
205
187
```
206
188
207
-
**TODO:** probably need to cleanup the @caravan/eslint-config and maybe tsconfig
208
-
209
189
- Install some more dependencies (from package dir):
210
190
```shell
211
191
$ npm install --save-dev typescript tsup eslint jest ts-jest
212
192
```
213
193
214
-
(alternatively can use the `--scope` arg to target the package from
215
-
the root)
194
+
(alternatively can use the `--scope` arg to target the package from the root)
0 commit comments