@zokugun/artifact 0.6.3 → 0.7.0

package/lib/cli.js

@@ -8,27 +8,37 @@ const package_json_1 = __importDefault(require("../package.json"));
 const index_js_1 = require("./commands/index.js");
 const program = new commander_1.Command();
 program
-    .version(package_json_1.default.version, '-V, --version')
+    .version(package_json_1.default.version, '-v, --version')
     .description(package_json_1.default.description);
 program
     .command('add')
     .description('add an artifact to the current project')
     .option('-d, --dry-run', 'fake install')
-    .option('-v, --verbose', 'output more details')
+    .option('--verbose', 'output more details')
+    .option('--var <name=value>', 'pass a variable (format: name=value), repeatable', (pair, previous = []) => {
+    const index = pair.indexOf('=');
+    if (index === -1) {
+        throw new Error('--var expects format name=value');
+    }
+    const name = pair.slice(0, index);
+    const value = pair.slice(index + 1);
+    previous.push({ name, value });
+    return previous;
+}, [])
     .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('-v, --verbose', 'output more details')
+    .option('--verbose', 'output more details')
     .alias('up')
     .action(index_js_1.update);
 program
     .command('remove')
     .description('remove an artifact from the current project')
     .option('-d, --dry-run', 'fake uninstall')
-    .option('-v, --verbose', 'output more details')
+    .option('--verbose', 'output more details')
     .argument('<artifacts...>')
     .alias('rm')
     .action(index_js_1.remove);

package/lib/commands/add.d.ts

@@ -1,6 +1,12 @@
-export declare function add(specs: string[], inputOptions?: {
+type CLIOptions = {
+    dryRun?: boolean;
     force?: boolean;
     skip?: boolean;
+    var?: Array<{
+        name: string;
+        value: string;
+    }>;
     verbose?: boolean;
-    dryRun?: boolean;
-}): Promise<void>;
+};
+export declare function add(specs: string[], inputOptions?: CLIOptions): Promise<void>;
+export {};

package/lib/commands/add.js

