nibula 1.2.2 → 1.2.4

package/tools/assistant.js

@@ -1,152 +1,123 @@
-const readline = require('readline');
-
-const { addPage, removePage, renamePage, pageExists } = require('./modules/updatePage');
-const { updateOutputPath, getCurrentOutputPath } = require('./modules/updateOutputPath');
-const { validatePageName, validateOutputPath, checkRequiredFiles } = require('./modules/validation');
-const { toKebabCase } = require('./modules/utils');
-const { color } = require('./modules/constants');
-
-const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-    terminal: true,
-});
-
-function sanitizeInput(value) {
-    return (value ?? '').replace(/[\x00-\x1F\x7F]/g, '').trim();
-}
-
-function ask(prompt) {
-    return new Promise((resolve) => {
-        const onClose = () => resolve(null);
-        rl.once('close', onClose);
-        rl.question(prompt, (answer) => {
-            rl.off('close', onClose);
-            resolve(sanitizeInput(answer));
-        });
-    });
-}
-
-async function confirm(prompt) {
-    const answer = await ask(`${prompt} ${color.dim}[y/N]${color.reset} `);
-    return /^y(es)?$/i.test((answer ?? '').trim());
-}
-
-async function askPageName(prompt) {
-    const raw = await ask(prompt);
-    if (raw === null) return null;
-
-    const name = toKebabCase(raw);
-    const error = validatePageName(name);
-    if (error) {
-        console.log(`\n${color.red}✖ ${error}${color.reset}`);
-        return null;
-    }
-    return name;
-}
-
-async function handleCreate() {
-    const name = await askPageName(`\n${color.green}❯${color.reset} Name of the new page: `);
-    if (name) addPage(name);
-}
-
-async function handleRemove() {
-    const name = await askPageName(`\n${color.red}❯${color.reset} Name of the page to remove: `);
-    if (!name) return;
-
-    if (!pageExists(name)) {
-        console.log(`\n${color.yellow}⚠ Page "${name}" does not exist.${color.reset}`);
-        return;
-    }
-
-    const confirmed = await confirm(`This permanently deletes all files for "${name}".`);
-    if (!confirmed) {
-        console.log(`\n${color.dim}Cancelled.${color.reset}`);
-        return;
-    }
-    removePage(name);
-}
-
-async function handleRename() {
-    const oldName = await askPageName(`\n${color.yellow}❯${color.reset} Page to rename: `);
-    if (!oldName) return;
-
-    const newName = await askPageName(`${color.yellow}❯${color.reset} New name: `);
-    if (!newName) return;
-
-    if (oldName === newName) {
-        console.log(`\n${color.yellow}⚠ Old and new name are the same.${color.reset}`);
-        return;
-    }
-    renamePage(oldName, newName);
-}
-
-async function handleOutputPath() {
-    const current = getCurrentOutputPath();
-    const label = current ? `\n${color.dim}Current path: "${current}"${color.reset}\n` : '\n';
-
-    const input = await ask(`${label}${color.magenta}❯${color.reset} New output path: `);
-    if (input === null) return;
-
-    const error = validateOutputPath(input);
-    if (error) {
-        console.log(`\n${color.red}✖ ${error}${color.reset}`);
-        return;
-    }
-    updateOutputPath(input);
-}
-
-const MENU_ACTIONS = {
-    '1': handleCreate,
-    '2': handleRemove,
-    '3': handleRename,
-    '4': handleOutputPath,
-};
-
-function renderMenu() {
-    console.log(`\n${color.cyan}${color.bold}╭─────────────────╮`);
-    console.log(`│    Nibula CLI   │`);
-    console.log(`╰─────────────────╯${color.reset}\n`);
-    console.log(`  ${color.green}1.${color.reset} Create page`);
-    console.log(`  ${color.red}2.${color.reset} Remove page`);
-    console.log(`  ${color.yellow}3.${color.reset} Rename page`);
-    console.log(`  ${color.magenta}4.${color.reset} Configure output path`);
-    console.log(`  ${color.dim}CTRL + C to exit\n`);
-}
-
-async function main() {
-    const missing = checkRequiredFiles();
-    if (missing.length > 0) {
-        console.log(`\n${color.red}✖ This project is missing required files:${color.reset}`);
-        for (const item of missing) {
-            console.log(`  ${color.red}-${color.reset} ${item.label}`);
-        }
-        console.log(`\n${color.dim}The project may be incomplete or created with a different Nibula version.${color.reset}`);
-        rl.close();
-        process.exit(1);
-    }
-
-    while (true) {
-        renderMenu();
-
-        const choice = await ask(`${color.cyan}❯${color.reset} Choose an option: `);
-        if (choice === null) break;
-
-        const action = MENU_ACTIONS[choice];
-        if (!action) {
-            console.log(`\n${color.red}✖ Invalid option.${color.reset}`);
-            continue;
-        }
-
-        try {
-            await action();
-        } catch (err) {
-            console.log(`\n${color.red}✖ Unexpected error: ${err.message}${color.reset}`);
-        }
-    }
-
-    rl.close();
-    process.exit(0);
-}
-
+const settings = require('./config/settings.json');
+const { message } = require('./lib/logger');
+const { toKebabCase } = require('./lib/text');
+const { validatePageName, validateOutputPath, checkRequiredFiles } = require('./lib/validation');
+const { addPage, removePage, renamePage } = require('./lib/pageActions');
+const { pageExists } = require('./lib/pageArtifacts');
+const { updateOutputPath, getCurrentOutputPath } = require('./lib/outputPath');
+const { ask, confirm, close } = require('./cli/prompt');
+const ui = require('./cli/ui');
+
+const NEW_LINE = '\n';
+const NO_PREFIX = '';
+
+async function askPageName(prompt) {
+    const raw = await ask(prompt);
+    if (raw === null) return null;
+
+    const name = toKebabCase(raw);
+    const error = validatePageName(name);
+    if (error) {
+        ui.error(error);
+        return null;
+    }
+    return name;
+}
+
+async function handleCreate() {
+    const name = await askPageName(ui.promptLine(message('cli.createPrompt')));
+    if (name) addPage(name);
+}
+
+async function handleRemove() {
+    const name = await askPageName(ui.promptLine(message('cli.removePrompt')));
+    if (!name) return;
+
+    if (!pageExists(name)) {
+        ui.warning(message('cli.pageNotFound', { name }));
+        return;
+    }
+
+    const confirmed = await confirm(message('cli.confirmRemove', { name }));
+    if (!confirmed) {
+        ui.notice(message('cli.cancelled'));
+        return;
+    }
+    removePage(name);
+}
+
+async function handleRename() {
+    const oldName = await askPageName(ui.promptLine(message('cli.renameFromPrompt')));
+    if (!oldName) return;
+
+    const newName = await askPageName(ui.promptLine(message('cli.renameToPrompt'), NO_PREFIX));
+    if (!newName) return;
+
+    if (oldName === newName) {
+        ui.warning(message('cli.sameName'));
+        return;
+    }
+    renamePage(oldName, newName);
+}
+
+async function handleOutputPath() {
+    const current = getCurrentOutputPath();
+    const prefix = current
+        ? ui.noticePrefix(message('cli.currentOutputPath', { path: current }))
+        : NEW_LINE;
+
+    const input = await ask(ui.promptLine(message('cli.outputPathPrompt'), prefix));
+    if (input === null) return;
+
+    const error = validateOutputPath(input);
+    if (error) {
+        ui.error(error);
+        return;
+    }
+    updateOutputPath(input);
+}
+
+const ACTIONS = {
+    createPage: handleCreate,
+    removePage: handleRemove,
+    renamePage: handleRename,
+    outputPath: handleOutputPath,
+};
+
+function findAction(choice) {
+    const item = settings.cli.menu.find((entry) => entry.key === choice);
+    return item ? ACTIONS[item.action] : null;
+}
+
+async function main() {
+    const missing = checkRequiredFiles();
+    if (missing.length > 0) {
+        ui.renderMissingFiles(missing);
+        close();
+        process.exit(1);
+    }
+
+    while (true) {
+        ui.renderMenu();
+
+        const choice = await ask(ui.promptLine(message('cli.menuPrompt'), NO_PREFIX));
+        if (choice === null) break;
+
+        const action = findAction(choice);
+        if (!action) {
+            ui.error(message('cli.invalidOption'));
+            continue;
+        }
+
+        try {
+            await action();
+        } catch (error) {
+            ui.error(message('cli.unexpectedError', { error: error.message }));
+        }
+    }
+
+    close();
+    process.exit(0);
+}
+
 main();

