@zokugun/artifact 0.6.0 → 0.6.2

package/lib/steps/configure-install-file-actions.js

@@ -10,31 +10,34 @@ async function configureInstallFileActions(context) {
     if (!install) {
         return xtry_1.OK;
     }
-    const overwrites = [];
+    const existingActions = [];
     const filters = {};
     const routes = {};
     const transformations = {};
-    for (const [file, fileUpdate] of Object.entries(install)) {
-        const { filter, ifExists, rename, route, transforms } = fileUpdate;
+    for (const file of install) {
+        const { filter, ifExists, pattern, rename, route, transforms } = file;
         if (rename) {
             context.renamedPatterns.push({
-                from: file,
+                from: pattern,
                 to: rename,
             });
             continue;
         }
-        if (ifExists === 'overwrite') {
-            overwrites.push(file);
+        if (ifExists === 'force-merge') {
+            existingActions.push({ pattern, action: 'merge' });
+        }
+        else if (ifExists === 'overwrite') {
+            existingActions.push({ pattern, action: 'overwrite' });
         }
         else if (ifExists === 'remove') {
-            context.removedPatterns.push(file);
+            context.removedPatterns.push(pattern);
             continue;
         }
         else if (ifExists === 'skip') {
             continue;
         }
         if (filter) {
-            filters[file] = filter;
+            filters[pattern] = filter;
         }
         if (route) {
             const { alias } = route;
@@ -43,23 +46,30 @@ async function configureInstallFileActions(context) {
                 return travel;
             }
             if (alias) {
-                routes[file] = {
+                routes[pattern] = {
                     alias,
                     travel: travel.value,
                 };
             }
             else {
-                routes[file] = {
+                routes[pattern] = {
                     travel: travel.value,
                 };
             }
         }
         if (transforms) {
-            transformations[file] = transforms;
+            transformations[pattern] = transforms;
         }
     }
-    if (overwrites.length > 0) {
-        context.onExisting = (file) => (0, micromatch_1.isMatch)(file, overwrites) ? 'overwrite' : 'merge';
+    if (existingActions.length > 0) {
+        context.onExisting = (file) => {
+            for (const { pattern, action } of existingActions) {
+                if ((0, micromatch_1.isMatch)(file, pattern)) {
+                    return action;
+                }
+            }
+            return 'merge';
+        };
     }
     if ((0, is_it_type_1.isNonEmptyRecord)(filters)) {
         context.filters = (file) => {

package/lib/steps/configure-uninstall-file-actions.js

@@ -9,6 +9,8 @@ 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 micromatch_1 = require("micromatch");
+const detect_indent_js_1 = require("../utils/detect-indent.js");
+const has_final_new_line_js_1 = require("../utils/has-final-new-line.js");
 async function configureUninstallFileActions(context) {
     const { uninstall } = context.incomingConfig;
     if (!uninstall) {
@@ -16,27 +18,29 @@ async function configureUninstallFileActions(context) {
     }
     const cwd = node_path_1.default.join(context.incomingPath, 'configs');
     const transformations = {};
-    for (const [file, fileUpdate] of Object.entries(uninstall)) {
-        const { ifExists, transforms } = fileUpdate;
+    for (const file of uninstall) {
+        const { ifExists, pattern, transforms } = file;
         if (ifExists === 'remove') {
-            context.removedPatterns.push(file);
+            context.removedPatterns.push(pattern);
         }
         else if (ifExists === 'unmerge') {
-            const filePath = node_path_1.default.join(cwd, file);
+            const filePath = node_path_1.default.join(cwd, pattern);
             const result = await async_1.default.readFile(filePath, 'utf8');
             if (result.fails) {
                 return (0, xtry_1.err)((0, xtry_1.stringifyError)(result.error));
             }
             const data = result.value;
-            const finalNewLine = data.endsWith('\n');
+            const finalNewLine = (0, has_final_new_line_js_1.hasFinalNewLine)(data);
+            const indent = (0, detect_indent_js_1.detectIndent)(data);
             context.textFiles.push({
-                name: file,
+                name: pattern,
                 data,
                 finalNewLine,
+                indent,
             });
         }
         if (transforms) {
-            transformations[file] = transforms;
+            transformations[pattern] = transforms;
         }
     }
     if ((0, is_it_type_1.isNonEmptyRecord)(transformations)) {

package/lib/steps/configure-update-file-actions.js

@@ -12,42 +12,38 @@ async function configureUpdateFileActions(context) {
         context.onMissing = () => 'skip';
     }
     else {
-        const existingActions = {
-            merge: [],
-            overwrite: [],
-            skip: [],
-        };
+        const existingActions = [];
         const skipMissings = [];
         const filters = {};
         const routes = {};
         const transformations = {};
-        for (const [file, fileUpdate] of Object.entries(update)) {
-            const { filter, ifExists, ifMissing, rename, route, transforms } = fileUpdate;
+        for (const file of update) {
+            const { filter, ifExists, ifMissing, pattern, rename, route, transforms } = file;
             if (rename) {
                 context.renamedPatterns.push({
-                    from: file,
+                    from: pattern,
                     to: rename,
                 });
                 continue;
             }
             if (ifMissing === 'skip') {
-                skipMissings.push(file);
+                skipMissings.push(pattern);
             }
             if (ifExists === 'force-merge') {
-                existingActions.merge.push(file);
-            }
-            else if (ifExists === 'skip') {
-                existingActions.skip.push(file);
+                existingActions.push({ pattern, action: 'merge' });
             }
             else if (ifExists === 'overwrite') {
-                existingActions.overwrite.push(file);
+                existingActions.push({ pattern, action: 'overwrite' });
             }
             else if (ifExists === 'remove') {
-                context.removedPatterns.push(file);
+                context.removedPatterns.push(pattern);
                 continue;
             }
+            else if (ifExists === 'skip') {
+                existingActions.push({ pattern, action: 'skip' });
+            }
             if (filter) {
-                filters[file] = filter;
+                filters[pattern] = filter;
             }
             if (route) {
                 const { alias } = route;
@@ -56,28 +52,28 @@ async function configureUpdateFileActions(context) {
                     return travel;
                 }
                 if (alias) {
-                    routes[file] = {
+                    routes[pattern] = {
                         alias,
                         travel: travel.value,
                     };
                 }
                 else {
-                    routes[file] = {
+                    routes[pattern] = {
                         travel: travel.value,
                     };
                 }
             }
             if (transforms) {
-                transformations[file] = transforms;
+                transformations[pattern] = transforms;
             }
         }
         if (skipMissings.length > 0) {
             context.onMissing = (file) => (0, micromatch_1.isMatch)(file, skipMissings) ? 'skip' : 'continue';
         }
-        if (existingActions.overwrite.length > 0 || existingActions.skip.length > 0) {
+        if (existingActions.length > 0) {
             context.onExisting = (file) => {
-                for (const [action, files] of Object.entries(existingActions)) {
-                    if ((0, micromatch_1.isMatch)(file, files)) {
+                for (const { pattern, action } of existingActions) {
+                    if ((0, micromatch_1.isMatch)(file, pattern)) {
                         return action;
                     }
                 }

package/lib/steps/insert-final-new-line.d.ts

@@ -1,5 +1,5 @@
 import { type AsyncDResult } from '@zokugun/xtry';
-import { type TextFile } from '../types/text-file.js';
+import { type TextFile } from '../types/context.js';
 export declare function insertFinalNewLine({ mergedTextFiles, transformedFiles }: {
     mergedTextFiles: TextFile[];
     transformedFiles?: TextFile[];

package/lib/steps/merge-text-files.js

@@ -9,6 +9,8 @@ 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 index_js_1 = require("../journeys/index.js");
+const detect_indent_js_1 = require("../utils/detect-indent.js");
+const has_final_new_line_js_1 = require("../utils/has-final-new-line.js");
 async function mergeTextFiles({ targetPath, textFiles, mergedTextFiles, onExisting, onMissing, filters, routes, transforms, options }) {
     for (const file of textFiles) {
         if (options.verbose) {
@@ -61,6 +63,8 @@ async function mergeTextFiles({ targetPath, textFiles, mergedTextFiles, onExisti
                     if (current.fails) {
                         return (0, xtry_1.err)((0, xtry_1.stringifyError)(current.error));
                     }
+                    const finalNewLine = (0, has_final_new_line_js_1.hasFinalNewLine)(current.value);
+                    const indent = (0, detect_indent_js_1.detectIndent)(current.value);
                     const data = await journey.travel({
                         current: current.value,
                         incoming: file.data,
@@ -70,7 +74,8 @@ async function mergeTextFiles({ targetPath, textFiles, mergedTextFiles, onExisti
                     mergedTextFiles.push({
                         name: fileName,
                         data,
-                        finalNewLine: file.finalNewLine,
+                        finalNewLine,
+                        indent,
                         mode: file.mode,
                     });
                     if (options.verbose) {

package/lib/steps/read-files.js

@@ -10,6 +10,8 @@ const async_1 = __importDefault(require("@zokugun/fs-extra-plus/async"));
 const xtry_1 = require("@zokugun/xtry");
 const globby_1 = __importDefault(require("globby"));
 const istextorbinary_1 = require("istextorbinary");
+const detect_indent_js_1 = require("../utils/detect-indent.js");
+const has_final_new_line_js_1 = require("../utils/has-final-new-line.js");
 const read_buffer_js_1 = require("../utils/read-buffer.js");
 async function readFiles({ incomingPath, textFiles, binaryFiles, options }) {
     const cwd = path_1.default.join(incomingPath, 'configs');
@@ -26,7 +28,8 @@ async function readFiles({ incomingPath, textFiles, binaryFiles, options }) {
                 return (0, xtry_1.err)((0, xtry_1.stringifyError)(result.error));
             }
             const data = result.value;
-            const finalNewLine = data.endsWith('\n');
+            const finalNewLine = (0, has_final_new_line_js_1.hasFinalNewLine)(data);
+            const indent = (0, detect_indent_js_1.detectIndent)(data);
             if (data.startsWith('#!')) {
                 // the text file might be executable
                 const result = await async_1.default.stat(filePath);
@@ -37,8 +40,9 @@ async function readFiles({ incomingPath, textFiles, binaryFiles, options }) {
                 textFiles.push({
                     name: file,
                     data,
-                    mode,
                     finalNewLine,
+                    indent,
+                    mode,
                 });
                 if (options.verbose) {
                     cli_utils_1.logger.debug(`${file} is a shebang file`);
@@ -49,6 +53,7 @@ async function readFiles({ incomingPath, textFiles, binaryFiles, options }) {
                     name: file,
                     data,
                     finalNewLine,
+                    indent,
                 });
                 if (options.verbose) {
                     cli_utils_1.logger.debug(`${file} is a text file`);

package/lib/steps/replace-templates.js

@@ -7,8 +7,6 @@ async function replaceTemplates({ textFiles, binaryFiles, targetPath, config, in
     const variables = {
         ...incomingConfig?.variables,
         ...config?.variables,
-        ...incomingConfig?.constants,
-        ...config?.constants,
     };
     const engine = new template_js_1.TemplateEngine(targetPath, variables);
     for (const file of textFiles) {

package/lib/steps/transform-untouched-files.js

@@ -12,7 +12,6 @@ const xtry_1 = require("@zokugun/xtry");
 const globby_1 = __importDefault(require("globby"));
 const index_js_1 = require("../journeys/index.js");
 const detect_indent_js_1 = require("../utils/detect-indent.js");
-const get_format_js_1 = require("../utils/get-format.js");
 const has_final_new_line_js_1 = require("../utils/has-final-new-line.js");
 async function transformUntouchedFiles({ formats, options, routes, targetPath, textFiles, transformedFiles, transforms }) {
     if (transforms.length === 0) {
@@ -44,7 +43,8 @@ async function transformUntouchedFiles({ formats, options, routes, targetPath, t
             return (0, xtry_1.err)((0, xtry_1.stringifyError)(result.error));
         }
         const data = result.value;
-        const finalNewLine = data.endsWith('\n');
+        const finalNewLine = (0, has_final_new_line_js_1.hasFinalNewLine)(data);
+        const indent = (0, detect_indent_js_1.detectIndent)(data);
         const transformed = await journey.travel({
             current: data,
             incoming: undefined,
@@ -53,21 +53,12 @@ async function transformUntouchedFiles({ formats, options, routes, targetPath, t
         transformedFiles.push({
             name: file,
             data: transformed,
-            finalNewLine: finalNewLine,
+            finalNewLine,
+            indent,
         });
         if (options.verbose) {
             cli_utils_1.logger.debug(`${file} has been transformed`);
         }
-        const format = (0, get_format_js_1.getFormat)(file, formats);
-        if (!format) {
-            const indent = (0, detect_indent_js_1.detectIndent)(data);
-            formats.push({
-                glob: file,
-                indentStyle: indent.style,
-                indentSize: indent.size,
-                insertFinalNewline: (0, has_final_new_line_js_1.hasFinalNewLine)(data),
-            });
-        }
     }
     return xtry_1.OK;
 }

package/lib/steps/unmerge-text-files.js

@@ -47,6 +47,7 @@ async function unmergeTextFiles({ targetPath, textFiles, mergedTextFiles, option
                 name: file.name,
                 data,
                 finalNewLine: file.finalNewLine,
+                indent: file.indent,
                 mode: file.mode,
             });
             if (options.verbose) {

package/lib/types/config.d.ts

@@ -1,3 +1,5 @@
+import { type Primitive } from '@zokugun/is-it-type';
+import { type Indent } from './format.js';
 export type Request = {
     name: string;
     variant?: string;
@@ -7,13 +9,12 @@ export type PackageManifest = {
     version: string;
 };
 export type PackageConfig = {
-    constants: Record<string, string>;
     extends?: string;
-    install: Record<string, FileInstall>;
+    install: InstallFileConfig[];
     orphan: boolean;
-    uninstall: Record<string, FileUninstall>;
-    update: false | Record<string, FileUpdate>;
-    variables: Record<string, string>;
+    uninstall: UninstallFileConfig[];
+    update: false | UpdateFileConfig[];
+    variables: Record<string, Primitive>;
     variants: Record<string, string>;
 };
 export type Artifact = {
@@ -26,27 +27,25 @@ export type ArtifactResult = Artifact & {
 };
 export type InstallConfig = {
     artifacts: Record<string, Artifact>;
-    constants: Record<string, string>;
-    install: Record<string, FileInstall>;
-    update: false | Record<string, FileUpdate>;
-    variables: Record<string, string>;
+    install: Record<string, InstallFileConfig>;
+    update: false | Record<string, UpdateFileConfig>;
+    variables: Record<string, Primitive>;
 };
-export type FileAlways = {
-    ifExists: 'force-merge' | 'merge' | 'overwrite' | 'remove' | 'skip';
+export type FileConfig<E> = {
+    ifExists: E;
+    pattern: string;
     transforms: FileTransform[];
 };
-export type FileUpsert = FileAlways & {
+export type AlwaysFileConfig = FileConfig<'force-merge' | 'merge' | 'overwrite' | 'remove' | 'skip'>;
+export type InstallFileConfig = UpsertFileConfig;
+export type UninstallFileConfig = FileConfig<'remove' | 'skip' | 'unmerge'>;
+export type UpdateFileConfig = UpsertFileConfig;
+export type UpsertFileConfig = AlwaysFileConfig & {
     filter?: string[];
     ifMissing: 'merge' | 'skip';
     rename?: string;
     route?: Record<string, any>;
 };
-export type FileInstall = FileUpsert & {};
-export type FileUninstall = {
-    ifExists: 'remove' | 'skip' | 'unmerge';
-    transforms: FileTransform[];
-};
-export type FileUpdate = FileUpsert & {};
 export type FileTransform = {
     description?: string;
     jq: string;
@@ -55,4 +54,5 @@ export type InstallConfigStats = {
     name: string;
     type: string;
     finalNewLine: boolean;
+    indent?: Indent;
 };

package/lib/types/context.d.ts

@@ -1,8 +1,7 @@
 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';
-import { type Format } from './format.js';
-import { type TextFile } from './text-file.js';
+import { type Indent, type Format } from './format.js';
 import { type Journey } from './travel.js';
 export type ExistingAction = 'merge' | 'overwrite' | 'skip';
 export type MissingAction = 'continue' | 'skip';
@@ -54,3 +53,10 @@ export type Block = {
     branch?: string;
     incomingPath: string;
 };
+export type TextFile = {
+    data: string;
+    finalNewLine: boolean;
+    indent?: Indent;
+    mode?: number;
+    name: string;
+};

package/lib/types/context.js

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

package/lib/types/format.d.ts

@@ -8,3 +8,7 @@ export type Format = {
     indentSize: number;
     insertFinalNewline: boolean;
 };
+export type Indent = {
+    style: IndentStyle;
+    size: number;
+};

package/lib/utils/detect-indent.d.ts

@@ -1,5 +1,2 @@
-import { IndentStyle } from '../types/format.js';
-export declare function detectIndent(text: string): {
-    style: IndentStyle;
-    size: number;
-};
+import { type Indent } from '../types/format.js';
+export declare function detectIndent(text: string): Indent | undefined;

package/lib/utils/detect-indent.js

@@ -27,6 +27,9 @@ function detectIndent(text) {
             size: 1,
         };
     }
+    if (indentations.size === 0) {
+        return undefined;
+    }
     const sorted = [...indentations].sort((a, b) => a - b);
     const diffs = [];
     for (let i = 1; i < sorted.length; i++) {

package/lib/utils/template.d.ts

@@ -1,10 +1,11 @@
+import { type Primitive } from '@zokugun/is-it-type';
 import { type DResult } from '@zokugun/xtry';
 export declare class TemplateEngine {
     private readonly basePath;
     private readonly fileCache;
     private readonly variables;
     private readonly variableCache;
-    constructor(basePath: string, variables?: Record<string, string>);
+    constructor(basePath: string, variables?: Record<string, Primitive>);
     render(template: string): DResult<string>;
     private getValueByPath;
     private parseFile;

package/lib/utils/template.js

@@ -40,6 +40,7 @@ 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"));
@@ -164,16 +165,27 @@ class TemplateEngine {
         if (this.variableCache.has(name)) {
             return (0, xtry_1.ok)(this.variableCache.get(name));
         }
-        const expression = this.variables[name];
-        if (typeof expression !== 'string' || expression.trim().length === 0) {
+        const value = this.variables[name];
+        if (!(0, is_it_type_1.isPrimitive)(value)) {
             return (0, xtry_1.err)(`Invalid variable: ${name}.`);
         }
-        const result = this.resolveExpression(expression);
-        if (result.fails) {
+        const expression = String(value).trim();
+        if (expression.length === 0) {
+            return (0, xtry_1.err)(`Invalid variable: ${name}.`);
+        }
+        if (expression.at(0) === '=') {
+            const result = this.resolveExpression(expression.slice(1));
+            if (result.fails) {
+                return result;
+            }
+            this.variableCache.set(name, result.value);
             return result;
         }
-        this.variableCache.set(name, result.value);
-        return result;
+        else {
+            const value = expression.at(0) === '\\' && expression.at(1) === '=' ? expression.slice(1) : expression;
+            this.variableCache.set(name, value);
+            return (0, xtry_1.ok)(value);
+        }
     } // }}}
     splitPlaceholder(placeholder) {
         const matches = PLACEHOLDER_REGEX.exec(placeholder);