@zuplo/test 1.4.0 → 1.4.4

package/README.md

@@ -1,5 +1,36 @@
-# @zuplo/core
+# @zuplo/test
 
-This is a simple placeholder package to hold the type definitions for
-@zuplo/test. We do not have any code in this package because the code is
-dynamically generated by @zuplo/cli.
+Type definitions for the test constructs (`describe`, `it`, `beforeEach`, …) and
+the `TestHelper` object that `@zuplo/cli` injects when it runs a Zuplo project's
+tests. There is no runtime code here — the implementation is generated by the
+CLI — so `dist/index.d.ts` is hand-maintained rather than compiled.
+
+This package was moved here from the standalone `zuplo/test` repository.
+
+## Releasing
+
+`@zuplo/test` is **not** published as part of a core release. It has its own tag
+prefix (`test-v`) and its own workflow, so a version only goes out when someone
+asks for one:
+
+1. Run the **Run Release** workflow and pick `@zuplo/test` as the product.
+2. That computes and pushes the next `test-v<major>.<minor>.<patch>` tag.
+3. Pushing the tag runs
+   [`release-test.yaml`](../../.github/workflows/release-test.yaml), which
+   publishes to npmjs.com and GitHub Packages and cuts a GitHub release.
+
+The `version` field below is informational — the release workflow overwrites it
+with the version from the tag before publishing. Because there are no existing
+`test-v*` tags yet, the first release seeds its version from that field.
+
+Consequences of being outside the core release:
+
+- `packages/test` is excluded from the npm workspaces list, so `@zuplo/test`
+  still resolves from the registry for local development and CI type-checking.
+  Editing `dist/index.d.ts` here does not change what `npm ci` installs until a
+  release goes out.
+- `scripts/set-versions.mjs` skips this directory so core releases don't
+  overwrite the version.
+- After releasing a new version, bump the `@zuplo/test` pin in
+  [`packages/zuplo/package.json`](../zuplo/package.json) (and refresh the
+  lockfile) if the meta-package should ship the new types.

package/dist/index.d.ts

@@ -16,12 +16,14 @@ declare module "@zuplo/test" {
     export namespace describe {
         const ignore: <T>(name: string, fn: () => void | Promise<void>) => TestSuite<T>;
         const only: <T>(name: string, fn: () => void | Promise<void>) => TestSuite<T>;
+        const skip: <T>(name: string, fn: () => void | Promise<void>) => TestSuite<T>;
     }
 
     export function it<T>(name: string, fn: () => void | Promise<void>): TestSuite<T>;
     export namespace it {
         const ignore: <T>(name: string, fn: () => void | Promise<void>) => TestSuite<T>;
         const only: <T>(name: string, fn: () => void | Promise<void>) => TestSuite<T>;
+        const skip: <T>(name: string, fn: () => void | Promise<void>) => TestSuite<T>;
     }
 
     // These are the helpers

package/package.json

@@ -1,44 +1,25 @@
 {
   "name": "@zuplo/test",
-  "version": "1.4.0",
+  "version": "1.4.4",
   "type": "module",
-  "repository": "https://github.com/zuplo/test",
+  "description": "Type definitions for the Zuplo test runner",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zuplo/core"
+  },
   "author": "Zuplo, Inc.",
+  "license": "Copyright 2022",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts"
     }
   },
-  "types": "./dist/index.d.ts",
-  "license": "Copyright 2022",
-  "scripts": {
-    "build": "tsc --build"
-  },
+  "files": [
+    "README.md",
+    "dist/index.d.ts"
+  ],
   "engines": {
     "node": ">=18.0.0"
-  },
-  "lint-staged": {
-    "**/*.{ts,json,md,yml,js,css,html}": [
-      "prettier --write"
-    ],
-    "**/*.{ts,js}": [
-      "eslint --cache --fix --ignore-path .eslintignore"
-    ]
-  },
-  "devDependencies": {
-    "@types/node": "^18.11.5",
-    "@typescript-eslint/eslint-plugin": "^5.42.0",
-    "@typescript-eslint/parser": "^5.42.0",
-    "eslint": "^8.26.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^44.0.2",
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.3",
-    "prettier": "^2.7.1",
-    "prettier-plugin-organize-imports": "^3.1.1",
-    "typescript": "^4.8.4"
-  },
-  "dependencies": {}
+  }
 }