proby 0.4.1 → 0.6.0

package/README.md

@@ -0,0 +1,203 @@
+# proby
+
+Test runner for JavaScript runtimes.
+
+## What is proby?
+
+A cross-runtime test runner that automatically discovers and runs test files.
+Works with both single repositories and monorepos. Uses `@rcompat/test` for
+writing tests. Works consistently across Node, Deno, and Bun.
+
+## Installation
+
+```bash
+npm install proby
+```
+
+```bash
+pnpm add proby
+```
+
+```bash
+yarn add proby
+```
+
+```bash
+bun add proby
+```
+
+You also need to install `@rcompat/test` as a peer dependency:
+
+```bash
+npm install @rcompat/test
+```
+
+## Usage
+
+### Running tests
+
+Run proby from your project root:
+
+```bash
+npx proby
+```
+
+### Writing tests
+
+Create test files with `.spec.ts` or `.spec.js` extension in your `src`
+directory:
+
+```js
+// src/math.spec.ts
+import test from "@rcompat/test";
+
+test.case("addition", assert => {
+  assert(1 + 1).equals(2);
+  assert(2 + 2).equals(4);
+});
+
+test.case("multiplication", assert => {
+  assert(2 * 3).equals(6);
+  assert(4 * 5).equals(20);
+});
+```
+
+### Test output
+
+Proby displays colored output:
+- Green `o` for passing tests
+- Red `x` for failing tests
+
+```
+oooooxoo
+src/math.spec.ts division
+  expected  5
+  actual    4
+```
+
+### Project structure
+
+Proby automatically detects your project structure:
+
+**Single repository:**
+```
+my-project/
+├── src/
+│   ├── utils.ts
+│   ├── utils.spec.ts    # ← Test file
+│   ├── math.ts
+│   └── math.spec.ts     # ← Test file
+└── package.json
+```
+
+**Monorepo:**
+```
+my-monorepo/
+├── packages/
+│   ├── core/
+│   │   └── src/
+│   │       ├── index.ts
+│   │       └── index.spec.ts  # ← Test file
+│   └── utils/
+│       └── src/
+│           ├── helpers.ts
+│           └── helpers.spec.ts  # ← Test file
+└── package.json
+```
+
+### npm scripts
+
+Add proby to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "test": "npx proby"
+  }
+}
+```
+
+Then run:
+
+```bash
+npm test
+```
+
+## Test file conventions
+
+- Files must end with `.spec.ts` or `.spec.js`
+- Files must be in the `src` directory (or `packages/*/src` for monorepos)
+- Use `@rcompat/test` to write tests
+
+## Examples
+
+### Basic assertions
+
+```js
+import test from "@rcompat/test";
+
+test.case("basic assertions", assert => {
+  // equality
+  assert(value).equals(expected);
+
+  // truthiness
+  assert(condition).true();
+  assert(condition).false();
+
+  // type checking
+  assert(value).type<string>();
+
+  // throws
+  assert(() => throwingFunction()).throws();
+  assert(() => safeFunction()).tries();
+});
+```
+
+### Async tests
+
+```js
+import test from "@rcompat/test";
+
+test.case("async operations", async assert => {
+  const result = await fetchData();
+  assert(result.status).equals(200);
+});
+```
+
+### Testing modules
+
+```js
+// src/calculator.ts
+export function add(a: number, b: number) {
+  return a + b;
+}
+
+// src/calculator.spec.ts
+import test from "@rcompat/test";
+import { add } from "./calculator.js";
+
+test.case("add function", assert => {
+  assert(add(1, 2)).equals(3);
+  assert(add(-1, 1)).equals(0);
+  assert(add(0, 0)).equals(0);
+});
+```
+
+## Cross-Runtime Compatibility
+
+| Runtime | Supported |
+|---------|-----------|
+| Node.js | ✓         |
+| Deno    | ✓         |
+| Bun     | ✓         |
+
+No configuration required — just run `npx proby`.
+
+## License
+
+MIT
+
+## Contributing
+
+See [CONTRIBUTING.md](../../CONTRIBUTING.md) in the repository root.
+

package/lib/bin.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import red from "@rcompat/cli/color/red";
+import color from "@rcompat/cli/color";
 import print from "@rcompat/cli/print";
 import root from "@rcompat/fs/project/root";
 import run from "./run.js";
@@ -28,6 +28,6 @@ else if (type === "repo") {
     await run($root.join("src"));
 }
 else {
-    print(`${red("src")} or ${red("packages")} not found\n`);
+    print(`${color.red("src")} or ${color.red("packages")} not found\n`);
 }
 //# sourceMappingURL=bin.js.map

package/lib/run.js

@@ -1,29 +1,26 @@
-import blue from "@rcompat/cli/color/blue";
-import green from "@rcompat/cli/color/green";
-import red from "@rcompat/cli/color/red";
+import color from "@rcompat/cli/color";
 import print from "@rcompat/cli/print";
 import repository from "@rcompat/test/repository";
-const endings = [".spec.ts", ".spec.js"];
+const extensions = [".spec.ts", ".spec.js"];
+const base_scalars = ["boolean", "number", "string", "symbol"];
 function stringify_scalar(value) {
     if (value === null)
         return "null";
     if (value === undefined)
         return "undefined";
-    if (["boolean", "number", "string", "symbol"].includes(typeof value)) {
+    const type = typeof value;
+    if (base_scalars.includes(type))
         return value.toString();
-    }
-    if (typeof value === "bigint") {
+    if (typeof value === "bigint")
         return value.toString() + "n";
-    }
     if (typeof value === "function") {
         return `[Function${value.name ? `: ${value.name}` : ""}]`;
     }
 }
 function stringify(value) {
     const scalar = stringify_scalar(value);
-    if (scalar !== undefined) {
+    if (scalar !== undefined)
         return scalar;
-    }
     if (typeof value === "object") {
         try {
             return JSON.stringify(value, (_, sub) => {
@@ -38,27 +35,29 @@ function stringify(value) {
     return String(value);
 }
 export default async (root, subrepo) => {
-    const files = await root.list(file => endings.some(ending => file.path.endsWith(ending)), { recursive: true });
-    if (files.length === 0) {
+    const files = await root.list({
+        recursive: true,
+        filter: file => extensions.some(extension => file.path.endsWith(extension)),
+    });
+    if (files.length === 0)
         return;
-    }
     for (const file of files) {
         repository.suite(file);
         await file.import();
     }
     if (subrepo !== undefined) {
-        print(`${blue(subrepo)}\n`);
+        print(`${color.blue(subrepo)}\n`);
     }
     for (const suite of repository.next()) {
         const failed = [];
         for await (const test of suite.run()) {
             for (const result of test.results) {
                 if (result.passed) {
-                    print(green("o"));
+                    print(color.green("o"));
                 }
                 else {
                     failed.push([test, result]);
-                    print(red("x"));
+                    print(color.red("x"));
                 }
             }
         }
@@ -66,7 +65,7 @@ export default async (root, subrepo) => {
         if (failed.length > 0) {
             print("\n");
             for (const [test, result] of failed) {
-                print(`${suite.file.debase(root)} ${red(test.name)} \n`);
+                print(`${suite.file.debase(root)} ${color.red(test.name)} \n`);
                 print(`  expected  ${stringify(result.expected)}\n`);
                 print(`  actual    ${stringify(result.actual)}\n`);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "proby",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "Standard library test runner",
   "bugs": "https://github.com/rcompat/rcompat/issues",
   "license": "MIT",
@@ -16,11 +16,11 @@
     "directory": "packages/proby"
   },
   "dependencies": {
-    "@rcompat/cli": "^0.11.3",
-    "@rcompat/fs": "^0.22.3"
+    "@rcompat/cli": "^0.13.0",
+    "@rcompat/fs": "^0.24.0"
   },
   "peerDependencies": {
-    "@rcompat/test": "^0.5.0"
+    "@rcompat/test": "^0.7.0"
   },
   "peerDependenciesMeta": {
     "@rcompat/test": {