package/tools/buildJs.js

@@ -1,37 +1,39 @@
-const esbuild = require('esbuild');
-const glob = require('glob');
-const path = require('path');
-const fs = require('fs');
-const { findProjectRoot, NOT_INSIDE_PROJECT_MESSAGE } = require('./modules/constants');
-
-const root = findProjectRoot(process.cwd());
-if (!root) {
-    console.error(NOT_INSIDE_PROJECT_MESSAGE);
-    process.exit(1);
-}
-
-const pkg = JSON.parse(fs.readFileSync(path.join(root, 'package.json'), 'utf-8'));
-const outputDir = pkg.outputDir || 'out';
-const isWatch = process.argv.includes('--watch');
-
-const posix = (p) => p.split(path.sep).join('/');
-const jsFiles = glob.sync(posix(path.join(root, 'src/frontend/js/pages/*.js')));
-const tsFiles = glob.sync(posix(path.join(root, 'src/frontend/ts/pages/*.ts')));
-const entryPoints = [...jsFiles, ...tsFiles];
-
-if (entryPoints.length === 0) {
-    process.exit(0);
-}
-
-const options = {
-    entryPoints,
-    bundle: true,
-    outdir: path.join(root, outputDir, 'js/pages'),
-    minify: !isWatch,
-};
-
-if (isWatch) {
-    esbuild.context(options).then((ctx) => ctx.watch()).catch(() => process.exit(1));
-} else {
-    esbuild.build(options).catch(() => process.exit(1));
-}
+const path = require('path');
+const esbuild = require('esbuild');
+const glob = require('glob');
+const settings = require('./config/settings.json');
+const { PATHS } = require('./lib/paths');
+const { readPackageJson, allScriptEntries } = require('./lib/project');
+
+const WATCH_FLAG = '--watch';
+const PATH_SEPARATOR = '/';
+
+function toPosix(target) {
+    return target.split(path.sep).join(PATH_SEPARATOR);
+}
+
+function collectEntryPoints() {
+    return allScriptEntries().flatMap((entries) => glob.sync(toPosix(path.join(PATHS.root, entries))));
+}
+
+const packageJson = readPackageJson();
+const outputDirectory = packageJson[settings.packageJson.outputKey] || settings.project.defaultOutputDirectory;
+const watch = process.argv.includes(WATCH_FLAG);
+const entryPoints = collectEntryPoints();
+
+if (entryPoints.length === 0) {
+    process.exit(0);
+}
+
+const options = {
+    entryPoints,
+    bundle: true,
+    outdir: path.join(PATHS.root, outputDirectory, ...settings.build.scriptOutput.split(PATH_SEPARATOR)),
+    minify: !watch,
+};
+
+if (watch) {
+    esbuild.context(options).then((context) => context.watch()).catch(() => process.exit(1));
+} else {
+    esbuild.build(options).catch(() => process.exit(1));
+}

