@stacksjs/stx 0.2.99 → 0.2.100

package/dist/state-dir.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Records the `stateDir` coming from `stx.config.ts`.
+ *
+ * Called by the config loader. A nullish or blank value clears it, so a config
+ * without `stateDir` cannot inherit a stale value from a previously loaded one
+ * (the dev server loads a config per app directory).
+ */
+export declare function setStateDir(dir?: string | null): void;
+/**
+ * The configured state directory, as written — relative or absolute.
+ */
+export declare function stateDirName(): string;
+/**
+ * Absolute path to a file or directory inside the state directory.
+ *
+ * An absolute state directory wins over `root`, so a framework can pin every
+ * cache to one place no matter which directory a given code path happens to
+ * resolve against.
+ */
+export declare function stateDir(root?: string, ...segments: string[]): string;
+/**
+ * Rewrites a config path that still carries the default `.stx/` prefix onto the
+ * configured state directory.
+ *
+ * The path-shaped config options (`cachePath`, `build.cacheDir`,
+ * `media.cache.directory`, `story.outDir`) default to somewhere under `.stx/`.
+ * Rather than make each one separately configurable, `stateDir` moves the whole
+ * family: anything under the default prefix follows it, and a path the user
+ * pointed somewhere else entirely is left alone.
+ */
+export declare function rebaseOntoStateDir(value: string): string;
+export declare function rebaseOntoStateDir(value: string | undefined): string | undefined;
+/** The directory used when nothing configures one. */
+export declare const DEFAULT_STATE_DIR: '.stx';
+/** Environment variable that overrides both the config and the default. */
+export declare const STATE_DIR_ENV_VAR: 'STX_DIR';

package/dist/state-dir.js

@@ -0,0 +1,22 @@
+import path from "node:path";
+export const DEFAULT_STATE_DIR = ".stx", STATE_DIR_ENV_VAR = "STX_DIR";
+let configuredStateDir = null;
+export function setStateDir(dir) {
+  configuredStateDir = dir?.trim() || null;
+}
+export function stateDirName() {
+  return process.env[STATE_DIR_ENV_VAR]?.trim() || configuredStateDir || DEFAULT_STATE_DIR;
+}
+export function stateDir(root = process.cwd(), ...segments) {
+  const dir = stateDirName();
+  return path.isAbsolute(dir) ? path.join(dir, ...segments) : path.join(root, dir, ...segments);
+}
+export function rebaseOntoStateDir(value) {
+  if (!value || path.isAbsolute(value))
+    return value;
+  const normalized = value.replace(/\\/g, "/");
+  if (normalized !== DEFAULT_STATE_DIR && !normalized.startsWith(`${DEFAULT_STATE_DIR}/`))
+    return value;
+  const suffix = normalized.slice(DEFAULT_STATE_DIR.length + 1);
+  return suffix ? path.join(stateDirName(), suffix) : stateDirName();
+}

package/dist/story/docs-generator.js

@@ -1,7 +1,8 @@
 import fs from "node:fs";
 import path from "node:path";
+import { stateDir } from "../state-dir.js";
 export async function generateStoryDocs(ctx, components, options = {}) {
-  const outDir = options.outDir || path.join(ctx.root, ".stx", "docs");
+  const outDir = options.outDir || stateDir(ctx.root, "docs");
   await fs.promises.mkdir(outDir, { recursive: !0 });
   const indexContent = generateDocsIndex(components);
   await fs.promises.writeFile(path.join(outDir, "README.md"), indexContent);

package/dist/story/snapshots.js

@@ -1,7 +1,8 @@
 import fs from "node:fs";
 import path from "node:path";
+import { stateDir } from "../state-dir.js";
 export function getSnapshotDir(ctx) {
-  return path.join(ctx.root, ".stx", "story", "snapshots");
+  return stateDir(ctx.root, "story", "snapshots");
 }
 function getVersionFilePath(snapshotDir, storyId) {
   return path.join(snapshotDir, `${storyId}.versions.json`);

package/dist/story/testing.js

@@ -1,6 +1,7 @@
 import fs from "node:fs";
 import path from "node:path";
 import { checkA11y } from "../a11y.js";
+import { stateDir } from "../state-dir.js";
 export async function runVisualTests(ctx, options = {}) {
   const startTime = Date.now(), result = {
     total: 0,
@@ -9,7 +10,7 @@ export async function runVisualTests(ctx, options = {}) {
     new: 0,
     failures: [],
     duration: 0
-  }, snapshotDir = options.snapshotDir || path.join(ctx.root, ".stx", "story", "snapshots");
+  }, snapshotDir = options.snapshotDir || stateDir(ctx.root, "story", "snapshots");
   await fs.promises.mkdir(snapshotDir, { recursive: !0 });
   let storyFiles = ctx.storyFiles;
   if (options.filter && options.filter.length > 0)

package/dist/story/visual-testing.js

@@ -1,10 +1,11 @@
 import fs from "node:fs";
 import path from "node:path";
+import { stateDir } from "../state-dir.js";
 export async function runScreenshotTests(ctx, options = {}) {
   const startTime = performance.now(), {
     update = !1,
     threshold = 0.1,
-    snapshotDir = path.join(ctx.root, ".stx", "story", "snapshots"),
+    snapshotDir = stateDir(ctx.root, "story", "snapshots"),
     width = 800,
     height = 600,
     deviceScaleFactor = 1,
@@ -85,7 +86,7 @@ export async function runScreenshotTests(ctx, options = {}) {
 async function runHtmlComparisonTests(ctx, options) {
   const startTime = performance.now(), {
     update = !1,
-    snapshotDir = path.join(ctx.root, ".stx", "story", "snapshots"),
+    snapshotDir = stateDir(ctx.root, "story", "snapshots"),
     filter
   } = options, result = {
     total: 0,

package/dist/types/config-types.d.ts

@@ -258,6 +258,7 @@ export declare interface StxConfig {
     }
   }
   root?: string
+  stateDir?: string
   pagesDir?: string
   templatesDir?: string
   defaultTitle?: string

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/stx",
   "type": "module",
-  "version": "0.2.99",
+  "version": "0.2.100",
   "description": "A performant UI Framework. Powered by Bun.",
   "author": "Chris Breuer <chris@stacksjs.org>",
   "license": "MIT",
@@ -117,16 +117,16 @@
   "dependencies": {
     "@cwcss/crosswind": "^0.2.6",
     "@stacksjs/clapp": "^0.2.0",
-    "@stacksjs/sanitizer": "0.2.99",
+    "@stacksjs/sanitizer": "0.2.100",
     "@stacksjs/ts-i18n": "^0.1.11",
-    "bun-plugin-stx": "0.2.99",
+    "bun-plugin-stx": "0.2.100",
     "bunfig": "^0.15.15",
-    "stx-router": "0.2.99",
+    "stx-router": "0.2.100",
     "ts-broadcasting": "^0.0.8",
     "ts-images": "^0.1.9",
     "ts-syntax-highlighter": "^0.2.1"
   },
   "optionalDependencies": {
-    "@stacksjs/desktop": "0.2.99"
+    "@stacksjs/desktop": "0.2.100"
   }
 }