fast-ejs-builder 0.0.0

package/core/lib.js

@@ -0,0 +1,231 @@
+const { args, _r, _has, _ce, _d, _w, _md, _e, _p, _ds } = require(".");
+const { $confirm, $input, $select, $number } = require("./prompter");
+const default_fej = require("../fast.ejs.json");
+const config = {
+  ...default_fej,
+  $schema: "http://unpkg.com/fast-ejs-builder/fast.ejs.schema.json",
+};
+
+function getConfigFile() {
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    if (arg.toLowerCase() == "-c" || arg == "--config") {
+      const v = args[i + 1];
+      if (v) return v;
+    }
+  }
+}
+
+function smartMerge(target = {}, source = {}) {
+  if (!source) return target;
+
+  const result = { ...target };
+
+  for (const key in target) {
+    const targetValue = target[key];
+    const sourceValue = source[key];
+
+    const exists = (val) =>
+      val != null && val != undefined && val.toString().trim() != "";
+
+    const isObject = (val) =>
+      val && typeof val === "object" && !Array.isArray(val);
+
+    if (isObject(targetValue) && isObject(sourceValue)) {
+      result[key] = smartMerge(targetValue, sourceValue);
+    } else if (
+      exists(sourceValue) &&
+      typeof targetValue === typeof sourceValue
+    ) {
+      result[key] = sourceValue;
+    }
+  }
+
+  return result;
+}
+
+async function getConfig() {
+  const file = getConfigFile() || "fast.ejs.json";
+
+  if (!_ce(file, "Config file")) {
+    const auto = await $confirm("Do you want to use default settings ?", true);
+    if (!auto) {
+      config.pages.dir = await $input(
+        "Where are your pages ?",
+        config.pages.dir,
+      );
+      config.data.dir = await $input(
+        "Where are your data files ?",
+        config.data.dir,
+      );
+      config.components.dir = await $input(
+        "In which folder are your components ?",
+        config.components.dir,
+      );
+
+      config.build.output = await $input(
+        "Where do you want to output ?",
+        config.build.output,
+      );
+      config.build.interval = await $number(
+        "How many milliseconds between each build ?",
+        config.build.interval,
+      );
+      config.build.useIndexRouting = await $confirm(
+        "Do you want to use index routing ?",
+        true,
+      );
+      config.data.allow = await $select(
+        "In which format do you want to pass data ?",
+        ["all", "js", "json"],
+        config.data.allow,
+      );
+
+      config.tailwind.output = await $input(
+        "Where should tailwind output ?",
+        config.tailwind.output,
+      );
+    }
+    const done = _w(file, config);
+    if (done) _ds(`Successfully generated '${file}'`);
+  }
+
+  const user_config = _r(file);
+  const merged_config = smartMerge(config, user_config);
+
+  for (let k in merged_config) {
+    config[k] = merged_config[k];
+  }
+}
+
+function generateBaseDirs() {
+  if (!_ce(config.pages.dir, "Pages directory")) {
+    _md(config.pages.dir);
+    _d("Generated pages directory.");
+  }
+  _md(config.pages.dir + "/public");
+
+  if (!_ce(config.components.dir, "Components directory")) {
+    _md(config.components.dir);
+    _d("Generated components directory.");
+  }
+  if (!_ce(config.data.dir, "Data directory")) {
+    _md(config.data.dir);
+    _d("Generated data directory.");
+  }
+}
+
+async function getDatas() {
+  const globalDataPath = (type) => `${config.data.dir}/global.data.${type}`;
+  const localDataPath = (type) => `${config.data.dir}/local.data.${type}`;
+
+  const globalJs = globalDataPath("js");
+  const globalJson = globalDataPath("json");
+
+  const localJs = localDataPath("js");
+  const localJson = localDataPath("json");
+
+  const templates = {
+    globalJS: `
+module.exports = async () => ({
+  year: new Date().getFullYear(),
+  environment: process.env.NODE_ENV,
+});
+`,
+    localJS: `
+module.exports = () => ({
+  // index.ejs
+  index: {
+    title: process.env.APP_NAME,
+  },
+  about: {}, // about.ejs,
+  "contact/menu": {}, // contact/menu.ejs
+});
+`,
+  };
+
+  const default_data_args = {};
+
+  const parseJSDate = async (path) => {
+    const resolved = require.resolve(_p(path));
+    delete require.cache[resolved];
+    const v = require(resolved);
+    return typeof v == "function" ? await v(default_data_args) : v;
+  };
+
+  const getGlobalJSData = async () => {
+    if (_e(globalJs)) {
+      return await parseJSDate(globalJs);
+    } else {
+      _d(`Global file '${globalJs}' not found. It will be generated`);
+      _w(globalJs, templates.globalJS.trim());
+      return {};
+    }
+  };
+
+  const getLocalJSData = async () => {
+    if (_e(localJs)) {
+      return await parseJSDate(localJs);
+    } else {
+      _d(`Local file '${localJs}' not found. It will be generated`);
+      _w(localJs, templates.localJS.trim());
+      return {};
+    }
+  };
+
+  const getGlobalJSONData = () => {
+    if (_e(globalJson)) {
+      return _r(globalJson);
+    } else {
+      _d(`Global file '${globalJson}' not found. It will be generated`);
+      _w(globalJson, {});
+      return {};
+    }
+  };
+
+  const getLocalJSONData = () => {
+    if (_e(localJson)) {
+      return _r(localJson);
+    } else {
+      _d(`Local file '${localJson}' not found. It will be generated`);
+      _w(localJson, { index: { title: "HomePage" }, about: {} });
+      return {};
+    }
+  };
+
+  let globalData = {},
+    localData = {};
+
+  switch (config.data.allow) {
+    case "js":
+      globalData = await getGlobalJSData();
+      localData = await getLocalJSData();
+      break;
+    case "json":
+      globalData = getGlobalJSONData();
+      localData = getLocalJSONData();
+      break;
+    default:
+      globalData = { ...getGlobalJSONData(), ...(await getGlobalJSData()) };
+      localData = { ...getLocalJSONData(), ...(await getLocalJSData()) };
+      break;
+  }
+
+  return { globalData, localData };
+}
+
+const configTailwindOutput = () => {
+  let o = config.tailwind.output;
+  if (!o.startsWith("/")) o = `/${o}`;
+
+  return _p(config.build.output + o);
+};
+
+module.exports = {
+  getConfigFile,
+  getConfig,
+  generateBaseDirs,
+  config,
+  configTailwindOutput,
+  getDatas,
+};

