mikel-cli 0.35.1 → 0.36.0

package/README.md

@@ -281,6 +281,26 @@ export default {
 };
 ```
 
+## Utils
+
+### `createInput(name, content)`
+
+Utility function to create dynamic input entries for the `input` field in `mikel.config.js`, without needing to deal with the underlying format.
+
+Example:
+
+```js
+import { createInput } from "mikel-cli";
+
+export default {
+    input: [
+        "src/templates/*.html",
+        createInput("generated/index.html", "{{> header}} ..."),
+    ],
+    // ...
+};
+```
+
 ## License
 
 Licensed under the [MIT License](../../LICENSE).

package/index.d.ts

@@ -16,4 +16,5 @@ export type MikelCliConfig = {
 };
 
 export declare const defineConfig: (config: MikelCliConfig) => MikelCliConfig;
+export declare const createInput: (name: string, content: string) => string;
 export declare const build: (config: MikelCliConfig) => Promise<void>;

package/index.js

@@ -62,7 +62,31 @@ export const loadInputFiles = async (root, inputFiles) => {
     if (!inputFiles || inputFiles?.length === 0) {
         throw new Error(`No input templates provided.`);
     }
-    return expandGlobPatterns(root, Array.isArray(inputFiles) ? inputFiles : [inputFiles]);
+    // 1. iterate inputFiles and extract virtual files and glob/relative files paths
+    const files = [], patterns = [];
+    (Array.isArray(inputFiles) ? inputFiles : [inputFiles]).forEach(file => {
+        // 1.1. check if file starts with 'data:' --> load as virtual file
+        if (!!file && file.startsWith("data:")) {
+            const rest = file.slice(5);
+            const sep = rest.indexOf(";base64,");
+            files.push({
+                path: rest.slice(0, sep),
+                content: Buffer.from(rest.slice(sep + 8), "base64").toString("utf-8"),
+            });
+        }
+        // 1.2. other case, treat as patter/glob
+        else if (!!file) {
+            patterns.push(file);
+        }
+    });
+    // 2. expand glob patterns and append them into files array
+    (await expandGlobPatterns(root, patterns)).forEach(filePath => {
+        files.push({
+            path: filePath,
+        });
+    });
+    // 3. return processed files
+    return files;
 };
 
 // @description resolve output
@@ -74,7 +98,7 @@ export const resolveOutput = (root, file, output) => {
     }
     // 2. output configuration is provided as an object
     else if (!!output && typeof output === "object") {
-        const renamedOutputFile = applyNameMapping(file, output?.nameMapping || {});
+        const renamedOutputFile = applyNameMapping(file, output?.nameMapper || {});
         return path.resolve(root, path.join(output?.dir || ".", renamedOutputFile));
     }
     // 3. other case???
@@ -198,13 +222,13 @@ export const build = async (config = {}) => {
 
     // process input files
     for (const inputFile of inputFiles) {
-        const inputPath = path.resolve(config.context, inputFile);
-        if (!existsSync(inputPath)) {
-            throw new Error(`Template file '${inputPath}' was not found.`);
-        }
+        const inputPath = path.resolve(config.context, inputFile.path);
+        // if (!existsSync(inputPath)) {
+        //     throw new Error(`Template file '${inputPath}' was not found.`);
+        // }
         let template;
         try {
-            template = await fs.readFile(inputPath, "utf8");
+            template = inputFile.content ? inputFile.content : (await fs.readFile(inputPath, "utf8"));
         } catch (error) {
             throw new Error(`Failed to read template file '${inputPath}': ${error.message}`);
         }
@@ -218,7 +242,7 @@ export const build = async (config = {}) => {
         // check if output argument has been provided to write the result to a file
         // this will also create any intermediary directory that does not exist
         if (config.output) {
-            const outputPath = resolveOutput(config.context, inputFile, config.output);
+            const outputPath = resolveOutput(config.context, inputFile.path, config.output);
             const outputDirectory = path.dirname(outputPath);
             // make sure that any directory containing the output file exists
             if (!existsSync(outputDirectory)) {
@@ -247,3 +271,8 @@ export const build = async (config = {}) => {
 
 // @description utility method to provide a typed configuration
 export const defineConfig = (config = {}) => config;
+
+// @description utility method to create dinamic input entries
+export const createInput = (name, content) => {
+    return `data:${name};base64,${Buffer.from(content, "utf-8").toString("base64")}`;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "mikel-cli",
     "description": "The cli tool for mikel templating.",
-    "version": "0.35.1",
+    "version": "0.36.0",
     "type": "module",
     "license": "MIT",
     "author": {
@@ -35,7 +35,7 @@
         "mikel": "cli.js"
     },
     "peerDependencies": {
-        "mikel": "^0.35.1"
+        "mikel": "^0.36.0"
     },
     "files": [
         "README.md",