@zokugun/artifact 0.7.0 → 0.8.0

package/README.md

@@ -68,6 +68,26 @@ Artifacts published to npm must be prefixed with `artifact-`.
 Command Reference
 -----------------
 
+### Usage
+
+```
+Usage: artifact [options] [command]
+
+Boilerplate your project & keep your configurations up to date
+
+Options:
+  -v, --version                       output the version number
+  -h, --help                          display help for command
+
+Commands:
+  add [options] <artifacts...>        add an artifact to the current project
+  list|ls                             list the installed artifacts in the project
+  outdated|od                         check for outdated artifacts
+  remove|rm [options] [artifacts...]  remove an artifact from the current project
+  update|up [options]                 update the current project using the installed artifacts
+  help [command]                      display help for command
+```
+
 ### `artifact add`
 
 Registers and applies one or more artifacts in the current project.
@@ -78,12 +98,12 @@ Registers and applies one or more artifacts in the current project.
 
 `<artifact>` can be `name` or `name:variant`.
 
-### `artifact list` / `artifact l`
+### `artifact list` / `artifact ls`
 
 Shows the artifacts currently tracked in `.artifactrc*`, including versions and, when available, requested variants.
 
 - Syntax: `artifact list`
-- Alias: `artifact l`
+- Alias: `artifact ls`
 - Output: prints each artifact as `name@version:variant`.
 
 ### `artifact update` / `artifact up`

package/lib/cli.js

@@ -28,23 +28,28 @@ program
     .argument('<artifacts...>')
     .action(index_js_1.add);
 program
-    .command('update')
-    .description('update the current project using the installed artifacts')
-    .option('-d, --dry-run', 'fake update')
-    .option('--verbose', 'output more details')
-    .alias('up')
-    .action(index_js_1.update);
+    .command('list')
+    .description('list the installed artifacts in the project')
+    .alias('ls')
+    .action(index_js_1.list);
+program
+    .command('outdated')
+    .description('check for outdated artifacts')
+    .alias('od')
+    .action(index_js_1.outdated);
 program
     .command('remove')
     .description('remove an artifact from the current project')
     .option('-d, --dry-run', 'fake uninstall')
     .option('--verbose', 'output more details')
-    .argument('<artifacts...>')
+    .argument('[artifacts...]')
     .alias('rm')
     .action(index_js_1.remove);
 program
-    .command('list')
-    .description('list the installed artifacts in the project')
-    .alias('l')
-    .action(index_js_1.list);
+    .command('update')
+    .description('update the current project using the installed artifacts')
+    .option('-d, --dry-run', 'fake update')
+    .option('--verbose', 'output more details')
+    .alias('up')
+    .action(index_js_1.update);
 program.parse();

package/lib/commands/add.js

@@ -4,11 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.add = add;
-const process_1 = __importDefault(require("process"));
+const node_process_1 = __importDefault(require("node:process"));
 const cli_utils_1 = require("@zokugun/cli-utils");
+const async_1 = require("@zokugun/xtry/async");
 const pacote_1 = __importDefault(require("pacote"));
 const tempy_1 = __importDefault(require("tempy"));
 const index_js_1 = require("../configs/index.js");