package/core/prompter.js

@@ -0,0 +1,99 @@
+const inquirer = require("@inquirer/prompts");
+
+class Prompter {
+  static async $confirm(message, defaultValue) {
+    try {
+      const p = await inquirer.confirm(
+        {
+          message: message,
+          default: defaultValue,
+        },
+        {
+          clearPromptOnDone: true,
+        },
+      );
+
+      return p;
+    } catch (_) {}
+  }
+  static async $input(message, defaultValue = "") {
+    try {
+      const p = await inquirer.input(
+        {
+          message,
+          default: defaultValue,
+        },
+        {
+          clearPromptOnDone: true,
+        },
+      );
+
+      return p;
+    } catch (_) {}
+  }
+
+  static async $password(message) {
+    try {
+      const p = await inquirer.password(
+        {
+          message,
+          mask: "*",
+        },
+        {
+          clearPromptOnDone: true,
+        },
+      );
+
+      return p;
+    } catch (_) {}
+  }
+  static async $select(message, choices, defaultValue) {
+    try {
+      const p = await inquirer.select(
+        {
+          message,
+          choices: choices,
+          default: defaultValue,
+        },
+        {
+          // clearPromptOnDone: true,
+        },
+      );
+
+      return p;
+    } catch (_) {}
+  }
+  static async $checkbox(message, choices) {
+    try {
+      const p = await inquirer.checkbox(
+        {
+          message,
+          choices,
+        },
+        {
+          clearPromptOnDone: true,
+        },
+      );
+
+      return p;
+    } catch (_) {}
+  }
+
+  static async $number(message, defaultValue = 0) {
+    try {
+      const p = await inquirer.number(
+        {
+          message,
+          default: defaultValue,
+        },
+        {
+          clearPromptOnDone: true,
+        },
+      );
+
+      return p;
+    } catch (_) {}
+  }
+}
+
+module.exports = Prompter;

