@markuplint/cli-utils 4.0.0-alpha.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2024 Yusuke Hirao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,18 @@
+# @markuplint/cli-utils
+
+[![npm version](https://badge.fury.io/js/%40markuplint%2Fcli-utils.svg)](https://www.npmjs.com/package/@markuplint/cli-utils)
+
+## Install
+
+[`markuplint`](https://www.npmjs.com/package/markuplint) package includes this package.
+
+<details>
+<summary>If you are installing purposely, how below:</summary>
+
+```shell
+$ npm install @markuplint/cli-utils
+
+$ yarn add @markuplint/cli-utils
+```
+
+</details>

package/lib/const.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Brand color (xTerm color)
+ *
+ * @see http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html
+ */
+export declare const PRIMARY_COLOR = 33;

package/lib/const.js

@@ -0,0 +1,6 @@
+/**
+ * Brand color (xTerm color)
+ *
+ * @see http://www.calmar.ws/vim/256-xterm-24bit-rgb-color-chart.html
+ */
+export const PRIMARY_COLOR = 33;

package/lib/get-width.d.ts

@@ -0,0 +1 @@
+export declare function getWidth(s: string): number;

package/lib/get-width.js

@@ -0,0 +1,12 @@
+// @ts-ignore
+import eastasianwidth from 'eastasianwidth';
+const eaw = eastasianwidth;
+export function getWidth(s) {
+    return s.replaceAll(
+    // All characters
+    /./g, 
+    // Wide characters to multi dots
+    char => '•'.repeat(
+    // Get the number of character width
+    eaw.characterLength(char))).length;
+}

package/lib/header.d.ts

@@ -0,0 +1 @@
+export declare const header: (subCommandName: string, noColor?: boolean) => string;

package/lib/header.js

@@ -0,0 +1,38 @@
+import module from 'node:module';
+import c from 'cli-color';
+import stripAnsi from 'strip-ansi';
+import { logo } from './logo.js';
+import { name } from './name.js';
+const require = module.createRequire(import.meta.url);
+const version = require('../package.json').version;
+export const header = (subCommandName, noColor) => box([
+    // Logo and name
+    `${logo} ${name}`,
+    // Version
+    c.blackBright(`v${version}`),
+    // Break line
+    '',
+    // Command name
+    c.bold(subCommandName),
+], {
+    center: true,
+    noColor,
+});
+function box(lines, { width = 40, padding = 1, center = false, noColor = false }) {
+    const bt = `┌${'─'.repeat(width - 2)}┐`;
+    const pd = `│${' '.repeat(width - 2)}│`;
+    const bb = `└${'─'.repeat(width - 2)}┘`;
+    const texts = lines.map(line => {
+        const nc = stripAnsi(line);
+        const length = nc.length;
+        const pad = width - 2 - 1 - length;
+        const pad2 = Math.floor(pad / 2);
+        const padD = pad % 2;
+        const padL = center ? pad2 : 0;
+        const padR = center ? pad2 + padD : pad;
+        const text = noColor ? nc : line;
+        return `│ ${' '.repeat(padL)}${text}${' '.repeat(padR)}│`;
+    });
+    const result = [bt, pd, ...texts, pd, bb];
+    return result.join('\n');
+}

package/lib/index.d.ts

@@ -0,0 +1,10 @@
+export { default as font } from 'cli-color';
+export { input, confirm, confirmSequence, select, multiSelect } from './prompt.js';
+export { installModule, InstallModuleResult } from './install-module.js';
+export { getWidth } from './get-width.js';
+export { header } from './header.js';
+export { invisibleSpace } from './invisible-space.js';
+export { messageToString } from './message-to-string.js';
+export { name } from './name.js';
+export { pad } from './pad.js';
+export { space } from './space.js';

package/lib/index.js

@@ -0,0 +1,10 @@
+export { default as font } from 'cli-color';
+export { input, confirm, confirmSequence, select, multiSelect } from './prompt.js';
+export { installModule } from './install-module.js';
+export { getWidth } from './get-width.js';
+export { header } from './header.js';
+export { invisibleSpace } from './invisible-space.js';
+export { messageToString } from './message-to-string.js';
+export { name } from './name.js';
+export { pad } from './pad.js';
+export { space } from './space.js';

package/lib/install-module.d.ts

@@ -0,0 +1,5 @@
+export type InstallModuleResult = {
+    success: boolean;
+    alreadyExists: boolean;
+};
+export declare function installModule(module: readonly string[], dev?: boolean): Promise<InstallModuleResult>;

package/lib/install-module.js

@@ -0,0 +1,64 @@
+import { spawnSync } from 'node:child_process';
+import c from 'cli-color';
+// @ts-ignore
+import detectInstalled from 'detect-installed';
+import hasYarn from 'has-yarn';
+export async function installModule(module, dev = false) {
+    module = module.map(m => m.trim());
+    const uninstallMods = [];
+    try {
+        for (const mod of module) {
+            const installed = await isInstalled(mod);
+            if (!installed) {
+                uninstallMods.push(mod);
+            }
+        }
+    }
+    catch {
+        // void
+    }
+    if (uninstallMods.length === 0) {
+        return {
+            success: true,
+            alreadyExists: true,
+        };
+    }
+    const mod = hasYarn() ? 'yarn' : 'npm';
+    const installOpt = hasYarn() ? 'add' : 'install';
+    const opt = [installOpt];
+    if (dev) {
+        opt.push('-D');
+    }
+    if (!hasYarn()) {
+        opt.push('--legacy-peer-deps');
+    }
+    opt.push(...uninstallMods);
+    return new Promise((resolve, reject) => {
+        process.stdout.write(c.blackBright(`${mod} ${opt.join(' ')}\n`));
+        const result = spawnSync(mod, opt, { stdio: 'inherit' });
+        if (result.error || result.status !== 0) {
+            const message = 'Error running command.';
+            const error = new Error(message);
+            error.stack = message;
+            reject(error);
+        }
+        resolve({
+            success: true,
+            alreadyExists: false,
+        });
+    });
+}
+function isInstalled(module) {
+    return new Promise((resolve, reject) => {
+        try {
+            detectInstalled(module, {
+                local: true,
+            }).then((exists) => {
+                resolve(exists);
+            });
+        }
+        catch (error) {
+            reject(error);
+        }
+    });
+}

package/lib/invisible-space.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Convert all characters to space.
+ *
+ * @param str
+ * @returns
+ */
+export declare function invisibleSpace(str: string): string;

package/lib/invisible-space.js

@@ -0,0 +1,13 @@
+/**
+ * Convert all characters to space.
+ *
+ * @param str
+ * @returns
+ */
+export function invisibleSpace(str) {
+    return (str
+        // Tab to 4 spaces
+        .replaceAll('\t', () => '    ')
+        // All characters to space
+        .replaceAll(/./g, () => ' '));
+}

package/lib/logo.d.ts

@@ -0,0 +1 @@
+export declare const logo: string;

package/lib/logo.js

@@ -0,0 +1,3 @@
+import c from 'cli-color';
+import { PRIMARY_COLOR } from './const.js';
+export const logo = `/${c.xterm(PRIMARY_COLOR)('✔')}\\`;

package/lib/message-to-string.d.ts

@@ -0,0 +1 @@
+export declare function messageToString(message: string, reason?: string): string;

package/lib/message-to-string.js

@@ -0,0 +1,6 @@
+export function messageToString(message, reason) {
+    if (!reason) {
+        return message;
+    }
+    return `${message} / ${reason}`;
+}

package/lib/name.d.ts

@@ -0,0 +1 @@
+export declare const name: string;

package/lib/name.js

@@ -0,0 +1,3 @@
+import c from 'cli-color';
+import { PRIMARY_COLOR } from './const.js';
+export const name = `Markup${c.xterm(PRIMARY_COLOR)('lint')}`;

package/lib/pad.d.ts

@@ -0,0 +1 @@
+export declare function pad(s: number | string, pad: number, start?: boolean): string;

package/lib/pad.js

@@ -0,0 +1,7 @@
+import { getWidth } from './get-width.js';
+export function pad(s, pad, start = false) {
+    const l = getWidth(`${s}`.trim());
+    const d = pad - l;
+    const _ = ' '.repeat(d < 0 ? 0 : d);
+    return start ? `${_}${s}` : `${s}${_}`;
+}

package/lib/prompt.d.ts

@@ -0,0 +1,18 @@
+type SelectQuestion<T> = {
+    readonly message: string;
+    readonly choices: readonly {
+        readonly name: string;
+        readonly value: T;
+    }[];
+};
+export declare function select<T>(question: SelectQuestion<T>): Promise<T>;
+export declare function multiSelect<T>(question: SelectQuestion<T>): Promise<T[]>;
+export declare function input<T extends string = string>(question: string, validation?: Readonly<RegExp>): Promise<T>;
+export declare function confirm(question: string, options?: {
+    readonly initial?: boolean;
+}): Promise<boolean>;
+export declare function confirmSequence<T extends string = string>(questions: readonly {
+    readonly message: string;
+    readonly name: T;
+}[]): Promise<Record<T, boolean>>;
+export {};

package/lib/prompt.js

@@ -0,0 +1,67 @@
+import c from 'cli-color';
+import Enquirer from 'enquirer';
+export async function select(question) {
+    const res = await Enquirer.prompt({
+        ...question,
+        name: '__Q__',
+        type: 'select',
+        result(resName) {
+            // @ts-ignore
+            return this.options.choices.find(c => c.name === resName)?.value;
+        },
+    });
+    // @ts-ignore
+    return res['__Q__'];
+}
+export async function multiSelect(question) {
+    const res = await Enquirer.prompt({
+        ...question,
+        name: '__Q__',
+        type: 'multiselect',
+        result(names) {
+            // @ts-ignore
+            const map = this.map(names);
+            // @ts-ignore
+            const values = names.map(name => map[name]);
+            return values;
+        },
+    });
+    // @ts-ignore
+    return res['__Q__'];
+}
+export async function input(question, validation) {
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+        const _res = await Enquirer.prompt({
+            message: question,
+            name: '__Q__',
+            type: 'input',
+        });
+        // @ts-ignore
+        const res = _res['__Q__'];
+        if (validation && !validation.test(res)) {
+            process.stdout.write(c.yellow('Oops! The name that you type is an invalid format.\n'));
+            continue;
+        }
+        return res;
+    }
+}
+export async function confirm(question, options) {
+    const res = await Enquirer.prompt({
+        message: question,
+        name: '__Q__',
+        type: 'confirm',
+        initial: !!options?.initial,
+    });
+    // @ts-ignore
+    return !!res['__Q__'];
+}
+export async function confirmSequence(questions) {
+    const res = await Enquirer.prompt(questions.map(question => {
+        return {
+            ...question,
+            type: 'confirm',
+        };
+    }));
+    return res;
+}

package/lib/space.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Replace space to visible characters.
+ *
+ * @param str
+ * @returns
+ */
+export declare function space(str: string): string;

package/lib/space.js

@@ -0,0 +1,15 @@
+import c from 'cli-color';
+/**
+ * Replace space to visible characters.
+ *
+ * @param str
+ * @returns
+ */
+export function space(str) {
+    return str
+        .replaceAll(/\s+/g, $0 => {
+        return c.xterm(8)($0);
+    })
+        .replaceAll(' ', $0 => '•')
+        .replaceAll('\t', $0 => '→   ');
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+	"name": "@markuplint/cli-utils",
+	"version": "4.0.0-alpha.10",
+	"description": "Utilities for CLI of Markuplint",
+	"repository": "git@github.com:markuplint/markuplint.git",
+	"author": "Yusuke Hirao <yusukehirao@me.com>",
+	"license": "MIT",
+	"private": false,
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./lib/index.js"
+		}
+	},
+	"types": "./lib/index.d.ts",
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "tsc",
+		"dev": "tsc --build --watch",
+		"clean": "tsc --build --clean"
+	},
+	"dependencies": {
+		"cli-color": "^2.0.3",
+		"detect-installed": "^2.0.4",
+		"eastasianwidth": "^0.2.0",
+		"enquirer": "^2.4.1",
+		"has-yarn": "^3.0.0",
+		"strip-ansi": "^7.1.0"
+	},
+	"devDependencies": {
+		"@types/cli-color": "^2.0.6"
+	},
+	"gitHead": "b41153ea665aa8f091daf6114a06047f4ccb8350"
+}