@zokugun/artifact 0.2.4 → 0.3.0

package/README.md

@@ -32,11 +32,11 @@ With [node](http://nodejs.org) previously installed:
 Add the configuration packages:
 
 ```
-artifact add @daiyam/base @daiyam/lang-ts @daiyam/npm-ts
+artifact add @daiyam/lang-js @daiyam/lang-ts @daiyam/npm-ts
 ```
 
  With the previous command, `artifact` will pull the following packages:
-- [@daiyam/artifact-base](https://github.com/daiyam/artifact-configs/tree/master/packages/base)
+- [@daiyam/artifact-lang-js](https://github.com/daiyam/artifact-configs/tree/master/packages/lang-js)
 - [@daiyam/artifact-lang-ts](https://github.com/daiyam/artifact-configs/tree/master/packages/lang-ts)
 - [@daiyam/artifact-npm-ts](https://github.com/daiyam/artifact-configs/tree/master/packages/npm-ts)
 
@@ -47,10 +47,10 @@ Configuration Package
 
 The configuration/boilerplate files must be put inside the folder `configs`.
 
-For example, the package [@daiyam/artifact-base](https://github.com/daiyam/artifact-configs/tree/master/packages/base):
+For example, the package [@daiyam/artifact-lang-js](https://github.com/daiyam/artifact-configs/tree/master/packages/lang-js):
 
 ```
-artifact-configs/base/
+artifact-configs/lang-js/
   ├── configs/
   │  ├── .commitlintrc.yml
   │  ├── .editorconfig

package/lib/commands/add.js

@@ -19,7 +19,7 @@ const pacote_1 = __importDefault(require("pacote"));
 const tempy_1 = __importDefault(require("tempy"));
 const config_1 = require("../config");
 const steps_1 = require("../steps");
-const commonFlow = (0, steps_1.composeSteps)(steps_1.steps.readIncomingPackage, steps_1.steps.validateNotPresentPackage, steps_1.steps.readFiles, steps_1.steps.readEditorConfig, steps_1.steps.mergeTextFiles, steps_1.steps.insertFinalNewLine, steps_1.steps.applyFormatting, steps_1.steps.copyBinaryFiles, steps_1.steps.writeTextFiles);
+const commonFlow = (0, steps_1.composeSteps)(steps_1.steps.readIncomingPackage, steps_1.steps.validateNotPresentPackage, steps_1.steps.readFiles, steps_1.steps.readEditorConfig, steps_1.steps.replaceTemplates, steps_1.steps.mergeTextFiles, steps_1.steps.insertFinalNewLine, steps_1.steps.applyFormatting, steps_1.steps.copyBinaryFiles, steps_1.steps.writeTextFiles);
 function expandSpec(spec) {
     if (spec.includes('/')) {
         const [scope, name] = spec.split('/');

package/lib/compositors/rc.js

@@ -27,19 +27,12 @@ exports.rc = void 0;
 const lodash_1 = require("lodash");
 const JSON = __importStar(require("../parsers/json"));
 const YAML = __importStar(require("../parsers/yaml"));
-function tryJson(value) {
-    try {
-        return JSON.parse(value);
-    }
-    catch (_a) {
-        return undefined;
-    }
-}
+const try_json_1 = require("../utils/try-json");
 function rc(...routes) {
     return ({ current, incoming, filters, ignores }) => {
         var _a;
-        const currentData = current && ((_a = tryJson(current)) !== null && _a !== void 0 ? _a : YAML.parse(current));
-        const incomingData = incoming && tryJson(incoming);
+        const currentData = current && ((_a = (0, try_json_1.tryJson)(current)) !== null && _a !== void 0 ? _a : YAML.parse(current));
+        const incomingData = incoming && (0, try_json_1.tryJson)(incoming);
         if (incomingData) {
             return (0, lodash_1.flow)(...routes, JSON.stringify)({ current: currentData, incoming: incomingData, filters, ignores });
         }

package/lib/steps/copy-binary-files.js

@@ -20,21 +20,21 @@ function copyBinaryFiles({ binaryFiles, incomingPath, targetPath, onMissing, onU
         const cwd = path_1.default.join(incomingPath, 'configs');
         for (const file of binaryFiles) {
             try {
-                yield fs_extra_1.default.access(path_1.default.join(targetPath, file));
-                if (onUpdate(file)) {
+                yield fs_extra_1.default.access(path_1.default.join(targetPath, file.source));
+                if (onUpdate(file.source)) {
                     continue;
                 }
             }
             catch (_a) {
-                if (onMissing(file)) {
+                if (onMissing(file.source)) {
                     continue;
                 }
             }
-            const source = path_1.default.join(cwd, file);
-            const target = path_1.default.join(targetPath, file);
+            const source = path_1.default.join(cwd, file.source);
+            const target = path_1.default.join(targetPath, file.target);
             yield fs_extra_1.default.copyFile(source, target);
             if (options.verbose) {
-                console.log(`${file} has been written as a binary file`);
+                console.log(`${file.target} has been written as a binary file`);
             }
         }
     });

package/lib/steps/index.js

@@ -18,6 +18,7 @@ const read_editor_config_1 = require("./read-editor-config");
 const read_files_1 = require("./read-files");
 const read_incoming_config_1 = require("./read-incoming-config");
 const read_incoming_package_1 = require("./read-incoming-package");
+const replace_templates_1 = require("./replace-templates");
 const validate_newer_package_1 = require("./validate-newer-package");
 const validate_not_present_package_1 = require("./validate-not-present-package");
 const validate_updatability_1 = require("./validate-updatability");
@@ -31,6 +32,7 @@ exports.steps = {
     readFiles: read_files_1.readFiles,
     readIncomingConfig: read_incoming_config_1.readIncomingConfig,
     readIncomingPackage: read_incoming_package_1.readIncomingPackage,
+    replaceTemplates: replace_templates_1.replaceTemplates,
     validateNewerPackage: validate_newer_package_1.validateNewerPackage,
     validateNotPresentPackage: validate_not_present_package_1.validateNotPresentPackage,
     validateUpdatability: validate_updatability_1.validateUpdatability,

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

@@ -20,10 +20,13 @@ function mergeTextFiles({ targetPath, textFiles, mergedTextFiles, onMissing, onU
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         for (const file of textFiles) {
+            if (options.verbose) {
+                console.log(`${file.name} is going to be merged`);
+            }
             const journey = (_a = routes(file.name)) !== null && _a !== void 0 ? _a : (0, journeys_1.getJourney)(file.name);
             if (!journey) {
                 if (options.verbose) {
-                    console.log(`${file.name}, no merger found`);
+                    console.log(`${file.name}, no merger has been found`);
                 }
                 try {
                     yield fs_extra_1.default.access(path_1.default.join(targetPath, file.name));
@@ -39,6 +42,9 @@ function mergeTextFiles({ targetPath, textFiles, mergedTextFiles, onMissing, onU
                 mergedTextFiles.push(file);
                 continue;
             }
+            if (options.verbose) {
+                console.log(`${file.name}, a merger has been found`);
+            }
             const name = journey.alias ? path_1.default.join(path_1.default.dirname(file.name), journey.alias) : file.name;
             let currentData;
             try {

package/lib/steps/read-files.js

@@ -55,7 +55,10 @@ function readFiles({ incomingPath, textFiles, binaryFiles, options }) {
                 }
             }
             else {
-                binaryFiles.push(file);
+                binaryFiles.push({
+                    source: file,
+                    target: file,
+                });
                 if (options.verbose) {
                     console.log(`${file} is a binary file`);
                 }

package/lib/steps/replace-templates.js

@@ -0,0 +1,26 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceTemplates = void 0;
+const template_1 = require("../utils/template");
+function replaceTemplates({ textFiles, binaryFiles, targetPath }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const engine = new template_1.TemplateEngine(targetPath);
+        for (const file of textFiles) {
+            file.data = engine.render(file.data);
+            file.name = engine.render(file.name);
+        }
+        for (const file of binaryFiles) {
+            file.target = engine.render(file.target);
+        }
+    });
+}
+exports.replaceTemplates = replaceTemplates;

package/lib/types/binary-file.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/command/split-command.js

@@ -8,20 +8,22 @@ function splitCommand(command) {
     for (let i = 0; i < splitted.length; i++) {
         const command = splitted[i];
         const splittedSubcommand = command.split(/([\w-]+=\S+)\s/).filter(lodash_1.identity);
-        const subcommandWithArgs = (0, lodash_1.last)(splittedSubcommand).split(' ');
-        const subcommand = (0, lodash_1.head)(subcommandWithArgs).trim();
-        const args = subcommandWithArgs.slice(1);
-        const env = splittedSubcommand.slice(0, -1);
-        const parsedSubcommand = {
-            args: args.map(lodash_1.trim),
-            env: env.map(lodash_1.trim),
-            separator: splitted[i + 1],
-        };
-        if (result[subcommand]) {
-            result[subcommand].push(parsedSubcommand);
-        }
-        else {
-            result[subcommand] = [parsedSubcommand];
+        if (splittedSubcommand.length > 0) {
+            const subcommandWithArgs = (0, lodash_1.last)(splittedSubcommand).split(' ');
+            const subcommand = (0, lodash_1.head)(subcommandWithArgs).trim();
+            const args = subcommandWithArgs.slice(1);
+            const env = splittedSubcommand.slice(0, -1);
+            const parsedSubcommand = {
+                args: args.map(lodash_1.trim),
+                env: env.map(lodash_1.trim),
+                separator: splitted[i + 1],
+            };
+            if (result[subcommand]) {
+                result[subcommand].push(parsedSubcommand);
+            }
+            else {
+                result[subcommand] = [parsedSubcommand];
+            }
         }
         i++;
     }

package/lib/utils/template.js

@@ -0,0 +1,137 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemplateEngine = void 0;
+const path_1 = __importDefault(require("path"));
+const dayjs_1 = __importDefault(require("dayjs"));
+const utc_1 = __importDefault(require("dayjs/plugin/utc"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const YAML = __importStar(require("../parsers/yaml"));
+const try_json_1 = require("./try-json");
+dayjs_1.default.extend(utc_1.default);
+const PLACEHOLDER_REGEX = /^((?:[^/]+(?:[^/]+\/)*\/)?\.?[^.]+(?:\.(?:json|ya?ml))?)\.(.*)$/;
+class TemplateError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'TemplateError';
+    } // }}}
+}
+class TemplateEngine {
+    constructor(basePath) {
+        this.fileCache = new Map();
+        this.basePath = basePath;
+    } // }}}
+    render(template) {
+        const pattern = /#\[\[(.*?)]]/g;
+        return template.replace(pattern, (_, placeholder) => {
+            const [name, propertyPath] = this.splitPlaceholder(placeholder);
+            if (!name || !propertyPath) {
+                throw new TemplateError(`Invalid placeholder format: ${placeholder}. Expected format: #[[filename.property]]`);
+            }
+            if (name === 'date') {
+                return this.toDate(propertyPath);
+            }
+            const fileContent = this.readConfigFile(name);
+            const value = this.getValueByPath(fileContent, propertyPath);
+            if (value === null || value === undefined) {
+                throw new TemplateError(placeholder);
+            }
+            return String(value);
+        });
+    } // }}}
+    getValueByPath(values, propertyPath) {
+        const parts = propertyPath.split('.');
+        let current = values;
+        for (const part of parts) {
+            if (current === null || current === undefined || typeof current !== 'object') {
+                throw new TemplateError(`Property path not found: ${propertyPath}`);
+            }
+            current = current[part];
+        }
+        if (current === null || current === undefined) {
+            throw new TemplateError(`Property not found: ${propertyPath}`);
+        }
+        return current;
+    } // }}}
+    parseFile(filename) {
+        var _a;
+        let content;
+        try {
+            content = fs_extra_1.default.readFileSync(filename, 'utf8');
+        }
+        catch (_b) {
+            throw new TemplateError(`File not found: ${filename}`);
+        }
+        const ext = path_1.default.extname(filename).toLowerCase();
+        try {
+            if (ext === '.json') {
+                return JSON.parse(content);
+            }
+            else if (ext === '.yaml' || ext === '.yml') {
+                return YAML.parse(content);
+            }
+            else {
+                return (_a = (0, try_json_1.tryJson)(content)) !== null && _a !== void 0 ? _a : YAML.parse(content);
+            }
+        }
+        catch (parseError) {
+            throw new TemplateError(`Failed to parse ${filename}: ${parseError.message}`);
+        }
+    } // }}}
+    readConfigFile(filename) {
+        // Check cache first
+        if (this.fileCache.has(filename)) {
+            return this.fileCache.get(filename);
+        }
+        const filePath = path_1.default.resolve(this.basePath, filename);
+        const content = this.parseFile(filePath);
+        this.fileCache.set(filename, content);
+        return content;
+    } // }}}
+    splitPlaceholder(placeholder) {
+        const matches = PLACEHOLDER_REGEX.exec(placeholder);
+        if (!matches) {
+            throw new TemplateError(`Invalid placeholder format: ${placeholder}. Expected format: #[[filename.property]]`);
+        }
+        const [, filename, propertyPath] = matches;
+        return [filename, propertyPath];
+    } // }}}
+    toDate(format) {
+        try {
+            const now = (0, dayjs_1.default)().utc();
+            if (format === 'utc') {
+                return now.format('YYYY-MM-DD HH:mm:ss');
+            }
+            return now.format(format);
+        }
+        catch (_a) {
+            throw new TemplateError(`Invalid date format: ${format}`);
+        }
+    } // }}}
+}
+exports.TemplateEngine = TemplateEngine;

package/lib/utils/try-json.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tryJson = void 0;
+function tryJson(value) {
+    try {
+        return JSON.parse(value);
+    }
+    catch (_a) {
+        return undefined;
+    }
+}
+exports.tryJson = tryJson;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@zokugun/artifact",
 	"description": "Boilerplate your project & keep your configurations up to date",
-	"version": "0.2.4",
+	"version": "0.3.0",
 	"author": {
 		"name": "Baptiste Augrain",
 		"email": "daiyam@zokugun.org"
@@ -35,6 +35,7 @@
 	"dependencies": {
 		"ansi-colors": "^4.1.1",
 		"commander": "^9.0.0",
+		"dayjs": "^1.11.13",
 		"detect-indent": "^6.1.0",
 		"editorconfig": "^0.15.3",
 		"fs-extra": "^10.0.0",