package/tools/cleanOutput.js

@@ -1,25 +1,23 @@
-const fs = require('fs');
-const path = require('path');
-const { findProjectRoot, NOT_INSIDE_PROJECT_MESSAGE } = require('./modules/constants');
-
-const root = findProjectRoot(process.cwd());
-if (!root) {
-    console.error(NOT_INSIDE_PROJECT_MESSAGE);
-    process.exit(1);
-}
-
-const pkg = JSON.parse(fs.readFileSync(path.join(root, 'package.json'), 'utf-8'));
-
-if (!pkg.outputDir) {
-    console.log('(!) outputDir not found in package.json');
-    process.exit(1);
-}
-
-const outputDir = path.resolve(root, pkg.outputDir);
-
-if (fs.existsSync(outputDir)) {
-    fs.rmSync(outputDir, { recursive: true, force: true });
-    console.log(`(✓) cleaned → ${outputDir}`);
-} else {
-    console.log(`(i) nothing to clean → ${outputDir}`);
-}
+const path = require('path');
+const settings = require('./config/settings.json');
+const { PATHS } = require('./lib/paths');
+const { readPackageJson } = require('./lib/project');
+const { removeDirectory } = require('./lib/files');
+const { log } = require('./lib/logger');
+
+const OUTPUT_KEY = settings.packageJson.outputKey;
+
+const packageJson = readPackageJson();
+
+if (!packageJson[OUTPUT_KEY]) {
+    log('output.missingConfiguration', { key: OUTPUT_KEY, file: settings.paths.packageJson });
+    process.exit(1);
+}
+
+const outputDirectory = path.resolve(PATHS.root, packageJson[OUTPUT_KEY]);
+
+if (removeDirectory(outputDirectory)) {
+    log('output.cleaned', { path: outputDirectory });
+} else {
+    log('output.nothingToClean', { path: outputDirectory });
+}