@@ -37,11 +37,17 @@ async function add(specs, inputOptions) {
     cli_utils_1.logger.beginTimer();
     const targetPath = process_1.default.cwd();
     const options = {
+        dryRun: inputOptions?.dryRun ?? false,
         force: inputOptions?.force ?? false,
         skip: inputOptions?.skip ?? false,
+        variables: {},
         verbose: inputOptions?.verbose ?? false,
-        dryRun: inputOptions?.dryRun ?? false,
     };
+    if (inputOptions?.var) {
+        for (const { name, value } of inputOptions.var) {
+            options.variables[name] = value;
+        }
+    }
     const configResult = await (0, index_js_1.readInstallConfig)(targetPath);
     if (configResult.fails) {
         cli_utils_1.logger.fatal(configResult.error);

package/lib/commands/remove.js

@@ -32,10 +32,11 @@ async function remove(specs, inputOptions) {
     cli_utils_1.logger.beginTimer();
     const targetPath = process_1.default.cwd();
     const options = {
+        dryRun: inputOptions?.dryRun ?? false,
         force: inputOptions?.force ?? false,
         skip: inputOptions?.skip ?? false,
+        variables: {},
         verbose: inputOptions?.verbose ?? false,
-        dryRun: inputOptions?.dryRun ?? false,
     };
     const configResult = await (0, index_js_1.readInstallConfig)(targetPath);
     if (configResult.fails) {

package/lib/commands/update.js

@@ -37,10 +37,11 @@ async function update(inputOptions) {
     cli_utils_1.logger.beginTimer();
     const targetPath = process_1.default.cwd();
     const options = {
+        dryRun: inputOptions?.dryRun ?? false,
         force: inputOptions?.force ?? false,
         skip: false,
+        variables: {},
         verbose: inputOptions?.verbose ?? false,
-        dryRun: inputOptions?.dryRun ?? false,
     };
     const configResult = await (0, index_js_1.readInstallConfig)(targetPath);
     if (configResult.fails) {

package/lib/steps/replace-templates.d.ts

@@ -1,3 +1,3 @@
 import { type AsyncDResult } from '@zokugun/xtry';
 import { type Context } from '../types/context.js';
-export declare function replaceTemplates({ textFiles, binaryFiles, targetPath, config, incomingConfig }: Context): AsyncDResult;
+export declare function replaceTemplates({ textFiles, binaryFiles, targetPath, config, incomingConfig, options }: Context): AsyncDResult;

package/lib/steps/replace-templates.js

@@ -3,10 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.replaceTemplates = replaceTemplates;
 const xtry_1 = require("@zokugun/xtry");
 const template_js_1 = require("../utils/template.js");
-async function replaceTemplates({ textFiles, binaryFiles, targetPath, config, incomingConfig }) {
+async function replaceTemplates({ textFiles, binaryFiles, targetPath, config, incomingConfig, options }) {
     const variables = {
         ...incomingConfig?.variables,
         ...config?.variables,
+        ...options.variables,
     };
     const engine = new template_js_1.TemplateEngine(targetPath, variables);
     for (const file of textFiles) {

package/lib/steps/validate-not-present-package.js

@@ -12,12 +12,12 @@ async function validateNotPresentPackage({ incomingPackage, config, options }) {
     if (artifact) {
         if (options.skip) {
             if (options.verbose) {
-                cli_utils_1.logger.debug('The incoming artifact is already present, skipping...');
+                cli_utils_1.logger.debug(`The "${name}" artifact is already present, skipping...`);
             }
             return xtry_1.OK_TRUE;
         }
         else {
-            return (0, xtry_1.err)('The incoming artifact has already been added.');
+            return (0, xtry_1.err)(`The "${name}" artifact has already been added.`);
         }
     }
     return xtry_1.OK;

package/lib/types/context.d.ts

@@ -1,3 +1,4 @@
+import { type Primitive } from '@zokugun/is-it-type';
 import { type AsyncDResult } from '@zokugun/xtry';
 import { type BinaryFile } from './binary-file.js';
 import { type Request, type InstallConfig, type PackageConfig, type ArtifactResult, type PackageManifest, type FileTransform } from './config.js';
@@ -45,6 +46,7 @@ export type Options = {
     skip: boolean;
     verbose: boolean;
     dryRun: boolean;
+    variables: Record<string, Primitive>;
 };
 export type Block = {
     name: string;

package/lib/types/context.js

@@ -1,6 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// export type OutputTextFile = {
-// 	data: string;
-// 	name: string;
-// };

package/lib/utils/template.d.ts

@@ -8,6 +8,7 @@ export declare class TemplateEngine {
     constructor(basePath: string, variables?: Record<string, Primitive>);
     render(template: string): DResult<string>;
     private getValueByPath;
+    private evaluateExpression;
     private parseFile;
     private readConfigFile;
     private resolveExpression;
@@ -15,4 +16,3 @@ export declare class TemplateEngine {
     private splitPlaceholder;
     private toDate;
 }
-export declare function unescapeCode(code: string): string;

package/lib/utils/template.js

@@ -37,19 +37,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TemplateEngine = void 0;
-exports.unescapeCode = unescapeCode;
 const path_1 = __importDefault(require("path"));
 const sync_1 = __importDefault(require("@zokugun/fs-extra-plus/sync"));
 const is_it_type_1 = require("@zokugun/is-it-type");
 const xtry_1 = require("@zokugun/xtry");
 const dayjs_1 = __importDefault(require("dayjs"));
 const utc_1 = __importDefault(require("dayjs/plugin/utc"));
+const git_url_parse_1 = __importDefault(require("git-url-parse"));
 const lodash_es_1 = require("lodash-es");
 const YAML = __importStar(require("../parsers/yaml.js"));
 const try_json_js_1 = require("./try-json.js");
 dayjs_1.default.extend(utc_1.default);
 const EXPRESSION_REGEX = /#\[\[(.*?)]]/g;
-const NEXT_PROPERTY_REGEX = /^(\w+?)((?=\.|$).*)$/;
+const PATH_PROPERTY_REGEX = /^(\w+?)(?:\.|$)(.*)$/;
+const PIPE_SEPARATOR_REGEX = /\s*\|>\s*/;
+// Pattern: |> fn(_).prop
+const PIPE_CALL_REGEX = /^([A-Za-z_$][\w$]*(?:\.[A-Za-z_$][\w$]*)*)\(\s*_\s*\)\s*(\.\s*.*?)\s*$/;
+// Pattern: |> fn
+const PIPE_FUNCTION_REGEX = /^([A-Za-z_$][\w$]+(?:\.[A-Za-z_$][\w$]*)*)\s*$/;
+// Pattern: |> _.prop
+const PIPE_PROPERTY_REGEX = /^_\.\s*(.*?)\s*$/;
 const PLACEHOLDER_REGEX = /^((?:[^/.]+(?:[^/]+\/)*\/)?\.?[^.]+(?:\.(?:json|ya?ml))?)\.(.*)$/;
 class TemplateEngine {
     basePath;
@@ -79,7 +86,7 @@ class TemplateEngine {
         let currentPath = propertyPath;
         let currentValue = values;
         let match;
-        while ((match = NEXT_PROPERTY_REGEX.exec(currentPath))) {
+        while ((match = PATH_PROPERTY_REGEX.exec(currentPath))) {
             if (!(0, lodash_es_1.isPlainObject)(currentValue)) {
                 return (0, xtry_1.err)(`Property path not found: ${propertyPath}`);
             }
@@ -89,12 +96,51 @@ class TemplateEngine {
             }
             currentPath = match[2];
             if (currentPath.length === 0) {
-                return (0, xtry_1.ok)(currentValue);
+                return (0, xtry_1.ok)({ value: currentValue });
             }
         }
+        return (0, xtry_1.ok)({ value: currentValue, expression: `.${currentPath}` });
+    } // }}}
+    evaluateExpression(expression, values) {
+        const operands = expression.split(PIPE_SEPARATOR_REGEX);
+        const root = this.getValueByPath(values, operands.shift());
+        if (root.fails) {
+            return root;
+        }
+        const { value, expression: rootExpression } = root.value;
+        if (operands.length === 0) {
+            if ((0, is_it_type_1.isNonEmptyString)(rootExpression)) {
+                // eslint-disable-next-line no-new-func
+                const fn = new Function('it', `return it${unescapeCode(rootExpression)};`);
+                return (0, xtry_1.ok)(fn(value));
+            }
+            else {
+                return (0, xtry_1.ok)(value);
+            }
+        }
+        const lines = [];
+        if ((0, is_it_type_1.isNonEmptyString)(rootExpression)) {
+            lines.push(`it = it${unescapeCode(rootExpression)};`);
+        }
+        let match = null;
+        for (const operand of operands) {
+            if ((match = PIPE_FUNCTION_REGEX.exec(operand))) {
+                lines.push(`it = ${unescapeCode(match[1])}(it);`);
+            }
+            else if ((match = PIPE_PROPERTY_REGEX.exec(operand))) {
+                lines.push(`it = it.${unescapeCode(match[1])};`);
+            }
+            else if ((match = PIPE_CALL_REGEX.exec(operand))) {
+                lines.push(`it = ${unescapeCode(match[1])}(it)${unescapeCode(match[2])};`);
+            }
+            else {
+                return (0, xtry_1.err)(`Cannot evaluate "${expression}"`);
+            }
+        }
+        lines.push('return it;');
         // eslint-disable-next-line no-new-func
-        const fn = new Function('it', `return it${unescapeCode(currentPath)};`);
-        return (0, xtry_1.ok)(fn(currentValue));
+        const fn = new Function('it, toGitUrl', lines.join('\n'));
+        return (0, xtry_1.ok)(fn(value, git_url_parse_1.default));
     } // }}}
     parseFile(filename) {
         const result = sync_1.default.readFile(filename, 'utf8');
@@ -151,14 +197,15 @@ class TemplateEngine {
             if (readResult.fails) {
                 return readResult;
             }
-            const getValueResult = this.getValueByPath(readResult.value, propertyPath);
-            if (getValueResult.fails) {
-                return getValueResult;
+            // const getValueResult = this.getValueByPath(readResult.value, propertyPath);
+            const evalResult = this.evaluateExpression(propertyPath, readResult.value);
+            if (evalResult.fails) {
+                return evalResult;
             }
-            if ((0, lodash_es_1.isNil)(getValueResult.value)) {
+            if ((0, lodash_es_1.isNil)(evalResult.value)) {
                 return (0, xtry_1.err)(expression);
             }
-            return (0, xtry_1.ok)(String(getValueResult.value));
+            return (0, xtry_1.ok)(String(evalResult.value));
         }
     } // }}}
     resolveVariable(name) {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@zokugun/artifact",
 	"description": "Boilerplate your project & keep your configurations up to date",
-	"version": "0.6.3",
+	"version": "0.7.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=\"\"'",
+		"test:watch": "tsc-watch -p src -p test --onSuccess 'mocha -g=\"vars.exp.pipe.gitname.dotprop\"'",
 		"update:artifacts": "artifact update",
 		"update:ci": "PINACT_MIN_AGE=7 pinact run",
 		"update:deps": "taze",
@@ -53,6 +53,7 @@
 		"@zokugun/xtry": "0.11.4",
 		"dayjs": "1.11.20",
 		"editorconfig": "0.15.3",
+		"git-url-parse": "16.1.0",
 		"globby": "11.1.0",
 		"istextorbinary": "6.0.0",
 		"jq-wasm": "1.1.0-jq-1.8.1",