@zeropress/build-pages 0.5.2 → 0.5.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeropress/build-pages",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "ZeroPress Markdown build action and CLI for static hosting",
   "type": "module",
   "license": "MIT",

package/src/action.js

@@ -8,7 +8,7 @@ const 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 {

package/src/index.js

@@ -7,7 +7,9 @@ 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/public-assets';
 const DEFAULT_THEME = 'docs';
@@ -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,8 +123,8 @@ export function parseArgs(argv, env = process.env) {
       flags.skipUntitledMarkdown = true;
       continue;
     }
-    if (arg === '--no-check-links') {
-      flags.checkLinks = false;
+    if (arg === '--skip-link-check') {
+      flags.skipLinkCheck = true;
       continue;
     }
 
@@ -140,24 +149,24 @@ export function parseArgs(argv, env = process.env) {
     throw new Error(`Invalid arguments: unknown option ${arg}`);
   }
 
-  const source = flags.source || env.ZEROPRESS_PUBLIC_DIR || '';
-  const destination = flags.destination || env.ZEROPRESS_OUT_DIR || '';
+  const source = flags.source || '';
+  const destination = flags.destination || '';
   if (!source) {
-    throw new Error('Invalid arguments: --source <dir> is required. You can also set ZEROPRESS_PUBLIC_DIR.');
+    throw new Error('Invalid arguments: --source <dir> is required.');
   }
   if (!destination) {
-    throw new Error('Invalid arguments: --destination <dir> is required. You can also set ZEROPRESS_OUT_DIR.');
+    throw new Error('Invalid arguments: --destination <dir> is required.');
   }
 
   return {
     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,
   };
 }
 
@@ -168,14 +177,14 @@ Usage:
   zeropress-build-pages [options]
 
 Options:
-  --source <dir>                Source directory (required, or ZEROPRESS_PUBLIC_DIR)
-  --destination <dir>           Output directory (required, or ZEROPRESS_OUT_DIR)
+  --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 a page title
-  --no-check-links              Skip internal link checking
+  --skip-link-check             Skip internal link checking
   --help, -h                    Show help
   --version, -v                 Show version`);
 }
@@ -205,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 });
 
@@ -256,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);

package/src/prebuild.js

@@ -5,7 +5,7 @@ import matter from 'gray-matter';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const rootDir = process.cwd();
-const sourceDir = resolveEnvPath(['ZEROPRESS_BUILD_PAGES_SOURCE', 'ZEROPRESS_PUBLIC_DIR'], 'docs');
+const sourceDir = resolveEnvPath(['ZEROPRESS_BUILD_PAGES_SOURCE'], 'docs');
 const defaultConfigPath = path.join(sourceDir, '.zeropress', 'config.json');
 const configPath = resolveOptionalEnvPath(['ZEROPRESS_BUILD_PAGES_CONFIG'], defaultConfigPath);
 const outDir = path.join(rootDir, '.zeropress');