makiwara 2.2.0 → 2.3.0

package/README.md

@@ -1,5 +1,6 @@
 # makiwara
 
+[![cli-available](https://badgen.net/static/cli/available/?icon=terminal)](#cli)
 [![node version](https://img.shields.io/node/v/makiwara.svg)](https://www.npmjs.com/package/makiwara)
 [![npm version](https://badge.fury.io/js/makiwara.svg)](https://badge.fury.io/js/makiwara)
 [![downloads count](https://img.shields.io/npm/dt/makiwara.svg)](https://www.npmjs.com/package/makiwara)
@@ -9,14 +10,14 @@
 
 🔨 CLI to benchmark URL to gain HTTP requests limits
 
-## Install
+## Usage
+
+Installation:
 
 ```bash
-npm install -g makiwara
+npm install makiwara
 ```
 
-## Usage
-
 ```javascript
 const { benchmark } = require('makiwara');
 
@@ -31,9 +32,17 @@ benchmark('https://example.org', [1, 5, 10], 'sequence')
 
 ## CLI
 
-```text
+Installation:
+
+```bash
+npm install -g makiwara
+```
+
+```bash
 makiwara --help
+```
 
+```text
 Usage: cli [options]
 
 Example:
@@ -90,4 +99,4 @@ Result:
 
 ## License
 
-[The MIT License](https://piecioshka.mit-license.org) @ 2017-2024
+[The MIT License](https://piecioshka.mit-license.org) @ 2017

package/bin/cli.js

@@ -5,10 +5,8 @@ const https = require("https");
 http.globalAgent.maxSockets = https.globalAgent.maxSockets = 512;
 // http.globalAgent.maxFreeSockets = https.globalAgent.maxFreeSockets = 512;
 
-const { Command } = require("commander");
-const program = new Command();
+const minimist = require("minimist");
 
-const ora = require("ora");
 const isUrl = require("is-url");
 const bold = require("ansi-bold");
 
@@ -21,37 +19,61 @@ const { makeRequest } = require("../src/make-requests");
 const pkg = require("../package.json");
 const STRATEGY_REGEXP = /^(concurrent|sequence)$/;
 
-program
-    .version(pkg.version)
-    .option(
-        "-u, --url <url>",
-        "Define URL to benchmark. Ex. https://example.org/"
-    )
-    .option(
-        "-t, --timelimit [numbers]",
-        "Define list of time thresholds (in seconds). Ex. 10,100,1000"
-    )
-    .option(
-        "-s, --strategy <concurrent|sequence>",
-        "Define strategy for making requests"
-    )
-    .description(
-        "Example:\n\tmakiwara -u https://localhost:3000 -t 10 -s sequence"
-    )
-    .parse(process.argv);
-
-const options = program.opts();
+const argv = minimist(process.argv.slice(2), {
+    string: ["url", "timelimit", "strategy"],
+    alias: {
+        u: "url",
+        t: "timelimit",
+        s: "strategy",
+        v: "version",
+        h: "help",
+    },
+});
+
+function displayHelp() {
+    console.log(`
+${pkg.name} v${pkg.version}
+
+Usage: makiwara [options]
+
+Options:
+  -u, --url <url>              Define URL to benchmark. Ex. https://example.org/
+  -t, --timelimit [numbers]    Define list of time thresholds (in seconds). Ex. 10,100,1000
+  -s, --strategy <concurrent|sequence>  Define strategy for making requests
+  -v, --version                Show version number
+  -h, --help                   Show help
+
+Example:
+  makiwara -u https://localhost:3000 -t 10 -s sequence
+`);
+    process.exit(0);
+}
+
+if (argv.version) {
+    console.log(pkg.version);
+    process.exit(0);
+}
+
+if (argv.help) {
+    displayHelp();
+}
+
+const options = {
+    url: argv.url,
+    timelimit: argv.timelimit,
+    strategy: argv.strategy,
+};
 
 if (typeof options.url !== "string") {
     displayHeader();
     logger.red("Error: url is not a string\n");
-    program.help();
+    displayHelp();
 }
 
 if (!isUrl(options.url)) {
     displayHeader();
     logger.red("Error: url is not correct format\n");
-    program.help();
+    displayHelp();
 }
 
 if (!options.timelimit) {
@@ -71,7 +93,6 @@ if (!STRATEGY_REGEXP.test(options.strategy)) {
 const url = options.url;
 const timeLimit = options.timelimit.split(",").map(Number);
 const strategy = options.strategy;
-let spinner = null;
 
 function displayDelimiter() {
     logger.gray("----------------------------------------------------\n");
@@ -84,13 +105,13 @@ function displayHeader() {
 }
 
 async function sendTestRequest(testUrl) {
-    spinner.succeed(`Start testing... ${bold(testUrl)}`);
+    console.log(`Start testing... ${bold(testUrl)}`);
     const response = await makeRequest(testUrl, { agent: false });
     if (response.status !== HTTP_STATUS.OK) {
         logger.red(`HTTP Status Code: ${bold(response.status)}`);
         logger.yellow(`Response Body: ${bold(response.text)}`);
     }
-    spinner.succeed(
+    console.log(
         `Testing completed (response: ${bold(response.text.length)} Bytes)`
     );
 }
@@ -98,15 +119,12 @@ async function sendTestRequest(testUrl) {
 async function main() {
     displayHeader();
 
-    spinner = ora("Loading").start();
-
     try {
         await sendTestRequest(url);
 
-        spinner.succeed("Start benchmarking...");
+        console.log("Start benchmarking...");
         const results = await benchmark(url, timeLimit, strategy);
-        spinner.stop();
-        spinner.succeed("Benchmarking completed\n");
+        console.log("Benchmarking completed\n");
 
         results.forEach((result, index) => {
             displaySummary(result);
@@ -116,7 +134,6 @@ async function main() {
             }
         });
     } catch (err) {
-        spinner.stop();
         logger.red(err);
     }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "makiwara",
   "description": "🔨 CLI to benchmark URL to gain HTTP requests limits",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "license": "MIT",
   "author": {
     "name": "Piotr Kowalski",
@@ -9,7 +9,7 @@
     "url": "https://piecioshka.pl/"
   },
   "scripts": {
-    "clear": "rm -rf dist/ coverage/ .nyc_output/",
+    "clear": "rm -rf dist/ coverage/",
     "clear:all": "rm -rf node_modules/ && npm run clear",
     "test": "jest --watchAll=false",
     "test:watch": "jest",
@@ -19,36 +19,35 @@
     "prepare": "npm run snyk-protect"
   },
   "dependencies": {
-    "@types/jest": "^29.5.14",
+    "@types/jest": "^30.0.0",
     "ansi-bold": "^0.1.1",
     "ansi-gray": "^0.1.1",
     "ansi-red": "^0.1.1",
     "ansi-yellow": "^0.1.1",
-    "axios": "^1.7.7",
+    "axios": "^1.13.2",
     "http-status-codes": "^2.3.0",
     "is-url": "^1.2.4",
-    "jest": "^29.7.0",
+    "jest": "^30.2.0",
+    "minimist": "^1.2.8",
     "node-fetch": "^3.3.2",
-    "snyk": "^1.1293.1",
-    "table": "^6.8.2"
+    "snyk": "^1.1301.2",
+    "table": "^6.9.0"
   },
   "devDependencies": {
-    "@types/node": "^22.7.5",
-    "commander": "^12.1.0",
+    "@types/node": "^25.0.6",
     "eslint": "^8.6.0",
-    "eslint-config-piecioshka": "^2.3.1",
-    "nock": "^13.5.5",
-    "ora": "^5.4.1"
+    "eslint-config-piecioshka": "^2.3.7",
+    "nock": "^14.0.10"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/piecioshka/makiwara.git"
+    "url": "git+ssh://git@github.com/piecioshka/makiwara.git"
   },
   "bugs": {
     "url": "https://github.com/piecioshka/makiwara/issues"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "files": [
     "bin",

package/src/make-requests.js

@@ -12,10 +12,7 @@ function pause(timeoutInSeconds) {
 }
 
 function status(i) {
-    if (global.spinner) {
-        global.spinner.text = `Loading: ${i} time(s)`;
-        global.spinner.render();
-    }
+    process.stdout.write(`\rLoading: ${i} time(s)`);
 }
 
 async function makeRequestsInConcurrentMode(url, durationInSeconds) {

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-Copyright (c) 2017 Piotr Kowalski
-
-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.
-