@leyman/expect 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jacob Ley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+<div style="text-align:center">
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @leyman/expect
+
+Chai's expect and assert with chai-as-promised registered, as one ESM import, so async assertions work in any test file without setup.
+
+[![npm package](https://badge.fury.io/js/@leyman%2Fexpect.svg)](https://www.npmjs.com/package/@leyman/expect)
+[![License](https://img.shields.io/npm/l/@leyman/expect.svg)](https://github.com/JacobLey/leyman/blob/main/leyman/expect/LICENSE)
+
+</div>
+
+- **No setup file** — importing it registers chai-as-promised, so `rejectedWith` and `eventually` work in any test, whatever the runner or its config.
+- **One dependency instead of four** — `chai`, `chai-as-promised` and both `@types` packages come with it.
+- **Types included** — the declarations load chai-as-promised's type augmentations, so `.rejectedWith` type-checks without importing it yourself.
+
+## Contents
+
+- [Install](#install)
+- [Example](#example)
+- [Usage](#usage)
+- [API](#api)
+
+## Install
+
+```sh
+npm i -D @leyman/expect
+```
+
+## Example
+
+```ts
+import { expect } from '@leyman/expect';
+
+const thrown: unknown = await expect(myPromise()).to.be.rejectedWith(Error);
+expect(thrown).to.have.property('message').that.includes('<ERROR>');
+```
+
+## Usage
+
+The package is ESM only. Importing it calls `chai.use(chaiAsPromised)` once, on the `chai` it depends on, so it is a module with side effects. If your tests import `chai` directly too, make sure it resolves to the same copy, or that copy won't have chai-as-promised registered.
+
+It is meant for tests: depend on it as a dev dependency.
+
+## API
+
+### `expect`, `assert`
+
+Chai's own `expect` and `assert`, re-exported after chai-as-promised is registered. See [Chai's docs](https://www.chaijs.com/api/bdd/) and [chai-as-promised's](https://github.com/chaijs/chai-as-promised#readme).
+
+### `ChaiAsPromised`
+
+The type of the chai-as-promised plugin. Exported so the declarations import chai-as-promised, which is what loads its augmentations of Chai's types.

package/dist/expect.d.ts

@@ -0,0 +1,11 @@
+import chaiAsPromised from 'chai-as-promised';
+/**
+ * Chai's `assert` and `expect`, with `chai-as-promised` already registered.
+ */
+export { assert, expect } from 'chai';
+/**
+ * Exported so emitted declarations import `chai-as-promised`, which loads its type augmentations
+ * (e.g. `rejectedWith`) for consumers.
+ */
+export type ChaiAsPromised = typeof chaiAsPromised;
+//# sourceMappingURL=expect.d.ts.map

package/dist/expect.js

@@ -0,0 +1,6 @@
+import { use } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+use(chaiAsPromised);
+export { assert, expect } from 'chai';
+
+//# sourceMappingURL=expect.js.map

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@leyman/expect",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Chai's expect and assert with chai-as-promised registered, as one ESM import, so async assertions work in any test file without setup.",
+  "engines": {
+    "node": ">=22"
+  },
+  "type": "module",
+  "author": "JacobLey",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JacobLey/leyman.git",
+    "directory": "leyman/expect"
+  },
+  "homepage": "https://github.com/JacobLey/leyman/tree/main/leyman/expect#readme",
+  "bugs": {
+    "url": "https://github.com/JacobLey/leyman/issues"
+  },
+  "keywords": [
+    "chai",
+    "chai-as-promised",
+    "expect",
+    "assert",
+    "assertions",
+    "testing",
+    "mocha",
+    "esm",
+    "typescript"
+  ],
+  "sideEffects": true,
+  "exports": {
+    ".": "./dist/expect.js"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.map",
+    "!dist/tsconfig.tsbuildinfo"
+  ],
+  "dependencies": {
+    "@types/chai": "^5.2.3",
+    "@types/chai-as-promised": "^8.0.2",
+    "chai": "^6.2.2",
+    "chai-as-promised": "^8.0.2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.6.4",
+    "@leyman/configs": "^0.1.0",
+    "@leyman/eslint-config": "^0.1.0",
+    "@swc/cli": "^0.8.1",
+    "@swc/core": "^1.16.20",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.20.5",
+    "@typescript/native": "npm:typescript@^7.0.2",
+    "c8": "^12.0.0",
+    "eslint": "^10.13.0",
+    "mocha": "^12.0.3",
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
+  }
 }