@zeropress/build-pages 0.5.2 → 0.5.4

package/README.md

@@ -138,31 +138,20 @@ The CLI requires explicit input and output paths. The GitHub Action keeps safe d
 
 | Option | Default | Purpose |
 | --- | --- | --- |
-| `--source <dir>` | required | Source directory containing Markdown and public files |
+| `--source <dir>` | required | Dedicated source directory containing Markdown and public files |
 | `--destination <dir>` | required | Output directory |
 | `--theme docs` | `docs` | Bundled docs theme |
 | `--theme-path <dir>` | none | Custom ZeroPress theme directory |
 | `--config <path>` | `<source>/.zeropress/config.json` | Build Pages config |
 | `--site-url <url>` | config `site.url` | Canonical URL override |
 | `--skip-untitled-markdown` | `false` | Skip Markdown without a page title |
-| `--no-check-links` | false | Skip link checking |
-
-Equivalent environment variables:
-
-| Env | Maps to |
-| --- | --- |
-| `ZEROPRESS_PUBLIC_DIR` | `--source` |
-| `ZEROPRESS_OUT_DIR` | `--destination` |
-| `ZEROPRESS_THEME_DIR` | `--theme-path` |
-| `ZEROPRESS_BUILD_PAGES_CONFIG` | `--config` |
-| `ZEROPRESS_SITE_URL` | `--site-url` |
-| `ZEROPRESS_SKIP_UNTITLED_MARKDOWN=true` | `--skip-untitled-markdown` |
-
-CLI options take precedence over environment variables.
+| `--skip-link-check` | `false` | Skip link checking |
 
 ## Source Tree
 
-The source directory is both the Markdown source root and the public passthrough root. GitHub Action usage defaults to `./docs`; CLI usage requires `--source` or `ZEROPRESS_PUBLIC_DIR`.
+The source directory is both the Markdown source root and the public passthrough root. GitHub Action usage defaults to `./docs`; CLI usage requires `--source`.
+
+Use a dedicated content directory such as `docs/` or `documents/`. Repository root source (`--source ./`) is not supported, because Build Pages uses `.zeropress/` in the current working directory for internal working files.
 
 ```txt
 docs/
@@ -173,7 +162,9 @@ docs/
     config.json
 ```
 
-Build Pages stages the source tree before calling `@zeropress/build`, so `--source ./` and `--destination ./_site` are supported when you intentionally want to build from the repository root. Generated ZeroPress output wins over staged public files.
+Build Pages stages the source tree before calling `@zeropress/build`. Generated ZeroPress output wins over staged public files.
+
+The source directory must not overlap the destination directory, the selected theme directory, or the internal `.zeropress/` working directory.
 
 Ignored while staging and Markdown discovery:
 
@@ -288,9 +279,9 @@ Schemas:
 - `schemas/zeropress-build-pages.config.v0.1.schema.json`
 - `schemas/zeropress-build-pages.config.schema.json`
 
-## Generated Files
+## Internal `.zeropress/` Files
 
-Build Pages writes:
+Build Pages writes internal working files to `.zeropress/` in the current working directory. These files are not the final deploy output. The final static site is written to the `destination` directory.
 
 ```txt
 .zeropress/
@@ -300,10 +291,18 @@ Build Pages writes:
   public-assets/
 ```
 
-`build-pages-config.json` is the resolved user-facing Build Pages config used for the current run. It combines `.zeropress/config.json`, defaults, and CLI/env overrides where applicable.
+`build-pages-config.json` is the resolved user-facing Build Pages config used for the current run. It combines source config, defaults, and CLI or Action input overrides where applicable.
 
 `preview-data.json` is an internal generated build input for the ZeroPress renderer. Most users do not need to edit or understand this file.
 
