jwalker 1.0.4 → 3.0.0

package/.eslintrc.js

@@ -0,0 +1,49 @@
+module.exports = {
+	'env': {
+		'es6': true,
+		'node': true,
+		'mocha': true
+	},
+	'parserOptions': {
+		'ecmaVersion': 2017
+	},
+	'extends': 'eslint:recommended',
+	'rules': {
+		'indent': [
+			'error',
+			'tab'
+		],
+		'linebreak-style': [
+			'error',
+			'unix'
+		],
+		'quotes': [
+			'error',
+			'single'
+		],
+		'semi': [
+			'error',
+			'always'
+		],
+		'no-console': [
+			'error', {
+				'allow': [
+					'warn',
+					'error',
+					'info'
+				]
+			}
+		],
+		'no-unused-vars': [
+			'error', {
+				'argsIgnorePattern': '^_'
+			}
+		],
+		'no-empty': [
+			'error', {
+				'allowEmptyCatch': true
+			}
+		],
+		'require-atomic-updates': 'off'
+	}
+};

package/.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "Launch Program",
+			"skipFiles": [
+				"<node_internals>/**"
+			],
+			"program": "${workspaceFolder}/bin/index.js",
+			"args": ["-i=/Users/trenskow/Desktop/test.json", "-p"]
+		}
+	]
+}

package/README.md

@@ -3,16 +3,42 @@ jwalker
 
 Parses a file stream for JSON and pretty prints it.
 
-# Usage
-
-    Usage: jwalker [options]
-    
-      Use -- (or omit) for stdin or stdout.
-    
-      Options:
-        -i=[file], --input=[file]         Input file.
-        -o=[file], --output=[file]        Output file.
-        -e, --exit                        Exit on errors.
+# Usage (CLI)
+
+Using jwalker on the command line.
+
+````
+	Usage: jwalker [options]
+	
+		Use -- (or omit) for stdin or stdout.
+	
+		Options:
+			-i=[file], --input=[file]         Input file (-- for stdin) (default=stdin).
+			-o=[file], --output=[file]        Output file (-- for stdout) (default=stdout).
+			-p, --passthrough                 Passthrough non-JSON.
+			-s=[spaces], --spaces=[spaces]    Number of spaces per indentation (default=4).
+````
+
+# Usage (code)
+
+Using jwalker as a transform stream in node.js.
+
+````javascript
+
+const JWalker = require('jwalker');
+
+readStream
+	.pipe(new JWalker({ /* options */ }))
+	.pipe(writeStream);
+
+````
+
+## Options
+
+| Name                 | Type      | Description                                  | Default |
+|:---------------------|:---------:|:---------------------------------------------|:--------|
+| `passthroughNonJSON` | `Boolean` | Tells the transform to passthrough non-JSON. | `false` |
+| `spaces`             | `Number`  | The number of spaces used per indentation.   | `4`     |
 
 # License
 

package/bin/index.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+
+import argumentsParser from '@trenskow/arguments-parser';
+
+import JWalker from '../lib/index.js';
+
+const {
+	input,
+	output,
+	spaces = '\t',
+	passthrough
+} = await argumentsParser().options({
+	'input': {
+		type: String,
+		default: '--',
+		description: 'Input file (-- for stdin).'
+	},
+	'output': {
+		type: String,
+		default: '--',
+		description: 'Output file (-- for stdout).'
+	},
+	'spaces': {
+		type: Number,
+		description: 'Use number of spaces for indentation (default is tab).'
+	},
+	'passthrough': {
+		type: Boolean,
+		default: false,
+		description: 'Passthrough non-JSON lines.'
+	}
+});
+
+(input === '--' ? process.stdin : fs.createReadStream(input))
+	.pipe(new JWalker({ passthroughNonJSON: passthrough, spaces: spaces }))
+	.pipe((output === '--' ? process.stdout : fs.createWriteStream(output)));

package/eslint.config.mjs

@@ -0,0 +1,63 @@
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+import { includeIgnoreFile } from '@eslint/compat';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+	baseDirectory: __dirname,
+	recommendedConfig: js.configs.recommended,
+	allConfig: js.configs.all
+});
+const gitIgnorePath = path.resolve(__dirname, '.gitignore');
+
+export default [...compat.extends('eslint:recommended'),
+	includeIgnoreFile(gitIgnorePath), {
+		languageOptions: {
+			globals: {
+				...globals.node,
+				...globals.mocha,
+				Router: true,
+				Endpoint: true,
+				app: true
+			},
+
+			ecmaVersion: 'latest',
+			sourceType: 'module'
+		},
+
+		rules: {
+			indent: ['error', 'tab', {
+				SwitchCase: 1
+			}],
+
+			'linebreak-style': ['error', 'unix'],
+			quotes: ['error', 'single'],
+			semi: ['error', 'always'],
+
+			'no-console': ['error', {
+				allow: ['warn', 'error', 'info']
+			}],
+
+			'no-unused-vars': ['warn', {
+				argsIgnorePattern: '^_',
+				caughtErrors: 'none'
+			}],
+
+			'no-empty': ['error', {
+				allowEmptyCatch: true
+			}],
+
+			'no-trailing-spaces': ['error', {
+				ignoreComments: true
+			}],
+
+			'require-atomic-updates': 'off',
+			'no-implicit-globals': ['error'],
+			'eol-last': ['error', 'always'],
+			'comma-dangle': ['error', 'never']
+		}
+	}];

