kizu 3.6.7 → 3.7.0

package/README.md

@@ -7,9 +7,9 @@
 [![build status](https://github.com/mhweiner/kizu/actions/workflows/release.yml/badge.svg)](https://github.com/mhweiner/kizu/actions)
 [![SemVer](https://img.shields.io/badge/SemVer-2.0.0-blue)]()
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
-[![AutoRel](https://img.shields.io/badge/v2-AutoRel?label=AutoRel&labelColor=0ab5fc&color=grey&link=https%3A%2F%2Fgithub.com%2Fmhweiner%2Fautorel)](https://github.com/mhweiner/autorel)
+[![AutoRel](https://img.shields.io/badge/%F0%9F%9A%80%20AutoRel-2D4DDE)](https://github.com/mhweiner/autorel)
 
-**kizu** is a fast, minimalist test runner for TypeScript and JavaScript, with a small, easy-to-learn API that lets you focus on your tests — not your tooling.
+Kizu is a fast, minimalist test runner for TypeScript and JavaScript, with a small, easy-to-learn API that lets you focus on your tests — not your tooling.
 
 Designed to help you write simple, readable, and maintainable tests.
 

package/bin/cli.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env ts-node
 
-require('../dist/run');
+require('../dist/cli');

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const run_1 = require("./run");
+// eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
+const packageJson = require('../package.json');
+const program = new commander_1.Command();
+program
+    .name('kizu')
+    .version(packageJson.version, '-v, --version')
+    .description('⚫️ kizu\n\nAn easy-to-use, fast, and defensive Typescript/Javascript test runner designed to help you to write simple, readable, and maintainable tests.')
+    .option('--fail-only, -f', 'Only show failures in the output.', false)
+    .argument('<glob>', 'Glob pattern to match files to run tests on.')
+    .parse(process.argv);
+const flags = program.opts();
+const filesGlob = program.args[0];
+(0, run_1.run)(flags, filesGlob).catch(console.log.bind(console));
+//# sourceMappingURL=cli.js.map

package/dist/getSpecFiles.d.ts

@@ -1 +1 @@
-export declare function getSpecFiles(): Promise<string[]>;
+export declare function getSpecFiles(arg: string): Promise<string[]>;

package/dist/getSpecFiles.js

@@ -14,9 +14,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSpecFiles = getSpecFiles;
 const tiny_glob_1 = __importDefault(require("tiny-glob"));
-function getSpecFiles() {
+function getSpecFiles(arg) {
     return __awaiter(this, void 0, void 0, function* () {
-        return (0, tiny_glob_1.default)(process.argv[2]);
+        return (0, tiny_glob_1.default)(arg);
     });
 }
 //# sourceMappingURL=getSpecFiles.js.map

package/dist/output.d.ts

@@ -1,5 +1,5 @@
 import { TestResultsByFile, FinalResults } from './run';
 import { TestResults } from './test';
-export declare function printResultsByFile(resultsByFile: TestResultsByFile): void;
-export declare function printFileResults(filename: string, tests: TestResults[]): void;
+export declare function printResultsByFile(resultsByFile: TestResultsByFile, showOnlyFailures?: boolean): void;
+export declare function printFileResults(filename: string, tests: TestResults[], showOnlyFailures?: boolean): void;
 export declare function printSummary(finalResults: FinalResults): void;

package/dist/output.js

@@ -21,19 +21,25 @@ The following spec files do not have any attempted or completed tests:
 
 ${files.join(', ')}
 `);
-function printResultsByFile(resultsByFile) {
+function printResultsByFile(resultsByFile, showOnlyFailures = false) {
     const sortedResults = (0, sortTestResults_1.sortTestResults)(resultsByFile);
     for (const [filename, tests] of sortedResults) {
-        printFileResults(filename, tests);
+        printFileResults(filename, tests, showOnlyFailures);
     }
 }
-function printFileResults(filename, tests) {
-    const doesFileHaveFailures = tests.some((test) => !(0, isTestPassing_1.isTestPassing)(test));
-    const header = `${kleur_1.default.underline().blue(filename)} ${doesFileHaveFailures ? failureSymbol : successSymbol}\n`;
+function printFileResults(filename, tests, showOnlyFailures = false) {
+    const hasFailure = tests.some((test) => !(0, isTestPassing_1.isTestPassing)(test));
+    if (showOnlyFailures && !hasFailure)
+        return;
+    const header = `${kleur_1.default.underline().blue(filename)} ${hasFailure ? failureSymbol : successSymbol}\n`;
     log(header);
     tests.forEach(((test) => {
+        if (showOnlyFailures && (0, isTestPassing_1.isTestPassing)(test))
+            return;
         log(`${test.description} ${(0, isTestPassing_1.isTestPassing)(test) ? successSymbol : failureSymbol}`);
         test.assertions.forEach((assertion) => {
+            if (showOnlyFailures && assertion.pass)
+                return;
             log(kleur_1.default.gray(`  ${assertion.description} ${assertion.pass ? successSymbol : failureSymbol}`));
             !assertion.pass && printFailedAssertionDiag(assertion);
         });

package/dist/run.d.ts

@@ -1,4 +1,7 @@
 import { TestResults } from './test';
+export type Flags = {
+    failOnly: boolean;
+};
 export type TestResultsByFile = {
     [file: string]: TestResults[];
 };
@@ -10,3 +13,4 @@ export type FinalResults = {
     numAssertions: number;
     numSuccessfulAssertions: number;
 };
+export declare function run(flags: Flags, filesGlob: string): Promise<void>;

package/dist/run.js

@@ -12,6 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = run;
 const ora_1 = __importDefault(require("ora"));
 const output_1 = require("./output");
 const calculateFinalResults_1 = require("./calculateFinalResults");
@@ -21,13 +22,13 @@ const getSpecFiles_1 = require("./getSpecFiles");
 const testResultsByFile = {};
 let numCompletedTests = 0;
 const status = (0, ora_1.default)();
-function start() {
+function run(flags, filesGlob) {
     return __awaiter(this, void 0, void 0, function* () {
-        const specFiles = yield (0, getSpecFiles_1.getSpecFiles)();
+        const specFiles = yield (0, getSpecFiles_1.getSpecFiles)(filesGlob);
         console.log(`Found ${specFiles.length} spec files.\n`);
         status.start('Running tests...');
         yield (0, workerPool_1.workerPool)(specFiles, addTestResults);
-        finish(specFiles);
+        showResults(flags, specFiles);
     });
 }
 /**
@@ -40,13 +41,12 @@ function addTestResults(file, results) {
     testResultsByFile[file] = (testResultsByFile[file] || []).concat([results]);
     status.text = `${numCompletedTests} tests completed.`;
 }
-function finish(specFiles) {
+function showResults(flags, specFiles) {
     status.stop();
     const finalResults = (0, calculateFinalResults_1.calculateFinalResults)(specFiles, testResultsByFile);
-    (0, output_1.printResultsByFile)(testResultsByFile);
+    (0, output_1.printResultsByFile)(testResultsByFile, flags.failOnly);
     (0, output_1.printSummary)(finalResults);
     if ((0, shouldExitWithError_1.shouldExitWithError)(finalResults))
         process.exit(1);
 }
-start().catch(console.log.bind(console));
 //# sourceMappingURL=run.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kizu",
-  "version": "3.6.7",
+  "version": "3.7.0",
   "description": "An easy-to-use, fast, and defensive Typescript/Javascript test runner designed to help you to write simple, readable, and maintainable tests.",
   "license": "MIT",
   "main": "./dist/index.js",
@@ -40,6 +40,7 @@
     "node-tap"
   ],
   "dependencies": {
+    "commander": "14.0.0",
     "deep-object-diff": "^1.1.0",
     "diff": "^5.0.0",
     "kleur": "^4.1.4",