+`build-report.json` records discovered Markdown counts, skipped Markdown files, front page resolution, and custom HTML slots.
+
+`public-assets/` is a temporary staged public root used before the final ZeroPress render.
+
+## Destination Output
+
+The `destination` directory contains the deployable static site. It includes generated ZeroPress HTML, copied public files, and original Markdown files unless they are excluded by the public passthrough rules.
+
 ## Development
 
 ```bash

package/action.yml

@@ -6,7 +6,7 @@ branding:
   color: blue
 inputs:
   source:
-    description: Source directory containing Markdown files and optional .zeropress/config.json.
+    description: Dedicated source directory containing Markdown files and optional .zeropress/config.json. Repository root source is not supported.
     required: false
     default: ./docs
   destination:
@@ -27,13 +27,13 @@ inputs:
     description: Canonical site URL override.
     required: false
   skip-untitled-markdown:
-    description: Skip Markdown files without an H1 instead of failing.
+    description: Skip Markdown files without a page title instead of failing.
     required: false
     default: "false"
-  check-links:
-    description: Warn about broken internal links after build.
+  skip-link-check:
+    description: Skip internal link checking after the site is built.
     required: false
-    default: "true"
+    default: "false"
 runs:
   using: node24
   main: dist/action.js

package/dist/action.js

@@ -1,4 +1,6 @@
 #!/usr/bin/env node
+import { createRequire as __zeropressCreateRequire } from "node:module";
+const require = __zeropressCreateRequire(import.meta.url);
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -62137,7 +62139,7 @@ async function linkExists(siteDir, link2) {
 // src/index.js
 var __dirname = path3.dirname(fileURLToPath(import.meta.url));
 var packageDir = path3.resolve(__dirname, "..");
-var prebuildScript = path3.join(packageDir, "src", "prebuild.js");
+var prebuildScript = __dirname === path3.join(packageDir, "dist") ? path3.join(__dirname, "prebuild.js") : path3.join(packageDir, "src", "prebuild.js");
 var PREVIEW_DATA_PATH = ".zeropress/preview-data.json";
 var STAGING_DIR = ".zeropress/public-assets";
 var DEFAULT_THEME = "docs";
@@ -62149,6 +62151,13 @@ async function runBuildPages(options2) {
   const stagingDir = path3.join(cwd, STAGING_DIR);
   const previewDataPath = path3.join(cwd, PREVIEW_DATA_PATH);
   const themeDir = resolveThemeDir(cwd, options2);
+  assertBuildPagesPathLayout({
+    cwd,
+    sourceDir,
+    destinationDir,
+    themeDir,
+    generatedDir
+  });
   await assertDirectory(sourceDir, "Source directory");
   await fs3.rm(generatedDir, { recursive: true, force: true });
   await fs3.mkdir(generatedDir, { recursive: true });
@@ -62195,7 +62204,7 @@ async function runBuildPages(options2) {
       process.env.ZEROPRESS_PUBLIC_DIR = previousPublicDir;
     }
   }
-  if (options2.checkLinks) {
+  if (!options2.skipLinkCheck) {
     const result = await checkInternalLinks(destinationDir);
     if (result.brokenLinks.length) {
       console.warn("Warning: broken internal links found:");
@@ -62229,6 +62238,26 @@ async function assertDirectory(dir, label) {
     throw new Error(`${label} is not a directory: ${dir}`);
   }
 }
+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 (!pathsOverlap2(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, options2) {
   const entries = await fs3.readdir(sourceDir, { withFileTypes: true });
   for (const entry of entries) {
@@ -62265,6 +62294,9 @@ function pathsOverlap2(firstPath, secondPath) {
   const second = path3.resolve(secondPath);
   return first === second || isPathInside2(first, second) || isPathInside2(second, first);
 }
+function samePath(firstPath, secondPath) {
+  return path3.resolve(firstPath) === path3.resolve(secondPath);
+}
 function isPathInside2(parentPath, childPath) {
   const relativePath = path3.relative(parentPath, childPath);
   return Boolean(relativePath) && !relativePath.startsWith("..") && !path3.isAbsolute(relativePath);
@@ -62283,7 +62315,7 @@ var options = {
   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 {
   await runBuildPages(options);