+const read_listing_config_js_1 = require("../configs/package/read-listing-config.js");
 const index_js_2 = require("../steps/index.js");
 const resolve_request_js_1 = require("../utils/resolve-request.js");
 const { mainFlow } = (0, index_js_2.composeSteps)([
@@ -35,7 +37,7 @@ const { mainFlow } = (0, index_js_2.composeSteps)([
 ]);
 async function add(specs, inputOptions) {
     cli_utils_1.logger.beginTimer();
-    const targetPath = process_1.default.cwd();
+    const targetPath = node_process_1.default.cwd();
     const options = {
         dryRun: inputOptions?.dryRun ?? false,
         force: inputOptions?.force ?? false,
@@ -53,6 +55,47 @@ async function add(specs, inputOptions) {
         cli_utils_1.logger.fatal(configResult.error);
     }
     const { config, configStats } = configResult.value;
+    if (specs.length === 1 && /^@\w+$/.test(specs[0])) {
+        const request = `${specs.shift()}/artifact-listing`;
+        const spinner = cli_utils_1.logger.createSpinner(`${cli_utils_1.c.cyan.bold(request)}`);
+        const dir = tempy_1.default.directory();
+        const pkgResult = await (0, async_1.xtry)(pacote_1.default.extract(request, dir));
+        if (pkgResult.fails) {
+            cli_utils_1.logger.fatal(`The artifact '${request}' couldn't be found.`);
+        }
+        spinner.succeed();
+        cli_utils_1.logger.stopProgress();
+        const listing = await (0, read_listing_config_js_1.readListingConfig)(dir);
+        if (listing.fails) {
+            cli_utils_1.logger.fatal(listing.error);
+        }
+        const { value } = await (0, async_1.xtry)(cli_utils_1.enquirer.prompt({
+            type: 'multiselect',
+            name: 'specs',
+            message: 'Pick the artifacts to add',
+            // @ts-expect-error TS2353
+            limit: 7,
+            choices: listing.value.map(({ name, description }) => ({ name, message: `${name}${cli_utils_1.c.grey(`: ${description}`)}` })),
+        }));
+        const marked = value?.specs;
+        if (!marked || marked.length === 0) {
+            cli_utils_1.logger.warn('No artifacts marked for addition');
+        }
+        else {
+            const { value } = await (0, async_1.xtry)(cli_utils_1.enquirer.prompt([
+                (0, cli_utils_1.confirm)({
+                    name: 'addition',
+                    message: `Adds the following artifacts: ${marked.map((name) => cli_utils_1.c.green(name)).join(',')}`,
+                }),
+            ]));
+            if (value?.addition) {
+                specs.push(...marked);
+            }
+            else {
+                cli_utils_1.logger.warn('Artifacts addition has been rejected');
+            }
+        }
+    }
     for (const spec of specs) {
         const requestResult = (0, resolve_request_js_1.resolveRequest)(spec);
         if (requestResult.fails) {

package/lib/commands/index.d.ts

@@ -1,4 +1,5 @@
 export { add } from './add.js';
 export { list } from './list.js';
+export { outdated } from './outdated.js';
 export { remove } from './remove.js';
 export { update } from './update.js';

package/lib/commands/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.update = exports.remove = exports.list = exports.add = void 0;
+exports.update = exports.remove = exports.outdated = exports.list = exports.add = void 0;
 var add_js_1 = require("./add.js");
 Object.defineProperty(exports, "add", { enumerable: true, get: function () { return add_js_1.add; } });
 var list_js_1 = require("./list.js");
 Object.defineProperty(exports, "list", { enumerable: true, get: function () { return list_js_1.list; } });
+var outdated_js_1 = require("./outdated.js");
+Object.defineProperty(exports, "outdated", { enumerable: true, get: function () { return outdated_js_1.outdated; } });
 var remove_js_1 = require("./remove.js");
 Object.defineProperty(exports, "remove", { enumerable: true, get: function () { return remove_js_1.remove; } });
 var update_js_1 = require("./update.js");

package/lib/commands/list.js

@@ -4,12 +4,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.list = list;
+const node_path_1 = __importDefault(require("node:path"));
 const process_1 = __importDefault(require("process"));
 const cli_utils_1 = require("@zokugun/cli-utils");
-const lodash_es_1 = require("lodash-es");
+const async_1 = __importDefault(require("@zokugun/fs-extra-plus/async"));
+const xtry_1 = require("@zokugun/xtry");
 const index_js_1 = require("../configs/index.js");
+const format_table_js_1 = require("../utils/format-table.js");
 function formatVariant(artifact) {
-    const variant = Array.isArray(artifact.requires) ? (0, lodash_es_1.last)(artifact.requires) ?? '' : '';
+    const variant = Array.isArray(artifact.requires) ? artifact.requires.at(-1) ?? '' : '';
     if (variant.length > 0) {
         return `:${variant}`;
     }
@@ -18,22 +21,37 @@ function formatVariant(artifact) {
     }
 }
 async function list() {
-    const targetPath = process_1.default.env.INIT_CWD;
+    const targetPath = process_1.default.cwd();
     const configResult = await (0, index_js_1.readInstallConfig)(targetPath);
     if (configResult.fails) {
         cli_utils_1.logger.fatal(configResult.error);
     }
+    const packageResult = await async_1.default.readJSON(node_path_1.default.resolve(targetPath, './package.json'));
+    if (packageResult.fails) {
+        cli_utils_1.logger.fatal((0, xtry_1.stringifyError)(packageResult.error));
+    }
+    const { name } = packageResult.value;
     const { config, configStats } = configResult.value;
     const artifacts = Object.entries(config.artifacts);
+    cli_utils_1.logger.newLine();
     if (artifacts.length === 0) {
         cli_utils_1.logger.info('No artifacts have been installed.');
     }
     else {
-        cli_utils_1.logger.info(`List of installed artifacts (${configStats.name}):\n`);
+        cli_utils_1.logger.print(`${name} ${cli_utils_1.c.grey(configStats.name)}`);
+        cli_utils_1.logger.newLine();
+        const table = [];
         for (const [name, artifact] of artifacts) {
-            const version = artifact.version ? `@${artifact.version}` : '';
-            cli_utils_1.logger.info(`- ${name}${version}${formatVariant(artifact)}`);
+            const line = [
+                ' ',
+                name,
+                ' ',
+                artifact.version ? `${cli_utils_1.c.green(artifact.version)}${cli_utils_1.c.gray(formatVariant(artifact))}` : '',
+            ];
+            table.push(line);
         }
+        const lines = (0, format_table_js_1.formatTable)(table, 'LLLL');
+        cli_utils_1.logger.print(lines.join('\n'));
     }
     cli_utils_1.logger.newLine();
 }

package/lib/commands/outdated.d.ts

@@ -0,0 +1 @@
+export declare function outdated(): Promise<void>;

package/lib/commands/outdated.js

@@ -0,0 +1,73 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.outdated = outdated;
+const node_path_1 = __importDefault(require("node:path"));
+const process_1 = __importDefault(require("process"));
+const cli_utils_1 = require("@zokugun/cli-utils");
+const async_1 = __importDefault(require("@zokugun/fs-extra-plus/async"));
+const xtry_1 = require("@zokugun/xtry");
+const cli_progress_1 = require("cli-progress");
+const pacote_1 = __importDefault(require("pacote"));
+const semver_1 = require("semver");
+const index_js_1 = require("../configs/index.js");
+const format_table_js_1 = require("../utils/format-table.js");
+const time_difference_js_1 = require("../utils/time-difference.js");
+async function outdated() {
+    const targetPath = process_1.default.cwd();
+    const configResult = await (0, index_js_1.readInstallConfig)(targetPath);
+    if (configResult.fails) {
+        cli_utils_1.logger.fatal(configResult.error);
+    }
+    const packageResult = await async_1.default.readJSON(node_path_1.default.resolve(targetPath, './package.json'));
+    if (packageResult.fails) {
+        cli_utils_1.logger.fatal((0, xtry_1.stringifyError)(packageResult.error));
+    }
+    const { name } = packageResult.value;
+    const { config, configStats } = configResult.value;
+    const artifacts = Object.entries(config.artifacts);
+    cli_utils_1.logger.newLine();
+    if (artifacts.length === 0) {
+        cli_utils_1.logger.info('No artifacts have been installed.');
+    }
+    else {
+        cli_utils_1.logger.print(`${name} ${cli_utils_1.c.grey(configStats.name)}`);
+        const bar = new cli_progress_1.SingleBar({
+            clearOnComplete: true,
+            hideCursor: true,
+            format: `{bar} {value}/{total} ${cli_utils_1.c.gray('{name}')}`,
+            linewrap: false,
+            barsize: 40,
+        }, cli_progress_1.Presets.shades_classic);
+        bar.start(artifacts.length, 0);
+        const table = [];
+        for (const [index, [name, artifact]] of artifacts.entries()) {
+            const current = await pacote_1.default.manifest(`${name}@${artifact.version}`, {
+                fullMetadata: true,
+            });
+            const latest = await pacote_1.default.manifest(name, {
+                fullMetadata: true,
+            });
+            const newer = (0, semver_1.gt)(latest.version, artifact.version);
+            const line = [
+                ' ',
+                newer ? name : cli_utils_1.c.grey(name),
+                ' ',
+                (0, time_difference_js_1.timeDifference)(current._time),
+                artifact.version ? cli_utils_1.c.grey(artifact.version) : '',
+                cli_utils_1.c.dim.grey('→'),
+                newer ? latest.version : cli_utils_1.c.grey.strikethrough(latest.version),
+                newer ? (0, time_difference_js_1.timeDifference)(latest._time) : '',
+            ];
+            table.push(line);
+            bar.update(index, { name });
+        }
+        bar.stop();
+        cli_utils_1.logger.newLine();
+        const lines = (0, format_table_js_1.formatTable)(table, 'LLLLRRRL');
+        cli_utils_1.logger.print(lines.join('\n'));
+    }
+    cli_utils_1.logger.newLine();
+}

package/lib/commands/remove.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.remove = remove;
 const process_1 = __importDefault(require("process"));
 const cli_utils_1 = require("@zokugun/cli-utils");
+const async_1 = require("@zokugun/xtry/async");
 const pacote_1 = __importDefault(require("pacote"));
 const tempy_1 = __importDefault(require("tempy"));
 const index_js_1 = require("../configs/index.js");
@@ -43,6 +44,32 @@ async function remove(specs, inputOptions) {
         cli_utils_1.logger.fatal(configResult.error);
     }
     const { config, configStats } = configResult.value;
+    if (specs.length === 0) {
+        const { value } = await (0, async_1.xtry)(cli_utils_1.enquirer.prompt({
+            type: 'multiselect',
+            name: 'specs',
+            message: 'Pick the artifacts to remove',
+            choices: Object.keys(config.artifacts).map((name) => ({ name })),
+        }));
+        const marked = value?.specs;
+        if (!marked || marked.length === 0) {
+            cli_utils_1.logger.warn('No artifacts marked for removal');
+        }
+        else {
+            const { value } = await (0, async_1.xtry)(cli_utils_1.enquirer.prompt([
+                (0, cli_utils_1.confirm)({
+                    name: 'remove',
+                    message: `Remove the following artifacts: ${marked.map((name) => cli_utils_1.c.green(name)).join(',')}`,
+                }),
+            ]));
+            if (value?.remove) {
+                specs.push(...marked);
+            }
+            else {
+                cli_utils_1.logger.warn('Artifacts removal has been rejected');
+            }
+        }
+    }
     for (const spec of specs) {
         const requestResult = (0, resolve_request_js_1.resolveRequest)(spec);
         if (requestResult.fails) {

package/lib/configs/package/read-listing-config.d.ts

@@ -0,0 +1,7 @@
+import { type AsyncDResult } from '@zokugun/xtry';
+export type Listing = ListingEntry[];
+export type ListingEntry = {
+    name: string;
+    description: string;
+};
+export declare function readListingConfig(targetPath: string): AsyncDResult<Listing>;

package/lib/configs/package/read-listing-config.js

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readListingConfig = readListingConfig;
+const path_1 = __importDefault(require("path"));
+const async_1 = __importDefault(require("@zokugun/fs-extra-plus/async"));
+const is_it_type_1 = require("@zokugun/is-it-type");
+const xtry_1 = require("@zokugun/xtry");
+const yaml_1 = __importDefault(require("yaml"));
+const CONFIG_LOCATIONS = [
+    {
+        name: 'artifact-listing.yml',
+        type: 'yaml',
+    },
+    {
+        name: 'artifact-listing.yaml',
+        type: 'yaml',
+    },
+    {
+        name: 'artifact-listing.json',
+        type: 'json',
+    },
+];
+async function readListingConfig(targetPath) {
+    let content;
+    let name;
+    let type;
+    for (const place of CONFIG_LOCATIONS) {
+        const result = await async_1.default.readFile(path_1.default.join(targetPath, place.name), 'utf8');
+        if (!result.fails) {
+            content = result.value;
+            ({ name, type } = place);
+        }
+    }
+    if (!content) {
+        return normalizeConfig(content, name);
+    }
+    if (type === 'json') {
+        return normalizeConfig(JSON.parse(content), name);
+    }
+    else if (type === 'yaml') {
+        return normalizeConfig(yaml_1.default.parse(content), name);
+    }
+    else {
+        try {
+            return normalizeConfig(JSON.parse(content), name);
+        }
+        catch {
+            return normalizeConfig(yaml_1.default.parse(content), name);
+        }
+    }
+}
+function normalizeConfig(data, source) {
+    if (!(0, is_it_type_1.isArray)(data)) {
+        return (0, xtry_1.err)(`Listing file ${source} must export an array.`);
+    }
+    for (const entry of data) {
+        if (!(0, is_it_type_1.isRecord)(entry)) {
+            return (0, xtry_1.err)('Listing entry must be an object.');
+        }
+        if (!(0, is_it_type_1.isString)(entry.name)) {
+            return (0, xtry_1.err)('Listing entry/name must be a string.');
+        }
+        if (!(0, is_it_type_1.isString)(entry.description)) {
+            return (0, xtry_1.err)('Listing entry/description must be a string.');
+        }
+    }
+    return (0, xtry_1.ok)(data);
+} // }}}

package/lib/utils/format-table.d.ts

@@ -0,0 +1 @@
+export declare function formatTable(rows: string[][], align: string, spaces?: string): string[];

package/lib/utils/format-table.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatTable = formatTable;
+const node_util_1 = require("node:util");
+function formatTable(rows, align, spaces = '  ') {
+    const maxLength = [];
+    for (const row of rows) {
+        for (const [index, cell] of row.entries()) {
+            const length = getVisualLength(cell);
+            if (!maxLength[index] || maxLength[index] < length) {
+                maxLength[index] = length;
+            }
+        }
+    }
+    const lines = [];
+    for (const row of rows) {
+        const cells = [];
+        for (const [index, cell] of row.entries()) {
+            const pad = align[index] === 'R' ? visualPadStart : visualPadEnd;
+            cells.push(pad(cell, maxLength[index]));
+        }
+        lines.push(cells.join(spaces));
+    }
+    return lines;
+}
+function getVisualLength(cell) {
+    if (cell === '') {
+        return 0;
+    }
+    cell = (0, node_util_1.stripVTControlCharacters)(cell);
+    let width = 0;
+    for (let i = 0; i < cell.length; i++) {
+        const code = cell.codePointAt(i);
+        if (!code) {
+            continue;
+        }
+        // Ignore control characters
+        if (code <= 0x1F || (code >= 0x7F && code <= 0x9F)) {
+            continue;
+        }
+        // Ignore combining characters
+        if (code >= 0x3_00 && code <= 0x3_6F) {
+            continue;
+        }
+        // Surrogates
+        if (code > 0xFF_FF) {
+            i++;
+        }
+        width += 1;
+    }
+    return width;
+}
+function visualPadStart(text, pad, char = ' ') {
+    return text.padStart(pad - getVisualLength(text) + text.length, char);
+}
+function visualPadEnd(text, pad, char = ' ') {
+    return text.padEnd(pad - getVisualLength(text) + text.length, char);
+}

package/lib/utils/time-difference.d.ts

@@ -0,0 +1 @@
+export declare function timeDifference(from: number | string, to?: number): string;

package/lib/utils/time-difference.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timeDifference = timeDifference;
+const cli_utils_1 = require("@zokugun/cli-utils");
+const is_it_type_1 = require("@zokugun/is-it-type");
+const msPerMinute = 60 * 1000;
+const msPerHour = msPerMinute * 60;
+const msPerDay = msPerHour * 24;
+const msPerMonth = msPerDay * 30;
+const msPerYear = msPerDay * 365;
+function timeDifference(from, to = Date.now()) {
+    if ((0, is_it_type_1.isString)(from)) {
+        from = (new Date(from)).getTime();
+    }
+    const elapsed = to - from;
+    if (elapsed < msPerDay) {
+        return cli_utils_1.c.gray('⩽1d');
+    }
+    else if (elapsed < msPerMonth) {
+        return cli_utils_1.c.green(`~${Math.round(elapsed / msPerDay)}d`);
+    }
+    else if (elapsed < msPerYear) {
+        return cli_utils_1.c.yellow(`~${Math.round(elapsed / msPerMonth)}mo`);
+    }
+    else {
+        return cli_utils_1.c.red(`~${(elapsed / msPerYear).toFixed(1)}y`);
+    }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@zokugun/artifact",
 	"description": "Boilerplate your project & keep your configurations up to date",
-	"version": "0.7.0",
+	"version": "0.8.0",
 	"author": {
 		"name": "Baptiste Augrain",
 		"email": "daiyam@zokugun.org"
@@ -37,7 +37,7 @@
 		"release": "release-it",
 		"test": "tsc -p test && mocha",
 		"test:dev": "mocha",
-		"test:watch": "tsc-watch -p src -p test --onSuccess 'mocha -g=\"vars.exp.pipe.gitname.dotprop\"'",
+		"test:watch": "tsc-watch -p src -p test --onSuccess 'mocha -g=\"\"'",
 		"update:artifacts": "artifact update",
 		"update:ci": "PINACT_MIN_AGE=7 pinact run",
 		"update:deps": "taze",
@@ -46,11 +46,13 @@
 		"watch:test": "tsc-watch -p test"
 	},
 	"dependencies": {
+		"@types/cli-progress": "^3.11.6",
 		"@zokugun/cli-utils": "0.3.1",
 		"@zokugun/configdotts-merge": "0.2.1",
 		"@zokugun/fs-extra-plus": "0.3.7",
 		"@zokugun/is-it-type": "0.8.1",
 		"@zokugun/xtry": "0.11.4",
+		"cli-progress": "^3.12.0",
 		"dayjs": "1.11.20",
 		"editorconfig": "0.15.3",
 		"git-url-parse": "16.1.0",