seemore 1.11.1 → 1.12.0

package/README.md

@@ -220,7 +220,8 @@ export default {
   search: 'static', // or { provider: 'orama-cloud', endpoint, apiKey } / { provider: 'algolia', appId, apiKey, indexName }
   pageActions: ['copy-markdown', 'export-html'],
   exclude: ['drafts/**'],
-  auth: true, // password from SEEMORE_PASSWORD at build time
+  include: ['.notes'], // dot folders, build/, dist/ and similar are skipped unless listed here
+  auth: true,
 };
 ```
 

package/dist/cli/index.js

@@ -78,7 +78,7 @@ import pc5 from "picocolors";
 import { mkdirSync as mkdirSync3, mkdtempSync, readFileSync as readFileSync7, rmSync, writeFileSync as writeFileSync7 } from "fs";
 import { createRequire as createRequire4 } from "module";
 import { tmpdir as tmpdir3 } from "os";
-import { isAbsolute as isAbsolute2, join as join12, relative as relative2, resolve as resolve5 } from "path";
+import { isAbsolute as isAbsolute2, join as join12, relative as relative3, resolve as resolve5 } from "path";
 import pc2 from "picocolors";
 import { build as viteBuild } from "vite";
 
@@ -750,6 +750,8 @@ var configSchema = z.object({
   search: searchSchema.default("static"),
   pageActions: pageActionsSchema,
   exclude: z.array(z.string()).default([]),
+  /** Folders or globs to scan even though a default exclude (dot folders, `build/`, …) skips them. */
+  include: z.array(z.string()).default([]),
   auth: authSchema
 });
 
@@ -779,6 +781,7 @@ function resolveConfig(input, options) {
     search,
     pageActions: parsed.pageActions,
     exclude: parsed.exclude,
+    include: parsed.include,
     auth,
     root: options.root,
     configFile: options.configFile
@@ -958,9 +961,9 @@ function splitHash(value) {
   if (index === -1) return [value, void 0];
   return [value.slice(0, index), value.slice(index + 1)];
 }
-function joinPosix(fromDir, relative4) {
+function joinPosix(fromDir, relative5) {
   const segments = [...fromDir];
-  for (const part of toPosix(relative4).split("/")) {
+  for (const part of toPosix(relative5).split("/")) {
     if (part === "" || part === ".") continue;
     if (part === "..") segments.pop();
     else segments.push(part);
@@ -1046,14 +1049,9 @@ var metaSchema = z4.object({
 }).loose();
 function scan(options) {
   const contentRoot = resolve3(options.contentRoot);
-  const ignore = [...DEFAULT_EXCLUDES, ...options.exclude ?? []];
-  const contentFiles = globSync(["**/*.md", "**/*.mdx"], {
-    cwd: contentRoot,
-    ignore,
-    dot: false,
-    absolute: false
-  }).map(toPosix);
-  const metaFiles = globSync(["**/meta.json"], { cwd: contentRoot, ignore, dot: false, absolute: false }).map(toPosix);
+  const find = (patterns, keep) => findFiles(contentRoot, patterns, keep, options.exclude ?? [], options.include ?? []);
+  const contentFiles = find(["**/*.md", "**/*.mdx"], /\.mdx?$/);
+  const metaFiles = find(["**/meta.json"], /(?:^|\/)meta\.json$/);
   const { routes, errors, warnings } = resolveRoutes(contentFiles);
   const pages = [];
   for (const route of routes) {
@@ -1100,6 +1098,17 @@ ${parsed.error.issues.map((i) => `  - ${i.path.join(".") || "(root)"}: ${i.messa
   files.push(...synthesiseOrderMeta(pages, metaDirs));
   return { files, pages, errors, warnings };
 }
