@cto.af/chex-cli 2.1.2 → 2.2.2

package/README.md

@@ -0,0 +1,35 @@
+# chex-cli
+
+Like `hexdump -C`, but as a small JS library.
+
+## Install
+
+```
+npm install @cto.af/chex-cli
+```
+
+## Usage
+
+```
+Usage: chex [options] [file...]
+
+Arguments:
+  file                        file names to read or "-" for stdin
+
+Options:
+  -c,--colors                 force colors on even if stdout is not a tty
+  --no-colors                 force colors off even if stdout is a tty
+  -C,--columns <number>       how many columns of 8 bytes? (default: 2)
+  -d,--dots                   use dots for more control characters, instead of
+                              Unicode representations
+  -p,--pager [pager command]  override PAGER environment variable.  If no
+                              command is specified, turn off paging.  Suggested:
+                              "less -REX". (default: "less -REX")
+  -s,--strings <encoding>     try to decode strings in this encoding (choices:
+                              "utf8", "utf-8")
+  -V, --version               output the version number
+  -h, --help                  display help for command
+```
+
+[![Tests](https://github.com/cto-af/chex/actions/workflows/node.js.yml/badge.svg)](https://github.com/cto-af/chex/actions/workflows/node.js.yml)
+[![codecov](https://codecov.io/gh/cto-af/chex/graph/badge.svg?token=S79ZXFIMZS)](https://codecov.io/gh/cto-af/chex)

package/bin/chex.js

@@ -1,16 +1,22 @@
 #!/usr/bin/env node
 
 import {Command, Option} from 'commander';
-import {HexDumpTransform} from '../lib/stream.js';
+import {HexDumpTransform} from '@cto.af/chex';
 import fs from 'node:fs';
 import {version as libVersion} from '@cto.af/chex/lib/version.js';
+import {spawn} from 'node:child_process';
 import {version} from '../lib/version.js';
 
 const program = new Command();
 program
   .argument('[file...]', 'file names to read or "-" for stdin')
   .option('-c,--colors', 'force colors on even if stdout is not a tty')
+  .option('--no-colors', 'force colors off even if stdout is a tty')
+  .option('-C,--columns <number>', 'how many columns of 8 bytes?', 2)
   .option('-d,--dots', 'use dots for more control characters, instead of Unicode representations')
+  .option('-p,--pager [pager command]',
+    'override PAGER environment variable.  If no command is specified, turn off paging.  Suggested: "less -REX".',
+    process.env.PAGER ?? 'more')
   .addOption(new Option(
     '-s,--strings <encoding>',
     'try to decode strings in this encoding'
@@ -24,20 +30,56 @@ if (args.length === 0) {
   args.push('-');
 }
 
-function main(argv) {
-  for (const fn of argv) {
-    if (argv.length > 1) {
-      console.log(fn);
+function pager(pg) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(pg, {
+      shell: true,
+      stdio: ['pipe', 'inherit', 'inherit'],
+    });
+    child.on('error', reject);
+    child.on('spawn', () => resolve(child.stdin));
+  });
+}
+
+function readStream(s) {
+  return new Promise((resolve, reject) => {
+    s.on('error', reject);
+    s.on('end', resolve);
+  });
+}
+
+async function main(argv) {
+  if (opts.pager === 'more') {
+    opts.colors = false;
+  }
+  let out = process.stdout;
+  if (typeof opts.pager === 'string') {
+    out = await pager(opts.pager);
+  }
+
+  try {
+    for (const fn of argv) {
+      if (argv.length > 1) {
+        out.write('File: ');
+        out.write(fn);
+        out.write('\n');
+      }
+      const str = (fn === '-') ?
+        process.stdin :
+        fs.createReadStream(fn);
+      str
+        .pipe(new HexDumpTransform({
+          colors: opts.colors ?? process.stdout.isTTY,
+          columns: opts.columns,
+          dots: opts.dots,
+          decode: opts.strings,
+        }))
+        .pipe(out, {end: false});
+      await readStream(str);
     }
-    const str = (fn === '-') ?
-      process.stdin :
-      fs.createReadStream(fn);
-    str.pipe(new HexDumpTransform({
-      colors: opts.colors || process.stdout.isTTY,
-      dots: opts.dots,
-      decode: opts.strings,
-    })).pipe(process.stdout);
+  } finally {
+    out.end();
   }
 }
 
-main(args);
+main(args).catch(er => console.error(er.message));

package/lib/version.js

@@ -1,4 +1,4 @@
-// Generated by package-extract v3.1.3
+// Generated by package-extract v3.1.5
 // Do not modify by hand.
 
-export const version = '2.1.2';
+export const version = '2.2.2';

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@cto.af/chex-cli",
-  "version": "2.1.2",
+  "version": "2.2.2",
   "description": "hexdump -C as a small JS library",
   "main": "lib/index.js",
   "type": "module",
   "bin": {
     "chex": "bin/chex.js"
   },
+  "files": [
+    "lib/",
+    "bin/"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cto-af/chex.git",
@@ -21,8 +25,8 @@
   "author": "Joe Hildebrand <joe-github@cursive.net>",
   "license": "MIT",
   "dependencies": {
-    "@cto.af/chex": "2.1.2",
-    "commander": "14.0.0"
+    "@cto.af/chex": "2.2.2",
+    "commander": "14.0.3"
   },
   "engines": {
     "node": ">=20"

package/lib/stream.js

@@ -1,77 +0,0 @@
-import {Transform} from 'node:stream';
-import {hexDump} from '@cto.af/chex';
-
-/**
- * @typedef {Partial<import('@cto.af/chex').HexOptions> &
- *   import('node:stream').DuplexOptions} HexDumpStreamOptions
- */
-
-export class HexDumpTransform extends Transform {
-  /** @type {HexDumpStreamOptions} */
-  #opts;
-  #buf = new Uint8Array(16);
-  #bufLen = 0;
-
-  /**
-   *
-   * @param {HexDumpStreamOptions} options
-   */
-  constructor(options = {}) {
-    super(options);
-    this.#opts = {
-      firstByte: 0,
-      ...options,
-      printLength: false,
-    };
-  }
-
-  /**
-   * Transform a chunk of bytes.
-   * @param {Uint8Array} chunk
-   * @param {BufferEncoding} _encoding Should be null
-   * @param {import('node:stream').TransformCallback} callback
-   */
-  _transform(chunk, _encoding, callback) {
-    let res = '';
-    if (this.#bufLen > 0) {
-      const front = Math.min(chunk.length, 16 - this.#bufLen);
-      if (front > 0) {
-        this.#buf.set(chunk.subarray(0, front), this.#bufLen);
-        this.#bufLen += front;
-        chunk = chunk.subarray(front);
-      }
-      if (this.#bufLen === 16) {
-        res += hexDump(this.#buf, this.#opts);
-        this.#opts.firstByte += 16;
-        this.#bufLen = 0;
-      }
-    }
-    if (chunk.length > 0) {
-      const tail = chunk.length % 16;
-      if (tail > 0) {
-        this.#buf.set(chunk.subarray(-tail), this.#bufLen);
-        this.#bufLen += tail;
-        chunk = chunk.subarray(0, -tail);
-      }
-      // Should be multiple of 16 now
-      if (chunk.length > 0) {
-        res += hexDump(chunk, this.#opts);
-        this.#opts.firstByte += chunk.length;
-      }
-    }
-    callback(null, res);
-  }
-
-  /**
-   * @param {import('node:stream').TransformCallback} callback
-   */
-  _flush(callback) {
-    callback(null, hexDump(this.#buf.subarray(0, this.#bufLen), {
-      ...this.#opts,
-      printLength: true,
-    }));
-  }
-}
-
-//
-// process.stdin.pipe(new HexDumpTransform()).pipe(process.stdout);