@rohal12/twee-ts 1.15.4 → 1.16.0

package/dist/index.d.cts

@@ -12,6 +12,11 @@ type SourceInput = string | InlineSource;
 interface CompileOptions {
   /** Files, directories, or inline sources to compile. */
   sources: SourceInput[];
+  /**
+   * Glob patterns for files to leave out of `sources`, matched against each file's
+   * path relative to the working directory (as `stats.files` lists it). Modules are not affected.
+   */
+  exclude?: string[];
   /** Output mode. Default: 'html'. */
   outputMode?: OutputMode;
   /** Story format directory ID (e.g. 'sugarcube-2'). */
@@ -195,6 +200,7 @@ interface FileCacheEntry {
 }
 interface TweeTsConfig {
   sources?: string[];
+  exclude?: string[];
   output?: string;
   outputMode?: OutputMode;
   formatId?: string;

package/dist/index.d.ts

@@ -12,6 +12,11 @@ type SourceInput = string | InlineSource;
 interface CompileOptions {
   /** Files, directories, or inline sources to compile. */
   sources: SourceInput[];
+  /**
+   * Glob patterns for files to leave out of `sources`, matched against each file's
+   * path relative to the working directory (as `stats.files` lists it). Modules are not affected.
+   */
+  exclude?: string[];
   /** Output mode. Default: 'html'. */
   outputMode?: OutputMode;
   /** Story format directory ID (e.g. 'sugarcube-2'). */
@@ -195,6 +200,7 @@ interface FileCacheEntry {
 }
 interface TweeTsConfig {
   sources?: string[];
+  exclude?: string[];
   output?: string;
   outputMode?: OutputMode;
   formatId?: string;

package/dist/index.js

@@ -1,6 +1,7 @@
 import { existsSync, mkdirSync, readFileSync, readdirSync, rmSync, statSync, watch as watch$1, writeFileSync } from "node:fs";
+import * as nodePath from "node:path";
+import { basename, dirname, extname, join, parse, relative, resolve, sep } from "node:path";
 import { randomUUID } from "node:crypto";
-import { basename, dirname, extname, join, parse, relative, resolve } from "node:path";
 import { homedir } from "node:os";
 import { fileURLToPath } from "node:url";
 //#region src/ifid.ts
@@ -631,11 +632,25 @@ function fontFormatHint(ext) {
 * Ported from filesystem.go.
 */
 /**
+* Whether `filename` matches one of the `exclude` globs. The globs are matched
+* against the file's path relative to the working directory, the path
+* getFilenames reports; an absolute `filename` is made relative first. A leading
+* `./` in a glob is dropped. Matching is Node's `path.matchesGlob`.
+*/
+function isExcluded(filename, exclude) {
+	if (exclude.length === 0) return false;
+	const { matchesGlob } = nodePath;
+	if (typeof matchesGlob !== "function") throw new Error(`The exclude option needs Node.js 22.5 or newer (found ${process.version}).`);
+	const rel = relative(process.cwd(), resolve(filename)) || filename;
+	return exclude.some((pattern) => matchesGlob(rel, pattern.replace(/^\.\//, "")));
+}
+/**
 * Recursively walk directories, collecting regular file paths.
-* Filters out the output file to prevent circular compilation.
+* Filters out the output file to prevent circular compilation, and the files
+* that match an `exclude` glob (see isExcluded).
 * Like Tweego, a path that cannot be read is reported as a warning and skipped.
 */
-function getFilenames(pathnames, outFilename) {
+function getFilenames(pathnames, outFilename, exclude = []) {
 	const filenames = [];
 	const diagnostics = [];
 	const absOutFile = outFilename ? resolve(outFilename) : "";
@@ -657,6 +672,7 @@ function getFilenames(pathnames, outFilename) {
 			const abs = resolve(pathname);
 			if (abs === absOutFile) return;
 			const rel = relative(process.cwd(), abs);
+			if (isExcluded(rel || abs, exclude)) return;
 			filenames.push(rel || abs);
 		} else if (stat.isDirectory()) {
 			let entries;
@@ -677,9 +693,11 @@ function getFilenames(pathnames, outFilename) {
 }
 /**
 * Watch paths for changes, calling the build callback on known file type changes.
+* A change to a file `ignore` returns true for (given the path relative to the
+* working directory) schedules no build.
 * Uses debouncing to avoid rapid rebuilds.
 */
-function watchFilesystem(pathnames, outFilename, callback) {
+function watchFilesystem(pathnames, outFilename, callback, ignore = () => false) {
 	const absOutFile = resolve(outFilename);
 	const watchers = [];
 	let buildTimer = null;
@@ -700,7 +718,10 @@ function watchFilesystem(pathnames, outFilename, callback) {
 			if (!filename) return;
 			const abs = resolve(pathname, filename);
 			if (abs === absOutFile) return;
-			if (isKnownFileType(filename)) scheduleBuild(relative(process.cwd(), abs) || abs);
+			if (isKnownFileType(filename)) {
+				const rel = relative(process.cwd(), abs);
+				if (!ignore(rel || abs)) scheduleBuild(rel || abs);
+			}
 		});
 		watchers.push(watcher);
 	} catch {}
@@ -5171,14 +5192,22 @@ async function watch(options) {
 	const cache = /* @__PURE__ */ new Map();
 	const filePaths = options.sources.filter((s) => typeof s === "string");
 	const modulePaths = options.modules ?? [];
-	const handle = watchFilesystem([...filePaths, ...modulePaths], options.outFile, (changedFiles) => {
+	const allPaths = [...filePaths, ...modulePaths];
+	const exclude = options.exclude ?? [];
+	const moduleRoots = modulePaths.map((p) => resolve(p));
+	const ignore = (filename) => {
+		if (!isExcluded(filename, exclude)) return false;
+		const abs = resolve(filename);
+		return !moduleRoots.some((root) => abs === root || abs.startsWith(root + sep));
+	};
+	const handle = watchFilesystem(allPaths, options.outFile, (changedFiles) => {
 		buildOutput(options, cache, changedFiles).then((result) => {
 			writeFileSync(options.outFile, result.output, "utf-8");
 			options.onBuild?.(result);
 		}).catch((e) => {
 			options.onError?.(e instanceof Error ? e : new Error(String(e)));
 		});
-	});
+	}, ignore);
 	controller.signal.addEventListener("abort", () => handle.close());
 	return controller;
 }
@@ -5195,7 +5224,7 @@ async function buildOutput(options, cache, changedFiles) {
 	const inlineSources = [];
 	for (const source of options.sources) if (typeof source === "string") filePaths.push(source);
 	else inlineSources.push(source);
-	const { filenames: sourceFilenames, diagnostics: sourcePathDiagnostics } = getFilenames(filePaths);
+	const { filenames: sourceFilenames, diagnostics: sourcePathDiagnostics } = getFilenames(filePaths, void 0, options.exclude);
 	diagnostics.push(...sourcePathDiagnostics);
 	const story = createStory();
 	const processedFiles = /* @__PURE__ */ new Set();
@@ -6720,6 +6749,7 @@ function validateConfig(data) {
 	]) if (key in obj && typeof obj[key] !== "boolean") errors.push(`"${key}" must be a boolean.`);
 	for (const key of [
 		"sources",
+		"exclude",
 		"formatPaths",
 		"formatIndices",
 		"formatUrls",