package/tools/cli/prompt.js

@@ -0,0 +1,40 @@
+const readline = require('readline');
+const settings = require('../config/settings.json');
+const { color } = require('../lib/colors');
+
+const CONTROL_CHARACTERS_PATTERN = /[\x00-\x1F\x7F]/g;
+const AFFIRMATIVE_PATTERN = /^y(es)?$/i;
+const CONFIRM_HINT = settings.cli.confirmHint;
+const EMPTY = '';
+
+const readlineInterface = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+    terminal: true,
+});
+
+function sanitizeInput(value) {
+    return (value ?? EMPTY).replace(CONTROL_CHARACTERS_PATTERN, EMPTY).trim();
+}
+
+function ask(prompt) {
+    return new Promise((resolve) => {
+        const onClose = () => resolve(null);
+        readlineInterface.once('close', onClose);
+        readlineInterface.question(prompt, (answer) => {
+            readlineInterface.off('close', onClose);
+            resolve(sanitizeInput(answer));
+        });
+    });
+}
+
+async function confirm(prompt) {
+    const answer = await ask(`${prompt} ${color.dim}${CONFIRM_HINT}${color.reset} `);
+    return AFFIRMATIVE_PATTERN.test((answer ?? EMPTY).trim());
+}
+
+function close() {
+    readlineInterface.close();
+}
+
+module.exports = { ask, confirm, close };

package/tools/cli/ui.js

@@ -0,0 +1,74 @@
+const settings = require('../config/settings.json');
+const { color } = require('../lib/colors');
+const { message } = require('../lib/logger');
+
+const SYMBOLS = settings.cli.symbols;
+const COLORS = settings.cli.colors;
+const MENU = settings.cli.menu;
+const BOX_WIDTH = settings.cli.boxWidth;
+const BOX_TITLE = settings.cli.title;
+const BOX_TOP_LEFT = '\u256d';
+const BOX_TOP_RIGHT = '\u256e';
+const BOX_BOTTOM_LEFT = '\u2570';
+const BOX_BOTTOM_RIGHT = '\u256f';
+const BOX_HORIZONTAL = '\u2500';
+const BOX_VERTICAL = '\u2502';
+const NEW_LINE = '\n';
+const SPACE = ' ';
+
+function line(colorName, text) {
+    return `${color[colorName]}${text}${color.reset}`;
+}
+
+function promptLine(text, prefix = NEW_LINE) {
+    return `${prefix}${line(COLORS.prompt, SYMBOLS.prompt)} ${text}`;
+}
+
+function error(text) {
+    console.log(`${NEW_LINE}${line(COLORS.error, `${SYMBOLS.error} ${text}`)}`);
+}
+
+function warning(text) {
+    console.log(`${NEW_LINE}${line(COLORS.warning, `${SYMBOLS.warning} ${text}`)}`);
+}
+
+function notice(text) {
+    console.log(`${NEW_LINE}${line(COLORS.notice, text)}`);
+}
+
+function noticePrefix(text) {
+    return `${NEW_LINE}${line(COLORS.notice, text)}${NEW_LINE}`;
+}
+
+function centeredTitle() {
+    const padding = BOX_WIDTH - BOX_TITLE.length;
+    const left = SPACE.repeat(Math.ceil(padding / 2));
+    const right = SPACE.repeat(Math.floor(padding / 2));
+    return `${left}${BOX_TITLE}${right}`;
+}
+
+function renderMenu() {
+    const border = BOX_HORIZONTAL.repeat(BOX_WIDTH);
+
+    console.log(`${NEW_LINE}${color[COLORS.box]}${color.bold}${BOX_TOP_LEFT}${border}${BOX_TOP_RIGHT}`);
+    console.log(`${BOX_VERTICAL}${centeredTitle()}${BOX_VERTICAL}`);
+    console.log(`${BOX_BOTTOM_LEFT}${border}${BOX_BOTTOM_RIGHT}${color.reset}${NEW_LINE}`);
+
+    for (const item of MENU) {
+        console.log(`  ${line(COLORS.menuKey, `${item.key}.`)} ${item.label}`);
+    }
+
+    console.log(`${NEW_LINE}${line(COLORS.notice, message('cli.exitHint'))}${NEW_LINE}`);
+}
+
+function renderMissingFiles(items) {
+    console.log(`${NEW_LINE}${line(COLORS.error, `${SYMBOLS.error} ${message('cli.missingFiles')}`)}`);
+
+    for (const item of items) {
+        console.log(`  ${line(COLORS.error, SYMBOLS.bullet)} ${item.label}`);
+    }
+
+    console.log(`${NEW_LINE}${line(COLORS.notice, message('cli.incompleteProject'))}`);
+}
+
+module.exports = { promptLine, noticePrefix, error, warning, notice, renderMenu, renderMissingFiles };

