@nutin/cli 1.3.1 → 2.0.0

package/templates/base/src/styles/base/_variables.scss.hbs

@@ -1,86 +1 @@
-/* 
-	Variables used in libs (snackbar, popover){{#if stylinNutin}} and utility classes{{/if}}
-	Adapt to customize
-*/
-
-// colours (RGB)
-$background-color: rgb(255 255 255); // WHITE
-$text-color: rgb(0 0 0); // BLACK
-$primary-color: rgb(0 0 0); // BLACK
-$secondary-color: rgb(0 0 0); // BLACK
-$accent-color: rgb(0 0 0); // BLACK
-
-// snackbar colours
-$snack-success: rgb(76 175 80);
-$snack-error: rgb(244 67 54);
-$snack-info: rgb(33 150 243);
-$snack-default: rgb(153 153 153);
-
-{{#if stylinNutin}}
-/* 
-	Variables used in utility classes
-	Adapt to customize
-*/
-
-// fonts
-$primary-font: Arial, Helvetica, sans-serif;
-$secondary-font: Arial, Helvetica, sans-serif;
-
-// font sizes
-$font-sizes: (
-	smallest: 0.75rem,    // 12px
-	small: 0.875rem,      // 14px
-	medium: 1rem,         // 16px (base)
-	large: 1.5rem,       // 24px
-	largest: 2rem,      // 32px
-);
-
-// spacing (margin / padding / gap)
-$spacings: (
-	smallest: 0.25rem,   // 4px
-	small: 0.5rem,       // 8px
-	medium: 1rem,        // 16px
-	large: 1.5rem,       // 24px
-	largest: 2rem,       // 32px
-);
-
-// border radius
-$border-radius: (
-	small: 2px,
-	medium: 4px,
-	large: 8px,
-	pill: 9999px,
-);
-
-// box sizes
-$box-sizes: (
-	small: 32px,
-	medium: 64px,
-	large: 128px,
-	largest: 256px,
-);
-
-// shadows
-$shadows: (
-	small: 0 1px 2px rgba(0, 0, 0, 0.05),
-	medium: 0 4px 6px rgba(0, 0, 0, 0.1),
-	large: 0 10px 15px rgba(0, 0, 0, 0.15),
-);
-
-// breakpoints
-$breakpoints: (
-	small: 576px,
-	medium: 768px,
-	large: 992px,
-	largest: 1201px,
-);
-
-// animations
-// transition Duration
-$transitions: (
-	fast: 0.2s,
-	normal: 0.3s,
-	slow: 0.5s,
-);
-
-{{/if}}
+// variables

package/templates/base/src/styles/main.scss.hbs

@@ -1,19 +1,2 @@
-// Libraries styles (snackbar, popover){{#if transition}}, view transition styles{{/if}}.
-@use "core";
-
-{{#if stylinNutin}}
-// built-in classes
-@use "utilities";
-
-{{/if}}
-// global styles
+// CSS reset & global styles
 @use "styles";
-
-{{#if stylinNutin}}
-// custom classes
-@use "custom-classes";
-// components styles
-@use "components";
-// views styles
-@use "views";
-{{/if}}

package/templates/base/src/styles/tailwind.css.hbs

@@ -0,0 +1,2 @@
+@import "tailwindcss/theme.css" layer(theme);
+@import "tailwindcss/utilities.css" layer(utilities);

package/templates/base/tools/builder/builder.config.js.hbs

@@ -0,0 +1,40 @@
+import process from 'process';
+import nutinConfig from '../../nutin.config.js';
+import { errorExit } from '../utils/index.js';
+
+function validateConfig(config) {
+  if (!config || typeof config !== 'object') {
+    errorExit(new Error('nutin.config.js must export a default object.'), 'builder.config');
+  }
+  if (!config.builder || typeof config.builder !== 'object') {
+    errorExit(new Error('nutin.config.js is missing the required "builder" object.'), 'builder.config');
+  }
+  if (!Array.isArray(config.builder.sass?.paths)) {
+    errorExit(new Error('nutin.config.js is missing "builder.sass.paths" (expected an array).'), 'builder.config');
+  }
+  if (!config.builder.esbuild || typeof config.builder.esbuild !== 'object') {
+    errorExit(new Error('nutin.config.js is missing the required "builder.esbuild" object.'), 'builder.config');
+  }
+}
+
+validateConfig(nutinConfig);
+
+const wellKnownNonSEORoutes = [
+  '/400',
+  '/401',
+  '/403',
+  '/404',
+  '/500',
+  '/502',
+  '/503',
+  '/504',
+]
+
+export const builderConfig = {
+  ...nutinConfig.builder,
+  isProd: process.env.NODE_ENV === 'production',
+  i18n: nutinConfig.i18n,
+  tailwind: nutinConfig.tailwind,
+  generateSEO: nutinConfig.generateSEOFiles,
+  WELL_KNOWN_NON_SEO_ROUTES: wellKnownNonSEORoutes,
+};

package/templates/base/tools/builder/builder.js.hbs

@@ -1,38 +1,36 @@
 #!/usr/bin/env node
 
 import path from 'path';
-import { print, isProd, runScript } from '../utils/index.js';
+import { print, runScript } from '../utils/index.js';
+import { builderConfig } from './builder.config.js';
 
 const scriptsDir = path.join(process.cwd(), 'tools', 'builder', 'core');
 
-if (!isProd) print.boldInfo('For production, use build:prod.\n');
-print.boldHead(`Starting build...\n`);
-
-runScript(path.join(scriptsDir, 'copy-static.js'), 'Copying files...');
-
-if(!isProd) runScript(path.join(scriptsDir, 'tsc.js'), 'Running TypeScript compiler...');
-
-{{#if template}}
-runScript(path.join(scriptsDir, 'merge-templates.js'), 'Merging HTML templates in temp files...');
-{{else}}
-runScript(path.join(scriptsDir, 'minify-html.js'), 'Minifying inline templates...');
-{{/if}}
-{{#if i18n}}
-runScript(path.join(scriptsDir, 'build-i18n.js'), 'Combining locales for production...');
-{{/if}}
-runScript(path.join(scriptsDir, 'sass.js'), 'Compiling styles from main.scss...');
-runScript(path.join(scriptsDir, 'validate-html.js'), 'Adding and validating tags in index.html...');
-
-if (isProd) {
-	runScript(path.join(scriptsDir, 'esbuild.js'), 'Running esbuild...');
-	runScript(path.join(scriptsDir, 'hash-files.js'), 'Hashing files...');
-{{#if deployHelper}}
-	runScript(path.join(scriptsDir, 'compress-files.js'), 'Compressing files...');
-{{/if}}
+print.boldHead(`\nStarting build...`);
+
+runScript(path.join(scriptsDir, 'app', 'copy-static.js'), 'Copying files...');
+
+runScript(path.join(scriptsDir, 'html-index', 'validate-html.js'), 'Processing index.html...');
+runScript(path.join(scriptsDir, 'app', 'validate-routes.js'), 'Validating app routes...');
+
+runScript(path.join(scriptsDir, 'app', 'compile-ts.js'), 'Compiling TypeScript...');
+
+runScript(path.join(scriptsDir, 'html-templates', 'process-html-templates.js'), 'Processing HTML templates...');
+
+runScript(path.join(scriptsDir, 'styles', 'sass.js'), 'Compiling styles...');
+if (builderConfig.tailwind) runScript(path.join(scriptsDir, 'styles', 'tailwind.js'), 'Compiling Tailwind CSS...');
+
+if (builderConfig.i18n) runScript(path.join(scriptsDir, 'i18n', 'build-i18n.js'), 'Combining locales...');
+
+if (builderConfig.isProd) {
+	runScript(path.join(scriptsDir, 'prod-bundle', 'esbuild.js'), 'Running esbuild...');
+	runScript(path.join(scriptsDir, 'prod-bundle', 'hash-files.js'), 'Hashing files...');
+	runScript(path.join(scriptsDir, 'prod-bundle', 'compress-files.js'), 'Compressing files...');
+	if (builderConfig.generateSEO) runScript(path.join(scriptsDir, 'seo', 'generate-seo-files.js'), 'Generating SEO Files...');
 }
 
 runScript(path.join(scriptsDir, 'finalize-build.js'), 'Finalizing build...')
 
 print.boldSuccess(`\nBuild successful!\n`);
 
-if (!isProd) print.boldInfo('For production, use build:prod.');
+if (!builderConfig.isProd) print.info('For production, use "{{packageManager}} run build:prod"');

package/templates/base/tools/builder/core/app/binary-extensions.test.js.hbs

@@ -0,0 +1,16 @@
+import { BINARY_EXTENSIONS } from './binary-extensions.js';
+
+describe('BINARY_EXTENSIONS', () => {
+  it('is a Set containing common binary asset extensions', () => {
+    expect(BINARY_EXTENSIONS).toBeInstanceOf(Set);
+    expect(BINARY_EXTENSIONS.has('.png')).toBeTruthy();
+    expect(BINARY_EXTENSIONS.has('.woff2')).toBeTruthy();
+    expect(BINARY_EXTENSIONS.has('.gz')).toBeTruthy();
+  });
+
+  it('does not treat text/source extensions as binary', () => {
+    expect(BINARY_EXTENSIONS.has('.js')).toBeFalsy();
+    expect(BINARY_EXTENSIONS.has('.css')).toBeFalsy();
+    expect(BINARY_EXTENSIONS.has('.html')).toBeFalsy();
+  });
+});

package/templates/base/tools/builder/core/app/compile-ts.js.hbs

@@ -0,0 +1,16 @@
+import { runCommand, print, errorExit } from "../../../utils/index.js";
+import { builderConfig } from '../../builder.config.js';
+
+async function compileTS() {
+  // Prod bundles straight from .ts source (see prod-bundle/esbuild.js), so tsc only
+  // needs to type-check there, not emit — emitting would leave a stale, unmerged .js
+  // sibling next to each merged .ts view/component's source.
+  const args = ['--project', 'tsconfig.json'];
+  if (builderConfig.isProd) args.push('--noEmit');
+
+  await runCommand('tsc', args);
+}
+
+compileTS().catch((err) => {
+  errorExit(err, 'compile-ts');
+});

package/templates/base/tools/builder/core/{copy-static.js.hbs → app/copy-static.js.hbs}

@@ -1,22 +1,23 @@
 import fs from 'fs/promises';
 import path from 'path';
-import { exit } from 'process';
-import { getFilesRecursive, print, isVerbose, isProd } from '../../utils/index.js';
-import { BINARY_EXTENSIONS } from '../variables/binary-extensions.js';
+import { getFilesRecursive, print, errorExit } from '../../../utils/index.js';
+import { BINARY_EXTENSIONS } from './binary-extensions.js';
 import { PATHS } from './paths.js';
+import { builderConfig } from '../../builder.config.js';
 
 async function copyStatic() {
-  const extensions = [...BINARY_EXTENSIONS, 'html'];
-  if (isProd) extensions.push('.ts');
-
-  if (isVerbose) print.info(`File types that will be copied: ${Array.from(extensions)}`);
-
+  const extensions = [...BINARY_EXTENSIONS, '.html'];
+  if (builderConfig.isProd) extensions.push('.ts');
+
+  // Every build starts from a clean dist-build: a failed/interrupted prior
+  // build never gets renamed away by finalize-build.js, so a stale sibling
+  // (already merged, placeholder gone) can otherwise sit next to the next
+  // run's fresh output and trip merge-templates.js's per-sibling check.
+  await fs.rm(PATHS.temp, { recursive: true, force: true });
   await ensureDir(PATHS.tempSource);
 
   await copyFavicon();
-  {{#if i18n}}
   await copyConfig();
-  {{/if}}
 
   for (const extension of extensions) {
     const files = await getFilesRecursive(PATHS.source, extension);
@@ -27,17 +28,13 @@ async function copyStatic() {
 
       try {
         await copyFile(file, dest);
-        if (isVerbose) print.info(`✅ Copied: ${file} → ${dest}`);
       } catch (err) {
-        print.error(`❌ Failed to copy: ${file}. ${err.message}`);
-        exit(1);
+        throw new Error(`Failed to copy: ${file}. ${err.message}`, { cause: err });
       }
     }
   }
 
-  if (isProd) await copyJsonFiles(PATHS.source, PATHS.tempSource);
-
-  if (isVerbose) print.boldInfo(`Copy complete.\n`);
+  if (builderConfig.isProd) await copyJsonFiles(PATHS.source, PATHS.tempSource);
 }
 
 async function ensureDir(dir) {
@@ -55,33 +52,31 @@ async function copyFavicon() {
 
   try {
     await copyFile(srcPath, destPath);
-    if (isVerbose) print.info('Copied: favicon.ico');
-  } catch {
-    print.boldError('⚠️  No favicon found at public/favicon.ico');
+  } catch (err) {
+    if (err.code === 'ENOENT') print.warn('No favicon found at public/favicon.ico');
+    else errorExit(err, 'copy-static');
   }
 }
 
-{{#if i18n}}
 async function copyConfig() {
   const srcPath = path.resolve(path.join('config'));
-  const temp = isProd ? PATHS.temp : PATHS.tempSource;
+  const temp = builderConfig.isProd ? PATHS.temp : PATHS.tempSource;
   const destPath = path.join(temp, 'config');
   try {
     await copyJsonFiles(srcPath, destPath);
-{{#if testinNutin}}
-    // for tests to run
-    if (!isProd) await copyJsonFiles(srcPath, path.join(PATHS.temp, 'config'))
-{{/if}}
-    if (isVerbose) print.info('Config files copied');
-  } catch {
-    print.boldError('Issue when copying config files.');
-    exit(1);
+    await copyFile(path.resolve('nutin.config.js'), path.join(temp, 'nutin.config.js'));
+
+    // for testin-nutin tests to run
+    if (!builderConfig.isProd) {
+      await copyJsonFiles(srcPath, path.join(PATHS.temp, 'config'));
+      await copyFile(path.resolve('nutin.config.js'), path.join(PATHS.temp, 'nutin.config.js'));
+    }
+  } catch (err) {
+    errorExit(err, 'copy-static');
   }
 }
 
-{{/if}}
 async function copyJsonFiles(sourceDir, destDir) {
-  
   const items = await fs.readdir(sourceDir, { withFileTypes: true });
 
   for (const item of items) {
@@ -93,12 +88,10 @@ async function copyJsonFiles(sourceDir, destDir) {
     } else if (item.isFile() && path.extname(item.name) === '.json') {
       await fs.mkdir(path.dirname(destPath), { recursive: true });
       await fs.copyFile(sourcePath, destPath);
-      if (isVerbose) print.info(`Copied JSON: ${sourcePath} -> ${destPath}`);
     }
   }
 }
 
 copyStatic().catch((err) => {
-  print.boldError(`Unexpected error: ${err.message}`);
-  exit(1);
+  errorExit(err, 'copy-static');
 });

package/templates/base/tools/builder/core/app/validate-routes.js.hbs

@@ -0,0 +1,77 @@
+import { readFileSync } from 'fs';
+import path from 'path';
+import ts from 'typescript';
+import { print, errorExit } from '../../../utils/index.js';
+import { PATHS } from './paths.js';
+
+const ROUTES_FILE = path.join(PATHS.sourceApp, 'routes.ts');
+
+function findAppRoutesObjectLiteral(sourceFile) {
+  let objectLiteral;
+
+  ts.forEachChild(sourceFile, function visit(node) {
+    if (
+      ts.isVariableDeclaration(node) &&
+      ts.isIdentifier(node.name) &&
+      node.name.text === 'appRoutes' &&
+      node.initializer &&
+      ts.isObjectLiteralExpression(node.initializer)
+    ) {
+      objectLiteral = node.initializer;
+      return;
+    }
+    ts.forEachChild(node, visit);
+  });
+
+  return objectLiteral;
+}
+
+function getRouteKeys(objectLiteral) {
+  return objectLiteral.properties
+    .filter((prop) => ts.isPropertyAssignment(prop) && ts.isStringLiteralLike(prop.name))
+    .map((prop) => prop.name.text);
+}
+
+function findDuplicates(keys) {
+  const seen = new Set();
+  const duplicates = new Set();
+
+  for (const key of keys) {
+    if (seen.has(key)) duplicates.add(key);
+    seen.add(key);
+  }
+
+  return [...duplicates];
+}
+
+function validateRoutes() {
+  let source;
+  try {
+    source = readFileSync(ROUTES_FILE, 'utf-8');
+  } catch {
+    errorExit(`Failed to read ${ROUTES_FILE}`);
+  }
+
+  const sourceFile = ts.createSourceFile(ROUTES_FILE, source, ts.ScriptTarget.Latest, true);
+  const objectLiteral = findAppRoutesObjectLiteral(sourceFile);
+
+  if (!objectLiteral) {
+    errorExit(`Could not find an "appRoutes" object literal in ${ROUTES_FILE}`);
+  }
+
+  const duplicates = findDuplicates(getRouteKeys(objectLiteral));
+
+  if (duplicates.length > 0) {
+    const list = duplicates.map((key) => `"${key}"`).join(', ');
+    errorExit(
+      `Duplicate route key(s) in ${ROUTES_FILE}: ${list} — an earlier route with this path is silently unreachable.`
+    );
+  }
+
+}
+
+try {
+  validateRoutes();
+} catch(err) {
+  errorExit(err, 'validate-routes');
+}

package/templates/base/tools/builder/core/finalize-build.js.hbs

@@ -1,19 +1,24 @@
-import { print, isProd, isVerbose } from "../../utils/index.js";
 import fs from 'fs';
 import path from 'path';
-import { PATHS } from "./paths.js";
+import { PATHS } from "./app/paths.js";
+import { builderConfig } from '../builder.config.js';
+import { print, errorExit } from "../../utils/index.js";
 
 function finalizeBuild() {
-  if (isProd) removeFoldersAfterBundle();
+  if (builderConfig.isProd) removeFoldersAfterBundle();
+  if (builderConfig.isProd) removeNutinConfig();
   replaceDir(PATHS.temp, PATHS.build);
-  if (isVerbose) print.boldInfo('Build finalized.\n');
 }
 
 function removeFoldersAfterBundle() {
-  const foldersToRemove = ['core', 'libs', 'app'];
+  const foldersToRemove = [ 'core', 'app', path.join('..', 'config') ];
   const pathToFolder = (folder) => path.join(PATHS.tempSource, folder);
 
-  foldersToRemove.forEach(folder => fs.rmSync(pathToFolder(folder), { recursive : true }));
+  foldersToRemove.forEach(folder => fs.rmSync(pathToFolder(folder), { recursive: true, force: true }));
+}
+
+function removeNutinConfig() {
+  fs.rmSync(path.join(PATHS.temp, 'nutin.config.js'));
 }
 
 function replaceDir(src, dest) {
@@ -21,4 +26,8 @@ function replaceDir(src, dest) {
   fs.renameSync(src, dest);
 }
 
-finalizeBuild();
+try {
+  finalizeBuild();
+} catch(err) {
+  errorExit(err, 'finalize-build')
+}

package/templates/base/tools/builder/core/{add-tags.js.hbs → html-index/add-tags.js.hbs}

@@ -1,8 +1,8 @@
-import { print, isProd } from '../../utils/index.js';
 import { writeFile } from 'fs/promises';
+import { builderConfig } from '../../builder.config.js';
 
 export async function addTags(htmlContent, filePath) {
-  const scriptSrc = isProd ? "bundle.js" : "app/main.js";
+  const scriptSrc = builderConfig.isProd ? "bundle.js" : "app/main.js";
   
   const tags = [
     { type: 'stylesheet', href: 'main.css', position: 'head' },

package/templates/base/tools/builder/core/html-index/add-tags.test.js.hbs

@@ -0,0 +1,56 @@
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { addTags } from './add-tags.js';
+
+describe('addTags', () => {
+  let tmpDir;
+  let filePath;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'nutin-add-tags-'));
+    filePath = path.join(tmpDir, 'index.html');
+  });
+
+  afterEach(() => {
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+  });
+
+  it('inserts the stylesheet before </head> and the script before </body>', async () => {
+    const html = '<html><head><title>T</title></head><body></body></html>';
+
+    const result = await addTags(html, filePath);
+
+    expect(result).toBe(
+      '<html><head><title>T</title><link rel="stylesheet" href="/main.css"></head><body><script type="module" src="/app/main.js"></script></body></html>'
+    );
+  });
+
+  it('falls back to inserting the stylesheet before <title> when there is no </head>', async () => {
+    const html = '<html><title>T</title><body></body></html>';
+
+    const result = await addTags(html, filePath);
+
+    expect(result).toBe(
+      '<html><link rel="stylesheet" href="/main.css"><title>T</title><body><script type="module" src="/app/main.js"></script></body></html>'
+    );
+  });
+
+  it('appends both tags to the end when neither anchor is present', async () => {
+    const html = '<html></html>';
+
+    const result = await addTags(html, filePath);
+
+    expect(result).toBe(
+      '<html></html><link rel="stylesheet" href="/main.css"><script type="module" src="/app/main.js"></script>'
+    );
+  });
+
+  it('writes the modified html to filePath', async () => {
+    const html = '<html><head></head><body></body></html>';
+
+    const result = await addTags(html, filePath);
+
+    expect(fs.readFileSync(filePath, 'utf8')).toBe(result);
+  });
+});

package/templates/base/tools/builder/core/{validate-html.js.hbs → html-index/validate-html.js.hbs}

@@ -1,8 +1,7 @@
 import { readFile } from 'fs/promises';
-import { exit } from 'process';
-import { print, isVerbose } from '../../utils/index.js';
-import { PATHS } from './paths.js';
 import path from 'path';
+import { print, errorExit } from '../../../utils/index.js';
+import { PATHS } from '../app/paths.js';
 import { addTags } from './add-tags.js';
 
 async function validateHtml() {
@@ -27,13 +26,8 @@ async function validateHtml() {
   if (!/<link[^>]*rel=["']stylesheet["']/.test(htmlContent)) {
     errorExit('No stylesheet found in HTML');
   }
-
-  if (isVerbose) print.boldInfo('HTML validation passed\n');
-}
-
-function errorExit(message) {
-  print.boldError(`[ERROR] ${message}`);
-  exit(1);
 }
 
-validateHtml();
+validateHtml().catch((err) => {
+  errorExit(err, 'validate-html');
+});