@dbx-tools/projen 0.6.49 → 0.6.51

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +34 -0
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -199,3 +199,37 @@ The engine registers its commands as projen tasks on the workspace root, so run
199
199
  them with `bun run <task>` - `sync` (add `--watch`), `barrels`, `openapi`, and
200
200
  `clean`. [`@dbx-tools/cli`](../packages/cli/dbx-tools) is only needed to
201
201
  bootstrap a folder that has no `.projenrc.ts` or toolchain yet.
202
+
203
+ ## Run Tasks From The ROOT
204
+
205
+ Every repo-wide task lives on the root, and the root's `compile` / `test`
206
+ delegate with `bun run --filter '*'` rather than emitting a step per member - so
207
+ a new package is covered without a re-synth. Work from the root:
208
+
209
+ | Task | What it does |
210
+ | ----------------- | -------------------------------------------------- |
211
+ | `bun run build` | `compile` + `test` + `package` across every member |
212
+ | `bun run compile` | `tsc --build` in each member, in parallel |
213
+ | `bun run test` | `eslint` once, then each member's tests |
214
+ | `bun run sync` | re-synth (`--watch` to keep synthing) |
215
+ | `bun run barrels` | regenerate the read-only `index.ts` barrels |
216
+ | `bun run bump` | version, tag, and publish |
217
+
218
+ Members intentionally keep only the tasks that something OTHER than a human
219
+ invokes, so there is no second place to run the same thing:
220
+
221
+ - `compile` / `test` - what the root's `--filter '*'` delegation calls.
222
+ - `prepack` - what `bun publish` runs per package while packing a tarball
223
+ (27 of 33 members; a package with nothing to pack has none).
224
+ - `watch` - a single-package `tsc --build -w`, for narrowing a long
225
+ edit/compile loop to one package.
226
+ - `build` / `install` / `install:ci` / `default` / `pre-compile` /
227
+ `post-compile` / `package` - projen's own lifecycle scaffolding, emitted for
228
+ every member because projen's task model expects them. Nothing in this repo's
229
+ workflow calls them per member.
230
+
231
+ Do NOT run `projen default` (or `bunx projen`) from inside a member. Synth is a
232
+ whole-tree operation driven by the ROOT `.projenrc.ts`, so a member-level run
233
+ re-synths the entire workspace from the member's directory and rewrites the
234
+ root `package.json` `version` back to `0.0.0`. Run `bun run sync` from the root
235
+ instead.
package/package.json CHANGED
@@ -26,9 +26,9 @@
26
26
  },
27
27
  "dependencies": {
28
28
  "@clack/prompts": "^1.7.0",
29
- "@dbx-tools/core": "0.6.49",
30
- "@dbx-tools/path": "0.6.49",
31
- "@dbx-tools/shared-core": "0.6.49",
29
+ "@dbx-tools/core": "0.6.51",
30
+ "@dbx-tools/path": "0.6.51",
31
+ "@dbx-tools/shared-core": "0.6.51",
32
32
  "commander": "^15.0.0",
33
33
  "concurrently": "^10.0.3",
34
34
  "constructs": "^10.6.0",
@@ -47,7 +47,7 @@
47
47
  },
48
48
  "main": "index.ts",
49
49
  "license": "Apache-2.0",
50
- "version": "0.6.49",
50
+ "version": "0.6.51",
51
51
  "types": "index.ts",
52
52
  "type": "module",
53
53
  "exports": {