+function findFiles(contentRoot, patterns, keep, exclude, include) {
+  const found = new Set(
+    globSync(patterns, { cwd: contentRoot, ignore: [...DEFAULT_EXCLUDES, ...exclude], dot: false }).map(toPosix)
+  );
+  if (include.length > 0) {
+    for (const file of globSync(include, { cwd: contentRoot, ignore: exclude, dot: true }).map(toPosix)) {
+      if (keep.test(file)) found.add(file);
+    }
+  }
+  return [...found];
+}
 function synthesiseOrderMeta(pages, metaDirs) {
   const byDir = /* @__PURE__ */ new Map();
   for (const page of pages) {
@@ -1202,6 +1211,7 @@ function createContext(options) {
   const source = createSource({
     contentRoot,
     exclude: config.exclude,
+    include: config.include,
     siteTitle: config.title,
     includeDrafts: options.includeDrafts
   });
@@ -1841,8 +1851,27 @@ function readIfExists(path) {
 }
 
 // src/node/vite/watcher.ts
+import { relative as relative2 } from "path";
 import chokidar from "chokidar";
 var CONTENT_FILE = /\.(?:mdx?|json)$/i;
+var EXCLUDED_DIR = /(?:^|\/)(?:node_modules|dist|build|out|vendor|target|venv|deps|Pods|bower_components|\.[^/]+)(?:$|\/)/;
+var ALWAYS_EXCLUDED_DIR = /(?:^|\/)(?:node_modules|\.git)(?:$|\/)/;
+var GLOB_CHAR = /[*?[\]{}()!]/;
+function isWatchIgnored(relativePath, isFile, include) {
+  const rel = relativePath.replace(/\\/g, "/");
+  if (rel !== "" && EXCLUDED_DIR.test(rel) && !include.some((pattern) => reaches(pattern, rel))) return true;
+  return isFile && !CONTENT_FILE.test(rel);
+}
+function reaches(pattern, rel) {
+  const base = [];
+  for (const segment of pattern.replace(/^\.\//, "").split("/")) {
+    if (GLOB_CHAR.test(segment)) break;
+    base.push(segment);
+  }
+  const dir = base.join("/");
+  if (dir === "") return !ALWAYS_EXCLUDED_DIR.test(rel);
+  return rel === dir || rel.startsWith(`${dir}/`) || dir.startsWith(`${rel}/`);
+}
 function seemoreWatcherPlugin(ctx) {
   let watcher;
   return {
@@ -1853,10 +1882,7 @@ function seemoreWatcherPlugin(ctx) {
         ignoreInitial: true,
         ignored: (path, stats) => {
           if (path === ctx.config.configFile) return false;
-          const posix = path.replace(/\\/g, "/");
-          if (/(?:^|\/)(?:node_modules|\.git|dist|build|out|vendor|target|\.seemore)(?:$|\/)/.test(posix)) return true;
-          if (/(?:^|\/)\.[^/]+/.test(posix)) return true;
-          return stats?.isFile() === true && !CONTENT_FILE.test(posix);
+          return isWatchIgnored(relative2(ctx.contentRoot, path), stats?.isFile() === true, ctx.config.include);
         }
       });
       const onEvent = (event, path) => {
@@ -2155,7 +2181,7 @@ async function runBuild(options) {
     throw new Error(`No Markdown files found under ${contentRoot}. Point seemore at a folder that has some, or check \`exclude\`.`);
   }
   for (const warning of scan2.warnings) ctx.warnings.add(warning);
-  console.log(pc2.dim(`seemore  ${scan2.pages.length} pages from ${relative2(options.cwd, contentRoot) || "."}`));
+  console.log(pc2.dim(`seemore  ${scan2.pages.length} pages from ${relative3(options.cwd, contentRoot) || "."}`));
   await viteBuild(createViteConfig({ ctx, mode: "build", outDir, auth: password !== void 0 }));
   const template = readFileSync7(join12(outDir, "index.html"), "utf8");
   const routes = password === void 0 ? await prerenderPages(ctx, outDir, template) : countRoutes(ctx);
@@ -2174,7 +2200,7 @@ async function runBuild(options) {
     console.log(pc2.dim(`seemore  ${encrypted} files encrypted; visitors unlock them with the password`));
   }
   ctx.warnings.flush();
-  console.log(pc2.green(`seemore  ${routes} pages written to ${relative2(options.cwd, outDir) || outDir}`));
+  console.log(pc2.green(`seemore  ${routes} pages written to ${relative3(options.cwd, outDir) || outDir}`));
   return { outDir, routes };
 }
 async function prerenderPages(ctx, outDir, template) {
@@ -2203,7 +2229,7 @@ function countRoutes(ctx) {
 }
 function assertSafeOutDir(outDir, cwd, contentRoot) {
   const contains = (parent, child) => {
-    const rel = relative2(parent, child);
+    const rel = relative3(parent, child);
     return rel === "" || !rel.startsWith("..") && !isAbsolute2(rel);
   };
   for (const [name, dir] of [
@@ -2304,7 +2330,7 @@ async function runDev(options) {
 
 // src/cli/export.ts
 import { existsSync as existsSync4, mkdtempSync as mkdtempSync2, readFileSync as readFileSync8, readdirSync as readdirSync2, rmSync as rmSync2, statSync, writeFileSync as writeFileSync8, mkdirSync as mkdirSync4 } from "fs";
-import { basename as basename2, dirname as dirname9, extname, join as join13, relative as relative3, resolve as resolve6 } from "path";
+import { basename as basename2, dirname as dirname9, extname, join as join13, relative as relative4, resolve as resolve6 } from "path";
 import { tmpdir as tmpdir4 } from "os";
 import pc4 from "picocolors";
 import { build as viteBuild2 } from "vite";
@@ -2363,7 +2389,7 @@ ${errors.join("\n\n")}`);
   }
   const page = ctx.pages().find((candidate) => candidate.absPath === canonicalise(target));
   if (page === void 0) {
-    throw new Error(`${options.file} is not part of this site \u2014 excluded in the config, or outside ${relative3(options.cwd, contentRoot) || "."}.`);
+    throw new Error(`${options.file} is not part of this site \u2014 excluded in the config, or outside ${relative4(options.cwd, contentRoot) || "."}.`);
   }
   const outDir = mkdtempSync2(join13(tmpdir4(), "seemore-export-"));
   const ssrOutDir = mkdtempSync2(join13(tmpdir4(), "seemore-export-ssr-"));
@@ -2378,12 +2404,12 @@ ${errors.join("\n\n")}`);
     const filename = `${basename2(target).replace(/\.(?:md|mdx)$/i, "")}.html`;
     const targetPath = options.out === void 0 ? join13(dirname9(target), filename) : join13(resolve6(options.cwd, options.out), filename);
     if (existsSync4(targetPath)) {
-      console.log(pc4.yellow(`seemore  replacing existing ${relative3(options.cwd, targetPath) || targetPath}`));
+      console.log(pc4.yellow(`seemore  replacing existing ${relative4(options.cwd, targetPath) || targetPath}`));
     }
     mkdirSync4(dirname9(targetPath), { recursive: true });
     writeFileSync8(targetPath, html, "utf8");
     ctx.warnings.flush();
-    console.log(pc4.green(`seemore  wrote ${relative3(options.cwd, targetPath) || targetPath} (${formatBytes2(html.length)})`));
+    console.log(pc4.green(`seemore  wrote ${relative4(options.cwd, targetPath) || targetPath} (${formatBytes2(html.length)})`));
   } finally {
     rmSync2(outDir, { recursive: true, force: true });
     rmSync2(ssrOutDir, { recursive: true, force: true });