@zeropress/build-pages 0.5.1 → 0.5.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeropress/build-pages",
-  "version": "0.5.1",
+  "version": "0.5.4",
   "description": "ZeroPress Markdown build action and CLI for static hosting",
   "type": "module",
   "license": "MIT",
@@ -40,7 +40,8 @@
     "node": ">=18.18.0"
   },
   "dependencies": {
-    "@zeropress/build": "0.5.1"
+    "@zeropress/build": "0.5.1",
+    "gray-matter": "4.0.3"
   },
   "devDependencies": {
     "esbuild": "0.28.0"

package/schemas/zeropress-build-pages.config.v0.1.schema.json

@@ -35,8 +35,8 @@
     "site": {
       "type": "object",
       "additionalProperties": false,
-      "description": "Site metadata and output policy defaults used while generating preview-data.",
-      "markdownDescription": "Site metadata and output policy defaults used while generating preview-data.",
+      "description": "User-facing site metadata used by Build Pages.",
+      "markdownDescription": "User-facing site metadata used by Build Pages.",
       "properties": {
         "title": {
           "type": "string",
@@ -50,37 +50,8 @@
           "description": "Canonical site URL. Use an empty string or omit this field for local builds without canonical output.",
           "markdownDescription": "Canonical site URL. Use an empty string or omit this field for local builds without canonical output."
         },
-        "mediaBaseUrl": {
-          "type": "string"
-        },
-        "locale": {
-          "type": "string",
-          "minLength": 1
-        },
-        "postsPerPage": {
-          "type": "integer",
-          "minimum": 1
-        },
-        "dateFormat": {
-          "type": "string",
-          "minLength": 1
-        },
-        "timeFormat": {
-          "type": "string",
-          "minLength": 1
-        },
-        "timezone": {
-          "type": "string",
-          "minLength": 1
-        },
-        "permalinks": {
-          "$ref": "#/$defs/permalinks"
-        },
         "footer": {
           "$ref": "#/$defs/siteFooter"
-        },
-        "disallowComments": {
-          "type": "boolean"
         }
       }
     },
@@ -114,37 +85,6 @@
         }
       }
     },