package/tools/config/messages.json

@@ -0,0 +1,76 @@
+{
+  "project": {
+    "notInside": "Not inside a Nibula project."
+  },
+  "validation": {
+    "invalidName": "Invalid name.",
+    "invalidNameCharacters": "Page name can only contain lowercase letters, numbers, and hyphens.",
+    "nameStartsWithNumber": "Page name cannot start with a number.",
+    "protectedName": "\"{name}\" is a protected page name.",
+    "invalidPath": "Invalid path.",
+    "invalidPathCharacters": "Path contains invalid characters.",
+    "templatesLabel": "CLI page templates"
+  },
+  "page": {
+    "alreadyExists": "[skip] page \"{name}\" already exists",
+    "doesNotExist": "[skip] page \"{name}\" does not exist",
+    "targetExists": "[skip] target page \"{name}\" already exists",
+    "templateMissing": "[skip] template not found: {path}",
+    "fileMissing": "[skip] not found: {path}",
+    "fileCreated": "[created] {path}",
+    "fileRenamed": "[renamed] {source} \u2192 {destination}",
+    "fileDeleted": "[deleted] {path}",
+    "createFailed": "[error] could not create page files: {error}",
+    "renameFailed": "[error] could not rename page files: {error}",
+    "deleteFailed": "[error] {path}: {error}"
+  },
+  "components": {
+    "fileMissing": "[skip] not found: {path}",
+    "anchorMissing": "[skip] no {anchor} anchor in {file}",
+    "blockAdded": "[updated] page block added for \"{name}\"",
+    "blockMissing": "[skip] page block for \"{name}\" not found",
+    "blockRemoved": "[cleaned] page block removed for \"{name}\"",
+    "blockRenamed": "[renamed] page block \"{source}\" \u2192 \"{destination}\""
+  },
+  "siteData": {
+    "fileMissing": "[skip] not found: {path}",
+    "parseFailed": "[error] cannot parse {file}: {error}",
+    "recordExists": "[skip] record \"{name}\" already exists",
+    "recordMissing": "[skip] record \"{name}\" not found",
+    "recordAdded": "[updated] record \"{name}\" added",
+    "recordRemoved": "[cleaned] record \"{name}\" removed",
+    "recordRenamed": "[updated] record \"{source}\" renamed to \"{destination}\""
+  },
+  "output": {
+    "emptyPath": "[skip] empty output path",
+    "readFailed": "[error] cannot read {file}: {error}",
+    "updateFailed": "[error] could not update output path: {error}",
+    "updating": "\nupdating output path \u2192 \"{path}\"",
+    "variableMissing": "[skip] {variable} not found in {file}",
+    "keyMissing": "[skip] {key} not found in {file}",
+    "fileUpdated": "[updated] {file} \u2192 {path}",
+    "directoryDeleted": "[deleted] {path}",
+    "refuseDelete": "[skip] refusing to delete \"{path}\" (outside project)",
+    "missingConfiguration": "(!) {key} not found in {file}",
+    "cleaned": "(\u2713) cleaned \u2192 {path}",
+    "nothingToClean": "(i) nothing to clean \u2192 {path}"
+  },
+  "cli": {
+    "createPrompt": "Name of the new page: ",
+    "removePrompt": "Name of the page to remove: ",
+    "renameFromPrompt": "Page to rename: ",
+    "renameToPrompt": "New name: ",
+    "outputPathPrompt": "New output path: ",
+    "menuPrompt": "Choose an option: ",
+    "currentOutputPath": "Current path: \"{path}\"",
+    "confirmRemove": "This permanently deletes all files for \"{name}\".",
+    "cancelled": "Cancelled.",
+    "pageNotFound": "Page \"{name}\" does not exist.",
+    "sameName": "Old and new name are the same.",
+    "invalidOption": "Invalid option.",
+    "unexpectedError": "Unexpected error: {error}",
+    "missingFiles": "This project is missing required files:",
+    "incompleteProject": "The project may be incomplete or created with a different Nibula version.",
+    "exitHint": "CTRL + C to exit"
+  }
+}