@trenskow/print 0.1.0

package/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2024 Kristian Trenskow
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,80 @@
+# @trenskow/print
+
+A simple package for printing to the console (or other streams).
+
+## Usage
+
+````javascript
+import { createWriteStream } from 'node:fs';
+
+import print from '@trenskow/print';
+
+print('Hello, World!'); // Simply prints to stdout.
+print.nn('Hello, World!'); // Prints to stdout without new line.
+print.sentence('Hello, World, this is a sentence.'); // Prints to stdout a sentence and line breaks at TTY width.
+
+// Below does the same as above but to stderr instead.
+
+print.err('Hello, World!');
+print.err.nn('Hello, World!');
+print.err.sentence('Hello, World, this is a sentence!');
+
+// Below does the same but to a stream.
+
+const out = print.stream(createWriteStream('out.txt'));
+
+out('Hello, World!');
+out.nn('Hello, World!');
+out.sentence('Hello, World, this is a sentence!');
+````
+
+## Parallel processing printer
+
+There is also a build-in parallel processing builder. This is used to convey the state of multiple tasks.
+
+### Usage
+
+````javascript
+import { parallelProgress } from '@trenskow/print';
+
+const states = {
+	myTask1: 'waiting',
+	myTask2: 'waiting',
+	myTask3: 'waiting'
+}
+
+const { stateUpdated } = parallelProgress({
+	states,
+	simpleOutput: false, // force non-TTY output (defaults to `false`).
+	completionState: 'done', // State to remove task from list (defaults to ´'done'`).
+	waitingState: 'waiting' // State to signal task is waiting (defaults to `'waiting'`).
+});
+
+for (let idx = 0 ; idx < 3 ; idx++) {
+
+	setTimeout(() => {
+		states[`myTask${idx}`] = 'processing';
+		stateUpdated(`myTask${idx}`);
+	}, idx * 1000);
+
+	setTimeout(() => {
+		states[`myTask${idx}`] = 'done';
+		stateUpdated(`myTask${idx}`);
+	}, idx * 2000);
+
+}
+````
+
+The above will output something like this.
+
+````
+myTask1  processing
+myTask2  processing
+myTask3  waiting
+````
+
+The list will auto-remove items that has the state of `options.completionState` (default is `'done'`).
+
+# License
+
+See license in LICENSE.

package/eslint.config.js

@@ -0,0 +1,54 @@
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+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
+});
+
+export default [...compat.extends('eslint:recommended'), {
+	languageOptions: {
+		globals: {
+			...globals.node,
+			...globals.mocha,
+		},
+
+		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': ['error', {
+			argsIgnorePattern: '^_',
+		}],
+
+		'no-empty': ['error', {
+			allowEmptyCatch: true,
+		}],
+
+		'no-trailing-spaces': ['error', {
+			ignoreComments: true,
+		}],
+
+		'require-atomic-updates': 'off',
+		'eol-last': ['error', 'always'],
+	},
+}];

package/index.js

@@ -0,0 +1,10 @@
+//
+// index.js
+// @trenskow/print
+//
+// Created by Kristian Trenskow on 2024/12/18
+// See license in LICENSE.
+//
+
+export { default } from './lib/index.js';
+export * from './lib/index.js';

package/lib/index.js

@@ -0,0 +1,145 @@
+//
+// index.js
+// @trenskow/print
+//
+// Created by Kristian Trenskow on 2022/03/13
+// See license in LICENSE.
+//
+
+let ttyColumn = 0;
+
+const printer = (stream) => {
+
+	const print = (content = '', options = {}) => {
+
+		if (!Array.isArray(content)) content = [content];
+
+		content.forEach((line) => {
+
+			let output = line;
+
+			if (typeof options.minimumLength === 'number' && options.minimumLength > line.length) {
+				output += (new Array(options.minimumLength - line.length)).fill(' ').join('');
+			}
+
+			if (options.newLine !== false) output += '\n';
+
+			stream.write(output);
+
+			if (stream.isTTY) {
+
+				const lines = output.split('\n');
+
+				if (lines.length > 1) ttyColumn = 0;
+
+				ttyColumn = (ttyColumn + lines[lines.length - 1].length) % stream.columns;
+
+			}
+
+		});
+
+	};
+
+	print.nn = (content, options = {}) => {
+		print(content, Object.assign({ newLine: false }, options));
+	};
+
+	print.sentence = (sentence) => {
+
+		if (!stream.isTTY) return print(sentence);
+
+		const offset = ttyColumn;
+
+		const words = sentence.split(' ');
+
+		words
+			.forEach((word) => {
+
+				if (ttyColumn + word.length >= stream.columns) {
+					print();
+					print.nn((new Array(offset).fill(' ').join('')));
+				}
+
+				if (ttyColumn !== offset) print.nn(' ');
+
+				print.nn(word);
+
+			});
+
+		print();
+
+	};
+
+	return print;
+
+};
+
+const print = printer(process.stdout);
+
+print.out = print;
+print.err = printer(process.stderr);
+print.stream = printer;
+
+const parallelProgress = (options = {}) => {
+
+	options.simpleOutput = !process.stdout.isTTY || options.simpleOutput;
+
+	const {
+		states,
+		simpleOutput = false,
+		completionState = 'done',
+		waitingState = 'waiting'
+	} = options;
+
+	if (typeof states === 'undefined') throw new Error('`states` option must be supplied.');
+
+	if (typeof states !== 'object' || states === null || Array.isArray(states)) {
+		throw new Error('`states` option must be an object.');
+	}
+
+	const maxLength = Object.keys(states).reduce((result, current) => Math.max(result, current.length), 0);
+
+	const nonDoneNames = () => {
+		return Object.keys(states)
+			.filter((name) => states[name].state !== completionState)
+			.sort();
+	};
+
+	const print = () => {
+		if (simpleOutput) return;
+		nonDoneNames().forEach((name) => {
+			process.stdout.write(`\x1b[m${name.padEnd(maxLength + 3)}`);
+			if (states[name].state !== waitingState) {
+				process.stdout.write('\x1b[1m');
+			}
+			process.stdout.write(`${states[name].state}\n`);
+		});
+	};
+
+	const clear = (additional = 0) => {
+		if (simpleOutput) return;
+		[...nonDoneNames(), ...Array(additional).fill()]
+			.forEach(() => process.stdout.write('\x1b[1A\x1b[K'));
+	};
+
+	print();
+
+	return {
+		stateUpdated: (name) => {
+
+			if (simpleOutput) {
+				return console.info(`${name.padEnd(maxLength)} ${states[name].state}`);
+			}
+
+			clear(states[name].state === completionState ? 1 : 0);
+			print();
+
+		}
+	};
+
+};
+
+print.parallelProgress = parallelProgress;
+
+export default print;
+export { parallelProgress };

package/package.json

@@ -0,0 +1,29 @@
+{
+	"name": "@trenskow/print",
+	"version": "0.1.0",
+	"description": "A simple package for printing to the console (or other streams).",
+	"main": "index.js",
+	"type": "module",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/trenskow/printer.git"
+	},
+	"keywords": [
+		"print",
+		"stdout",
+		"stderr",
+		"std"
+	],
+	"author": "Kristian Trenskow <this.is@kristians.email>",
+	"license": "BSD-3-Clause",
+	"bugs": {
+		"url": "https://github.com/trenskow/printer/issues"
+	},
+	"homepage": "https://github.com/trenskow/printer#readme",
+	"devDependencies": {
+		"eslint": "^9.17.0"
+	}
+}