-    "permalinks": {
-      "type": "object",
-      "additionalProperties": false,
-      "description": "Preview-data permalink defaults emitted by Build Pages.",
-      "markdownDescription": "Preview-data permalink defaults emitted by Build Pages.",
-      "properties": {
-        "output_style": {
-          "type": "string",
-          "enum": ["directory", "html-extension"]
-        },
-        "posts": {
-          "$ref": "#/$defs/permalinkPattern"
-        },
-        "pages": {
-          "$ref": "#/$defs/permalinkPattern"
-        },
-        "categories": {
-          "$ref": "#/$defs/permalinkPattern"
-        },
-        "tags": {
-          "$ref": "#/$defs/permalinkPattern"
-        }
-      }
-    },
-    "permalinkPattern": {
-      "type": "string",
-      "minLength": 1,
-      "pattern": "^/",
-      "description": "Absolute URL path pattern passed through to preview-data site.permalinks.",
-      "markdownDescription": "Absolute URL path pattern passed through to preview-data `site.permalinks`."
-    },
     "frontPage": {
       "type": "object",
       "additionalProperties": false,

package/src/action.js

@@ -1,14 +1,14 @@
 import { runBuildPages } from './index.js';
 
 const options = {
-  source: input('source') || './',
+  source: input('source') || './docs',
   destination: input('destination') || './_site',
   theme: input('theme') || 'docs',
   themePath: input('theme-path'),
   config: input('config'),
   siteUrl: input('site-url'),
   skipUntitledMarkdown: booleanInput('skip-untitled-markdown', false),
-  checkLinks: booleanInput('check-links', true),
+  skipLinkCheck: booleanInput('skip-link-check', false),
 };
 
 try {

package/src/index.js

@@ -7,9 +7,11 @@ import { checkInternalLinks } from './check-links.js';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const packageDir = path.resolve(__dirname, '..');
-const prebuildScript = path.join(packageDir, 'src', 'prebuild.js');
+const prebuildScript = __dirname === path.join(packageDir, 'dist')
+  ? path.join(__dirname, 'prebuild.js')
+  : path.join(packageDir, 'src', 'prebuild.js');
 const PREVIEW_DATA_PATH = '.zeropress/preview-data.json';
-const STAGING_DIR = '.zeropress/build-pages-public';
+const STAGING_DIR = '.zeropress/public-assets';
 const DEFAULT_THEME = 'docs';
 
 export async function runCli(argv = process.argv.slice(2)) {
@@ -42,6 +44,13 @@ export async function runBuildPages(options) {
   const previewDataPath = path.join(cwd, PREVIEW_DATA_PATH);
   const themeDir = resolveThemeDir(cwd, options);
 
+  assertBuildPagesPathLayout({
+    cwd,
+    sourceDir,
+    destinationDir,
+    themeDir,
+    generatedDir,
+  });
   await assertDirectory(sourceDir, 'Source directory');
   await fs.rm(generatedDir, { recursive: true, force: true });
   await fs.mkdir(generatedDir, { recursive: true });
@@ -93,7 +102,7 @@ export async function runBuildPages(options) {
     }
   }
 
-  if (options.checkLinks) {
+  if (!options.skipLinkCheck) {
     const result = await checkInternalLinks(destinationDir);
     if (result.brokenLinks.length) {
       console.warn('Warning: broken internal links found:');
@@ -105,7 +114,7 @@ export async function runBuildPages(options) {
   }
 }
 
-export function parseArgs(argv, env = process.env) {
+export function parseArgs(argv) {
   const flags = {};
 
   for (let index = 0; index < argv.length; index += 1) {
@@ -114,19 +123,14 @@ export function parseArgs(argv, env = process.env) {
       flags.skipUntitledMarkdown = true;
       continue;
     }
-    if (arg === '--check-links') {
-      flags.checkLinks = true;
-      continue;
-    }
-    if (arg === '--no-check-links') {
-      flags.checkLinks = false;
+    if (arg === '--skip-link-check') {
+      flags.skipLinkCheck = true;
       continue;
     }
 
     const valueOptions = new Set([
       '--source',
       '--destination',
-      '--out',
       '--theme',
       '--theme-path',
       '--config',
@@ -145,15 +149,24 @@ export function parseArgs(argv, env = process.env) {
     throw new Error(`Invalid arguments: unknown option ${arg}`);
   }
 
+  const source = flags.source || '';
+  const destination = flags.destination || '';
+  if (!source) {
+    throw new Error('Invalid arguments: --source <dir> is required.');
+  }
+  if (!destination) {
+    throw new Error('Invalid arguments: --destination <dir> is required.');
+  }
+
   return {
-    source: flags.source || env.ZEROPRESS_PUBLIC_DIR || '.',
-    destination: flags.destination || flags.out || env.ZEROPRESS_OUT_DIR || '_site',
+    source,
+    destination,
     theme: flags.theme || DEFAULT_THEME,
-    themePath: flags['theme-path'] || env.ZEROPRESS_THEME_DIR || '',
-    config: flags.config || env.ZEROPRESS_BUILD_PAGES_CONFIG || '',
-    siteUrl: flags['site-url'] || env.ZEROPRESS_SITE_URL || '',
-    skipUntitledMarkdown: flags.skipUntitledMarkdown ?? env.ZEROPRESS_SKIP_UNTITLED_MARKDOWN === 'true',
-    checkLinks: flags.checkLinks ?? true,
+    themePath: flags['theme-path'] || '',
+    config: flags.config || '',
+    siteUrl: flags['site-url'] || '',
+    skipUntitledMarkdown: flags.skipUntitledMarkdown === true,
+    skipLinkCheck: flags.skipLinkCheck === true,
   };
 }
 
@@ -164,16 +177,14 @@ Usage:
   zeropress-build-pages [options]
 
 Options:
-  --source <dir>                Source directory (default: .)
-  --destination <dir>           Output directory (default: _site)
-  --out <dir>                   Alias for --destination
+  --source <dir>                Dedicated source directory (required)
+  --destination <dir>           Output directory (required)
   --theme docs                  Bundled theme name (default: docs)
   --theme-path <dir>            Custom ZeroPress theme directory
   --config <path>               Config file (default: <source>/.zeropress/config.json)
   --site-url <url>              Canonical site URL override
-  --skip-untitled-markdown      Skip Markdown files without an H1
-  --check-links                 Warn about broken internal links (default)
-  --no-check-links              Skip internal link checking
+  --skip-untitled-markdown      Skip Markdown files without a page title
+  --skip-link-check             Skip internal link checking
   --help, -h                    Show help
   --version, -v                 Show version`);
 }
@@ -203,6 +214,32 @@ async function assertDirectory(dir, label) {
   }
 }
 
+function assertBuildPagesPathLayout({ cwd, sourceDir, destinationDir, themeDir, generatedDir }) {
+  if (samePath(sourceDir, cwd)) {
+    throw new Error(
+      'Source directory must be a dedicated content directory, not the current working directory. '
+      + `Received: ${formatPath(cwd, sourceDir)}`,
+    );
+  }
+
+  assertNoPathOverlap(cwd, 'Source directory', sourceDir, 'internal .zeropress working directory', generatedDir);
+  assertNoPathOverlap(cwd, 'Destination directory', destinationDir, 'internal .zeropress working directory', generatedDir);
+  assertNoPathOverlap(cwd, 'Theme directory', themeDir, 'internal .zeropress working directory', generatedDir);
+  assertNoPathOverlap(cwd, 'Source directory', sourceDir, 'destination directory', destinationDir);
+  assertNoPathOverlap(cwd, 'Source directory', sourceDir, 'theme directory', themeDir);
+}
+
+function assertNoPathOverlap(cwd, firstLabel, firstPath, secondLabel, secondPath) {
+  if (!pathsOverlap(firstPath, secondPath)) {
+    return;
+  }
+  throw new Error(
+    `${firstLabel} must not overlap the ${secondLabel}. `
+    + `${firstLabel}: ${formatPath(cwd, firstPath)}; `
+    + `${secondLabel}: ${formatPath(cwd, secondPath)}`,
+  );
+}
+
 async function copyPublicStaging(sourceDir, targetDir, options) {
   const entries = await fs.readdir(sourceDir, { withFileTypes: true });
 
@@ -254,6 +291,10 @@ function pathsOverlap(firstPath, secondPath) {
   return first === second || isPathInside(first, second) || isPathInside(second, first);
 }
 
+function samePath(firstPath, secondPath) {
+  return path.resolve(firstPath) === path.resolve(secondPath);
+}
+
 function isPathInside(parentPath, childPath) {
   const relativePath = path.relative(parentPath, childPath);
   return Boolean(relativePath) && !relativePath.startsWith('..') && !path.isAbsolute(relativePath);