nano-benchmark 1.0.0 → 1.0.2

package/README.md

@@ -36,8 +36,24 @@ npm install --save nano-benchmark
 
 Both [deno](https://deno.land/) and [bun](https://bun.sh/) are supported.
 
+If you want to run the benchmark in Deno, Bun, etc. you can specify `self` as the `file` argument
+or the `--self` option.
+In this case the utility will print out its file name to `stdout` and exit. It allows running
+the utility with alternative JavaScript interpreters.
+
+Examples with `bash`:
+
+```bash
+$ npx nano-bench benchmark.js
+$ bun `npx nano-bench --self` benchmark.js
+$ deno run --allow-read --allow-hrtime `npx nano-bench --self` benchmark.js
+$ deno run -A `npx nano-bench --self` benchmark.js
+$ node `npx nano-bench --self` benchmark.js
+```
+
 Don't forget to specify the appropriate permissions for Deno to run the benchmark scripts:
-`--allow-read` (required) and `--allow-hrtime` (optional but recommended).
+`--allow-read` (required) and `--allow-hrtime` (optional but recommended). Or consider using
+`-A` or `--allow-all` to allow all permissions (used it only in safe environments!).
 
 ## Documentation
 
@@ -96,4 +112,6 @@ BSD 3-Clause License
 
 ## Release history
 
+- 1.0.2: *Added the `--self` option.*
+- 1.0.1: *Added "self" argument to utilities so it can be used with Deno, Bun, etc.*
 - 1.0.0: *Initial release.*

package/bin/nano-bench.js

@@ -1,6 +1,9 @@
 #!/usr/bin/env node
 
 import process from 'node:process';
+import {fileURLToPath, pathToFileURL} from 'node:url';
+import path from 'node:path';
+import {readFile} from 'node:fs/promises';
 
 import {Option, program} from 'commander';
 
@@ -29,11 +32,24 @@ const sleep = ms => new Promise(resolve => setTimeout(resolve, ms)),
   toInt = value => parseInt(value),
   toFloat = value => parseFloat(value);
 
+const filePath = new URL('../package.json', import.meta.url),
+  pkg = JSON.parse(await readFile(filePath, {encoding: 'utf8'}));
+
+const showSelf = () => {
+  const self = new URL(import.meta.url);
+  if (self.protocol === 'file:') {
+    console.log(fileURLToPath(self));
+  } else {
+    console.log(self);
+  }
+  process.exit(0);
+};
+
 program
   .name('nano-bench')
+  .version(pkg.version)
   .description('Small utility to benchmark and compare code.')
-  .version('1.0.0')
-  .argument('<file>', 'File to benchmark')
+  .argument('<file>', 'File to benchmark.\nIf "self", returns its file name to stdout and exits')
   .option('-m, --ms <ms>', 'measurement time in milliseconds', toInt, 50)
   .addOption(
     new Option('-i, --iterations <iterations>', 'measurement iterations (overrides --ms)')
@@ -46,13 +62,18 @@ program
   .option('-s, --samples <samples>', 'number of samples', toInt, 100)
   .option('-p, --parallel', 'take samples in parallel asynchronously')
   .option('-b, --bootstrap <bootstrap>', 'number of bootstrap samples', toInt, 1000)
+  .option('--self', 'returns the file name to stdout and exits')
   .showHelpAfterError('(add --help to see available options)');
 
+program.on('option:self', showSelf);
+
 program.parse();
 
 const options = program.opts(),
   args = program.args;
 
+if (args[0] === 'self') showSelf();
+
 // validate the options
 
 if (options.minIterations < 1) program.error('The minimum number of iterations must be >= 1');
@@ -63,7 +84,7 @@ if (options.bootstrap < 1) program.error('The number of bootstrap samples must b
 
 // open the file
 
-const fileName = new URL(args[0], `file://${process.cwd()}/`);
+const fileName = pathToFileURL(path.join(process.cwd(), args[0]));
 
 let fns;
 try {

package/bin/nano-watch.js

@@ -1,6 +1,9 @@
 #!/usr/bin/env node
 
 import process from 'node:process';
+import {fileURLToPath, pathToFileURL} from 'node:url';
+import path from 'node:path';
+import {readFile} from 'node:fs/promises';
 
 import {program} from 'commander';
 
@@ -24,25 +27,43 @@ import {StatCounter} from '../src/stream-stats.js';
 
 const sleep = ms => new Promise(resolve => setTimeout(resolve, ms));
 
+const filePath = new URL('../package.json', import.meta.url),
+  pkg = JSON.parse(await readFile(filePath, {encoding: 'utf8'}));
+
+const showSelf = () => {
+  const self = new URL(import.meta.url);
+  if (self.protocol === 'file:') {
+    console.log(fileURLToPath(self));
+  } else {
+    console.log(self);
+  }
+  process.exit(0);
+};
+
 program
   .name('nano-watch')
   .description('Small utility to continuously benchmark code.')
-  .version('1.0.0')
-  .argument('<file>', 'File to benchmark')
+  .version(pkg.version)
+  .argument('<file>', 'File to benchmark.\nIf "self", returns its file name to stdout and exits')
   .argument('[method]', 'Method name to benchmark')
   .option('-m, --ms <ms>', 'milliseconds per iteration', value => parseInt(value), 500)
   .option('-i, --iterations <number>', 'number of iterations (default: Infinity)', value =>
     parseInt(value)
   )
   .option('-e, --export <name>', 'name of the export in the file', 'default')
+  .option('--self', 'print the file name to stdout and exit')
   .showHelpAfterError('(add --help to see available options)');
 
+program.on('option:self', showSelf);
+
 program.parse();
 
 const options = program.opts(),
   args = program.args;
 
-const fileName = new URL(args[0], `file://${process.cwd()}/`);
+if (args[0] === 'self') showSelf();
+
+const fileName = pathToFileURL(path.join(process.cwd(), args[0]));
 
 let fn;
 try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nano-benchmark",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Small utilities to benchmark code with Node.",
   "type": "module",
   "main": "src/index.js",