package/fast.ejs.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "./fast.ejs.schema.json",
+  "build": {
+    "interval": 100,
+    "output": "build",
+    "useIndexRouting": true
+  },
+  "components": {
+    "dir": "app/components"
+  },
+  "data": {
+    "allow": "all",
+    "dir": "app/data"
+  },
+  "pages": {
+    "dir": "app/pages"
+  },
+  "tailwind": {
+    "imports": [],
+    "output": "public/app.css"
+  }
+}

package/fast.ejs.schema.json

@@ -0,0 +1,93 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "fast-ejs configuration schema",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "build": {
+      "properties": {
+        "output": {
+          "default": "build",
+          "description": "The output folder where HTML files will be generated",
+          "type": "string"
+        },
+        "interval": {
+          "default": 100,
+          "description": "Interval in milliseconds between each build",
+          "type": "number"
+        },
+        "useIndexRouting": {
+          "default": true,
+          "description": "Whether if should build route/index.html instead of route.html",
+          "type": "boolean"
+        }
+      },
+      "required": ["output"],
+      "additionalProperties": false
+    },
+
+    "components": {
+      "properties": {
+        "dir": {
+          "default": "app/components",
+          "description": "The folder containing your EJS components",
+          "type": "string"
+        }
+      },
+      "required": ["dir"],
+      "additionalProperties": false
+    },
+    "data": {
+      "properties": {
+        "dir": {
+          "default": "app/data",
+          "description": "The folder containing global and local data files (global.data.js/json, local.data.js/json)",
+          "type": "string"
+        },
+        "allow": {
+          "default": "all",
+          "description": "Specify the data file format to use: 'js' for JavaScript, 'json' for JSON, or 'all' to accept both",
+          "enum": ["js", "json", "all"],
+          "type": "string"
+        }
+      },
+      "required": ["dir"],
+      "additionalProperties": false
+    },
+
+    "pages": {
+      "properties": {
+        "dir": {
+          "default": "app/pages",
+          "description": "The folder containing your EJS templates",
+          "type": "string"
+        }
+      },
+      "required": ["dir"],
+      "additionalProperties": false
+    },
+    "tailwind": {
+      "properties": {
+        "imports": {
+          "default": [],
+          "description": "List of external CSS URLs to include in the Tailwind output",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "output": {
+          "default": "public/app.css",
+          "description": "Output file of tailwind. Relative to pages directory.",
+          "type": "string"
+        }
+      },
+      "required": ["output"],
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["pages", "build"]
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "fast-ejs-builder",
+  "version": "0.0.0",
+  "description": "Fast-EJS is a simple and fast tool to pre-render EJS templates into static HTML files with clean conventions and flexible data handling.",
+  "keywords": [
+    "tailwind",
+    "html",
+    "build"
+  ],
+  "homepage": "https://github.com/D3R50N/tailwind-html#readme",
+  "bugs": {
+    "url": "https://github.com/D3R50N/tailwind-html/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/D3R50N/tailwind-html.git"
+  },
+  "license": "MIT",
+  "author": "D3R50N",
+  "type": "commonjs",
+  "main": "index.js",
+  "bin": {
+    "fast-ejs": "bin/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "dev": "nodemon index.js"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^8.2.0",
+    "autoprefixer": "^10.4.23",
+    "dotenv": "^17.2.3",
+    "ejs": "^4.0.1",
+    "nodemon": "^3.1.11",
+    "postcss": "^8.5.6",
+    "prettier": "^3.8.0",
+    "tailwindcss": "^3.4.17"
+  }
+}

package/src/build-dev.js

@@ -0,0 +1,34 @@
+const { args, _d, _p } = require("../core");
+const ejsbuild = require("../src/build");
+const nodemon = require("nodemon");
+const { config } = require("../core/lib");
+
+async function ejsbuild_dev() {
+  const toWatch = [
+    config.pages.dir,
+    config.components.dir,
+    config.data.dir,
+    ".env",
+  ];
+
+  _d("Watching :", toWatch.map((d) => `'${d}'`).join(", "));
+  await ejsbuild(); // needs await to get config
+
+  nodemon({
+    watch: toWatch.map(_p),
+    ignore: [],
+    delay: config.build.interval,
+    ext: "*",
+  });
+
+  nodemon.on("restart", (files) => {
+    ejsbuild(1);
+  });
+
+  nodemon.on("quit", () => {
+    _d("Session ended 🛑");
+    process.exit();
+  });
+}
+
+module.exports = ejsbuild_dev;