package/index.js

@@ -1,56 +1,3 @@
-#!/usr/bin/env node
-
 'use strict';
 
-const fs = require('fs');
-const readline = require('readline');
-
-const minimist = require('minimist');
-const args = minimist(process.argv.slice(2), {
-	alias: {
-		'h': 'help',
-		'e': 'exit',
-		'i': 'input',
-		'o': 'output'
-	},
-	'--': false
-});
-
-const help = () => {
-
-	console.log('Usage: jwalker [options]');
-	console.log();
-	console.log('  Use -- (or omit) for stdin or stdout.');
-	console.log();
-	console.log('  Options:');
-	console.log('    -i=[file], --input=[file]         Input file.');
-	console.log('    -o=[file], --output=[file]        Output file.');
-	console.log('    -e, --exit                        Exit on errors.');
-	console.log();
-
-	process.exit(0);
-
-};
-
-if (args.help === true) return help();
-
-const exits = (args.exit === true);
-
-args.input = args.input || '--';
-args.output = args.output || '--';
-
-const inputStream = (args.input === '--' ? process.stdin : fs.createReadStream(args.input));
-const outputStream = (args.output === '--' ? process.stdout : fs.createWriteStream(args.output));
-
-const line = readline.createInterface({
-	input: inputStream
-});
-
-line.on('line', line => {
-	try {
-		outputStream.write(JSON.stringify(JSON.parse(line), null, 4) + '\n', 'utf8');
-	} catch(err) {
-		outputStream.write(line + '\n');
-		if (exits) process.exit(1);
-	}
-});
+exports = module.exports = require('./lib');

package/lib/index.js

@@ -0,0 +1,56 @@
+
+import { Transform } from 'stream';
+
+export default class JWalker extends Transform {
+
+	constructor(options = {}) {
+
+		super();
+
+		this._options = options;
+
+		this._backBuffer = new Buffer.from('');
+		this._lastBufferSearch = 0;
+
+	}
+
+	_parse(chunk) {
+
+		try {
+			this.push(Buffer.from(JSON.stringify(JSON.parse(chunk), null, this._options.spaces || 4) + '\n', 'utf-8'));
+		} catch (_) {
+			if (this._options.passthroughNonJSON) {
+				this.push(Buffer.concat([chunk, Buffer.from('\n', 'utf-8')]));
+			}
+		}
+
+	}
+
+	_transform(chunk, enc, done) {
+
+		this._backBuffer = Buffer.concat([this._backBuffer, Buffer.from(chunk, enc)]);
+
+		for (let idx = this._lastBufferSearch ; idx < this._backBuffer.length ; idx++) {
+			if (this._backBuffer.readUInt8(idx) === 0x0A) {
+
+				let chunk = this._backBuffer.slice(0, idx);
+
+				this._backBuffer = this._backBuffer.slice(idx + 1);
+				this._lastBufferSearch = idx = 0;
+
+				this._parse(chunk);
+
+			}
+		}
+
+		done();
+
+	}
+
+	_flush(done) {
+		this._parse(this._backBuffer);
+		this._backBuffer = undefined;
+		done();
+	}
+
+};

package/package.json

@@ -1,37 +1,44 @@
 {
-  "name": "jwalker",
-  "version": "1.0.4",
-  "description": "A JSON pretty-printer for each line in a stream. Useful for JSON logs.",
-  "main": "index.js",
-  "bin": {
-    "jwalker": "./index.js"
-  },
-  "scripts": {
-    "test": "./node_modules/mocha/bin/mocha test/index.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/trenskow/jwalker.git"
-  },
-  "keywords": [
-    "JSON",
-    "lint",
-    "pretty",
-    "print",
-    "line",
-    "readline",
-    "log",
-    "logs",
-    "stream"
-  ],
-  "author": "Kristian Trenskow <trenskow@me.com>",
-  "license": "BSD-3-Clause",
-  "bugs": {
-    "url": "https://github.com/trenskow/jwalker/issues"
-  },
-  "homepage": "https://github.com/trenskow/jwalker#readme",
-  "devDependencies": {},
-  "dependencies": {
-    "minimist": "^1.2.0"
-  }
+	"name": "jwalker",
+	"version": "3.0.0",
+	"description": "A JSON pretty-printer for each line in a stream. Useful for JSON logs.",
+	"main": "index.js",
+	"type": "module",
+	"bin": {
+		"jwalker": "./bin/index.js"
+	},
+	"scripts": {
+		"test": "./node_modules/mocha/bin/mocha test/index.js"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/trenskow/jwalker.git"
+	},
+	"keywords": [
+		"JSON",
+		"lint",
+		"pretty",
+		"print",
+		"line",
+		"readline",
+		"log",
+		"logs",
+		"stream"
+	],
+	"author": "Kristian Trenskow <trenskow@me.com>",
+	"license": "BSD-3-Clause",
+	"bugs": {
+		"url": "https://github.com/trenskow/jwalker/issues"
+	},
+	"homepage": "https://github.com/trenskow/jwalker#readme",
+	"devDependencies": {
+		"@eslint/compat": "^2.0.0",
+		"@eslint/eslintrc": "^3.3.3",
+		"@eslint/js": "^9.39.2",
+		"eslint": "^9.39.2",
+		"globals": "^17.0.0"
+	},
+	"dependencies": {
+		"@trenskow/arguments-parser": "^0.3.54"
+	}
 }