Skip to content

Commit 3e30013

Browse files
committed
changesets config and some cleanup
1 parent 36bbb28 commit 3e30013

File tree

5 files changed

+335
-71
lines changed

5 files changed

+335
-71
lines changed

.changeset/config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
3-
"changelog": "@changesets/cli/changelog",
3+
"changelog": ["@changesets/changelog-github", {"repo": "caravan-bitcoin/caravan"}],
44
"commit": false,
55
"fixed": [],
66
"linked": [],

.eslintrc.js

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
// This configuration only applies to the package manager root.
22
/** @type {import("eslint").Linter.Config} */
33
module.exports = {
4-
// ignorePatterns: ["apps/**", "packages/**"],
54
extends: ["@caravan/eslint-config/library.js"],
65
parser: "@typescript-eslint/parser",
76
parserOptions: {

README.md

+3-25
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,6 @@ project.
3434
- Having a unified set of developer tooling (linting rules, deployment automation, etc.) also improves developer QoL and code reliability.
3535

3636

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-
5437
## Developers
5538
The monorepo setup should make it easier for developers to test their changes
5639
in a more realistic environment, especially when making changes to libraries
@@ -115,7 +98,7 @@ Note:
11598
> 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.
11699
117100
The main scripts to be run are defined in this config file:
118-
build, lint, test, and dev.
101+
`build`, `lint`, `test`, and `dev`.
119102

120103
## Development
121104
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.
152135
#### Manually adding a new package
153136
`packages/caravan-psbt` is a good starting point for a simple package.
154137

155-
#### Example Walk-thru
156138
Let's make a package `@caravan/clients`. This is code that's being added
157139
to caravan in [this PR](https://github.com/unchained-capital/caravan/pull/365)
158140
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
204186
}
205187
```
206188

207-
**TODO:** probably need to cleanup the @caravan/eslint-config and maybe tsconfig
208-
209189
- Install some more dependencies (from package dir):
210190
```shell
211191
$ npm install --save-dev typescript tsup eslint jest ts-jest
212192
```
213193

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)
195+
216196
- Add configs: `eslintrc.js`, `tsconfig.json`, `jest.config.js`:
217197
```javascript
218198
// .eslintrc.js
@@ -285,8 +265,6 @@ This Turborepo includes the following packages and apps:
285265
- `eslint-config-custom`: shared `eslint` configurations
286266
- `tsconfig`: `tsconfig.json`s used throughout the monorepo
287267

288-
Each package and app is 100% [TypeScript](https://www.typescriptlang.org/).
289-
290268
### Utilities
291269

292270
This Turborepo has some additional tools already setup for you:

0 commit comments

Comments
 (0)