breakage 0.8.2 → 0.8.4

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 +14 -14
  2. package/package.json +4 -3
package/README.md CHANGED
@@ -4,14 +4,6 @@ Run yesterday’s tests against tomorrow’s release.
4
4
 
5
5
  Command line tooling to detect breaking changes before you ship them.
6
6
 
7
- ## migrating from break-check
8
-
9
- Breakage continues [break-check](https://github.com/jeremybanka/wayforge/tree/break-check%400.8.1/packages/break-check) in its own repository. Install `breakage`, replace the `break-check` command with `breakage`, and rename `break-check.config.json` to `breakage.config.json`. Configuration keys and check outcomes are unchanged. Regenerate schemas with `breakage schema`; generated files now use the `breakage` prefix. Reinstall shell completions with `breakage completion install <shell>`.
10
-
11
- For programmatic use, import `breakage`, `BreakageOptions`, and `BreakageOutcome` from `breakage` in place of `breakCheck`, `BreakCheckOptions`, and `BreakCheckOutcome` from `break-check`.
12
-
13
- Finish active break-check runs and recover any interrupted runs before switching. Breakage stores new recovery records under `breakage/` in the worktree's Git directory and its fetch lock at `breakage-fetch.lock` in the common Git directory.
14
-
15
7
  ## can i use breakage?
16
8
 
17
9
  breakage is a tool for projects where
@@ -90,8 +82,8 @@ Add these scripts to the tested package, preserving your existing runner and cer
90
82
  ```json
91
83
  {
92
84
  "scripts": {
93
- "test:breaks:prelude": "breakage prelude --out .breakage/baseline.json",
94
- "test:breaks": "breakage --baseline-file .breakage/baseline.json"
85
+ "test:breakage:prelude": "breakage prelude --out .breakage/baseline.json",
86
+ "test:breakage": "breakage --baseline-file .breakage/baseline.json"
95
87
  }
96
88
  }
97
89
  ```
@@ -101,11 +93,11 @@ Use [Turbo's deferred hashing](https://turborepo.dev/docs/reference/configuratio
101
93
  ```json
102
94
  {
103
95
  "tasks": {
104
- "test:breaks:prelude": {
96
+ "test:breakage:prelude": {
105
97
  "cache": false
106
98
  },
107
- "test:breaks": {
108
- "dependsOn": ["test:breaks:prelude", "^build"],
99
+ "test:breakage": {
100
+ "dependsOn": ["test:breakage:prelude", "^build"],
109
101
  "inputs": [
110
102
  "$TURBO_DEFAULT$",
111
103
  { "mode": "jit", "globs": [".breakage/baseline.json"] }
@@ -116,7 +108,7 @@ Use [Turbo's deferred hashing](https://turborepo.dev/docs/reference/configuratio
116
108
  }
117
109
  ```
118
110
 
119
- Run `turbo run test:breaks` as usual. The prelude runs even when the compatibility check hits its cache; a failed prelude prevents the downstream task from replaying a cached success. Keep all additional runner, helper, configuration, environment, and certification inputs in the compatibility task's hash, including release-plan files outside the package directory. Keep upstream `^build` prerequisites; the tested package does not need a self-build preflight. For runners without deferred hashing, finish the prelude before starting the task runner and include its snapshot in the check's cache key.
111
+ Run `turbo run test:breakage` as usual. The prelude runs even when the compatibility check hits its cache; a failed prelude prevents the downstream task from replaying a cached success. Keep all additional runner, helper, configuration, environment, and certification inputs in the compatibility task's hash, including release-plan files outside the package directory. Keep upstream `^build` prerequisites; the tested package does not need a self-build preflight. For runners without deferred hashing, finish the prelude before starting the task runner and include its snapshot in the check's cache key.
120
112
 
121
113
  The JavaScript API exports `breakagePrelude({ out, tagPattern, baseDirname })` and accepts `baselineFile` in `breakage` options. Without `baselineFile`, the existing single-command discovery behavior is preserved.
122
114
 
@@ -253,3 +245,11 @@ These aliases work alongside the original option names. Configuration file keys
253
245
  | `--outdir` (schema command) | `--out-dir` |
254
246
 
255
247
  After successful parsing, breakage warns on stderr about unknown options and options that do not apply to the selected command. Warnings appear before check output is captured and do not change the command's exit status.
248
+
249
+ ## migrating from break-check
250
+
251
+ Breakage continues [break-check](https://github.com/jeremybanka/wayforge/tree/break-check%400.8.1/packages/break-check) in its own repository. Install `breakage`, replace the `break-check` command with `breakage`, and rename `break-check.config.json` to `breakage.config.json`. Configuration keys and check outcomes are unchanged. Regenerate schemas with `breakage schema`; generated files now use the `breakage` prefix. Reinstall shell completions with `breakage completion install <shell>`.
252
+
253
+ For programmatic use, import `breakage`, `BreakageOptions`, and `BreakageOutcome` from `breakage` in place of `breakCheck`, `BreakCheckOptions`, and `BreakCheckOutcome` from `break-check`.
254
+
255
+ Finish active break-check runs and recover any interrupted runs before switching. Breakage stores new recovery records under `breakage/` in the worktree's Git directory and its fetch lock at `breakage-fetch.lock` in the common Git directory.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "breakage",
3
- "version": "0.8.2",
3
+ "version": "0.8.4",
4
4
  "description": "Run yesterday’s tests against tomorrow’s release.",
5
5
  "homepage": "https://github.com/jeremybanka/breakage#readme",
6
6
  "bugs": "https://github.com/jeremybanka/breakage/issues",
@@ -45,7 +45,8 @@
45
45
  "postversion": "dprint fmt package.json",
46
46
  "schema": "bun src/breakage.x.ts --outdir=dist -- schema",
47
47
  "pretest": "pnpm run build",
48
- "test": "bun test -- ./__tests__",
49
- "test:watch": "bun test --watch -- ./__tests__"
48
+ "test": "BREAKAGE_CLI_ENTRYPOINT=./src/breakage.x.ts bun test -- ./__tests__ ./tests/public",
49
+ "test:public": "BREAKAGE_CLI_ENTRYPOINT=./src/breakage.x.ts bun test -- ./tests/public",
50
+ "test:watch": "BREAKAGE_CLI_ENTRYPOINT=./src/breakage.x.ts bun test --watch -- ./__tests__ ./tests/public"
50
51
  }
51
52
  }