@trenskow/reader 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,87 @@
+# @trenskow/reader
+
+A simple package to ask questions of a stream.
+
+## Usage
+
+To ask a question use the example below.
+
+````javascript
+import { question } from '@trenskow/reader';
+
+const answer = await question('What is your name?', {
+  // options
+});
+
+console.info(answer);
+````
+
+### Options
+
+These are the options available for `question`.
+
+| Name           | Description                                  | Default value    |
+| -------------- | -------------------------------------------- | ---------------- |
+| `defaultValue` | The default value for the question.          |                  |
+| `silent`       | Do not echo input (useful for private data). | `false`          |
+| `input`        | The input stream to read from.               | `process.stdin`  |
+| `output`       | The output stream to write to.               | `process.stdout` |
+
+## Interviews
+
+There is also an interview mechanism for filling an entire data structure. The data is validated using [isvalid](https://npmjs.com/package/isvalid).
+
+
+### Usage
+
+````javascript
+import { interview } from '@trenskow/reader';
+
+const data = await interview({
+  // schema
+  'username': {
+	type: String,
+	name: 'Username',
+	description: 'Enter your username.',
+	type: String,
+	required: true,
+	len: '3-'
+  },
+  'password': {
+	type: String,
+	name: 'Password',
+	description: 'Enter your password.',
+	type: String,
+	required: true,
+	silent: true // Tells the interviewer to not echo input.
+  }
+}, {
+  // options
+});
+
+console.info(data); // Will output `{ username: 'my-username', password: 'my-password' }`.
+````
+
+### Options
+
+These are the options available for `interview`.
+
+| Name      | Description                                               | Default value    |
+| --------- | --------------------------------------------------------- | ---------------- |
+| `spacing` | The number of vertical spacing (lines) between questions. | `0`              |
+| `input`   | The input stream to read from.                            | `process.stdin`  |
+| `output`  | The output stream to write to.                            | `process.stdout` |
+
+### Extensions to isvalid schemas
+
+In addition to the build-in validators of isvalid, the following is also supported (as in the example above).
+
+| Name          | Description                                                 |   Type    | Default value |
+| ------------- | ----------------------------------------------------------- | :-------: | :-----------: |
+| `name`        | The string to print before the user input.                  | `String`  |               |
+| `description` | The string to print above the question.                     | `String`  |               |
+| `silent`      | Indicates if the property is private (does not echo input). | `Boolean` |    `false`    |
+
+# 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,17 @@
+//
+// index.js
+// @trenskow/print
+//
+// Created by Kristian Trenskow on 2024/12/25
+// See license in LICENSE.
+//
+
+import {
+	interview,
+	question
+} from './lib/index.js';
+
+export {
+	interview,
+	question
+};

package/lib/index.js

@@ -0,0 +1,15 @@
+//
+// interview.js
+// 0-bit-games-cli
+//
+// Created by Kristian Trenskow on 2025/12/25
+// See license in LICENSE.
+//
+
+import interview from './interview.js';
+import question from './question.js';
+
+export {
+	interview,
+	question
+};

package/lib/interview.js

@@ -0,0 +1,105 @@
+//
+// interview.js
+// 0-bit-games-cli
+//
+// Created by Kristian Trenskow on 2025/12/23
+// See license in LICENSE.
+//
+
+import { default as isvalid, plugins, formalize, keyPaths } from 'isvalid';
+import keyd from 'keyd';
+import print from '@trenskow/print';
+
+import question from './question.js';
+
+plugins.use(() => ({
+	phase: 'pre',
+	supportsType: () => true,
+	validatorsForType: () => ({
+		label: ['string'],
+		description: ['string'],
+		silent: ['boolean']
+	}),
+	validate: (data) => data,
+	formalize: (schema) => schema
+}));
+
+const interview = async (schema, { spacing = 0, input = process.stdin, output = process.stdout } = {}) => {
+
+	schema = formalize(schema);
+
+	if (schema.type === Object) {
+
+		const allKeyPaths = keyPaths(schema)
+			.all({ maxDepth: 1 })
+			.filter((keyPath) => keyPath);
+
+		let result = {};
+
+		for (let idx in allKeyPaths) {
+
+			const keyPath = allKeyPaths[idx];
+
+			keyd(result).set(keyPath, await interview(keyPaths(schema).get(keyPath), { spacing }));
+
+			if (idx < allKeyPaths.length - 1) {
+				for (let i = 0; i < spacing; i++) {
+					print();
+				}
+			}
+
+		}
+
+		return await isvalid(result, schema);
+
+	}
+
+	if (schema.type === Array) {
+
+		let result = [];
+
+		while (true) {
+
+			const item = await interview(schema.items);
+
+			if (!item)
+				break;
+
+			result.push(item);
+
+		}
+
+		return result;
+
+	}
+
+	let attempts = 0;
+
+	while (true) {
+		try {
+
+			if (!attempts && schema.description) {
+				print.tty.nn('\x1b[2m');
+				print(schema.description);
+				print.tty.nn('\x1b[0m');
+			}
+
+			return await isvalid(await question(`${schema.label}${schema.required ? ' (required)' : ''}: `, {
+				defaultValue: schema.default,
+				input,
+				output,
+				silent: schema.silent === true
+			}) || undefined, schema);
+
+		} catch (error) {
+			print.tty.err.nn('\x1b[31m');
+			print.err(error.message);
+			print.tty.err.nn('\x1b[0m');
+			print.err();
+			attempts++;
+		}
+	}
+
+};
+
+export default interview;

package/lib/question.js

@@ -0,0 +1,51 @@
+//
+// question.js
+// 0-bit-games-cli
+//
+// Created by Kristian Trenskow on 2024/12/20
+// See license in LICENSE.
+//
+
+import readline from 'readline';
+import { Writable } from 'stream';
+
+const question = async (question, { defaultValue, silent = false, input = process.stdin, output = process.stdout } = {}) => {
+
+	const mutableStdout = new Writable({
+		write: function (chunk, encoding, callback) {
+			if (!this.muted) {
+				output.write(chunk, encoding);
+			}
+			callback();
+		}
+	});
+
+	mutableStdout.muted = false;
+
+	const rl = readline.createInterface({
+		input: input,
+		output: mutableStdout,
+		terminal: output.isTTY
+	});
+
+	const ask = (question) => new Promise((resolve) => {
+
+		rl.question(question, (answer) => {
+			if (silent) output.write('\n');
+			resolve(answer);
+			rl.close();
+		});
+
+		if (defaultValue) {
+			rl.write(defaultValue);
+		}
+
+		mutableStdout.muted = silent;
+
+	});
+
+	return await ask(question);
+
+};
+
+export default question;

package/package.json

@@ -0,0 +1,38 @@
+{
+	"name": "@trenskow/reader",
+	"version": "0.1.0",
+	"description": "A simple package to ask questions of a stream.",
+	"main": "index.js",
+	"type": "module",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/trenskow/reader.git"
+	},
+	"keywords": [
+		"reader",
+		"readline",
+		"question",
+		"stdin",
+		"stream"
+	],
+	"author": "Kristian Trenskow <this.is@kristians.email>",
+	"license": "BSD-3-Clause",
+	"bugs": {
+		"url": "https://github.com/trenskow/reader/issues"
+	},
+	"homepage": "https://github.com/trenskow/reader#readme",
+	"devDependencies": {
+		"@eslint/eslintrc": "^3.2.0",
+		"@eslint/js": "^9.17.0",
+		"eslint": "^9.17.0",
+		"globals": "^15.14.0"
+	},
+	"dependencies": {
+		"@trenskow/print": "^0.1.2",
+		"isvalid": "^4.1.27",
+		"keyd": "^2.1.17"
+	}
+}