@dominikcz/greg 0.9.34 → 0.9.35

package/README.md

@@ -299,6 +299,33 @@ export default {
 
 To override those labels per locale, use `versioning.locales`:
 
+### Cache SHA length (branch mode)
+
+In `branches` strategy, Greg stores build cache under `.greg/version-cache/builds/...` using a short commit SHA prefix.
+
+- default prefix length: `7`
+- configurable in `greg.config.* > versioning.cacheShaLength`
+- can be overridden per run via env `GREG_CACHE_SHA_LENGTH`
+- allowed range: `7..40`
+- cache folder key format: `<shortSha>-<workspaceBuildFingerprint>`
+- the suffix avoids stale cache reuse when local build inputs/config changed but branch commit SHA stayed the same
+
+Example: if `main` still points to the same commit, but you changed `vite.config.js` or Markdown build plugins locally, Greg uses a different cache folder because the workspace fingerprint changes.
+
+Example:
+
+```js [greg.config.js]
+export default {
+    versioning: {
+        cacheShaLength: 12,
+    },
+}
+```
+
+```sh
+GREG_CACHE_SHA_LENGTH=16 greg build
+```
+
 ```js [greg.config.js]
 export default {
     versioning: {

package/docs/guide/versioning.md

@@ -190,6 +190,17 @@ Optional maintenance flags:
 - `--clean-versions`: removes the versioned output directory before building
 - `--rebuild-all`: rebuilds every configured version and skips branch build cache reuse for this run
 
+Cache SHA prefix length in branch build cache:
+
+- default: `7`
+- config: `versioning.cacheShaLength`
+- env override: `GREG_CACHE_SHA_LENGTH`
+- valid range: `7..40`
+- cache key format: `<shortSha>-<workspaceBuildFingerprint>`
+- the suffix prevents stale cache hits when build inputs/config changed but commit SHA did not
+
+Example: if branch `main` still resolves to the same commit, but you changed local build inputs (for example `vite.config.js` or Markdown build plugins), Greg writes to a different cache folder because the workspace fingerprint changes.
+
 ## UI Components
 
 Greg renders two visual versioning components automatically when a valid manifest is available:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dominikcz/greg",
-  "version": "0.9.34",
+  "version": "0.9.35",
   "type": "module",
   "types": "./types/index.d.ts",
   "bin": {

package/scripts/build-versions.js

@@ -166,7 +166,6 @@ function computeWorkspaceBuildFingerprint() {
         'vite.config.ts',
         'greg.config.js',
         'greg.config.ts',
-        'prv/greg.config.js',
         'package.json',
         'src/main.js',
         'src/App.svelte',
@@ -201,6 +200,28 @@ function getBranchSha(refName) {
     return String(out.stdout || '').trim();
 }
 
+function toShortSha(sha, length = 7) {
+    return String(sha || '').slice(0, length);
+}
+
+function resolveCacheShaLength(versioning) {
+    const DEFAULT_LENGTH = 7;
+    const MIN_LENGTH = 7;
+    const MAX_LENGTH = 40;
+    const raw = process.env.GREG_CACHE_SHA_LENGTH ?? versioning.cacheShaLength;
+
+    if (raw == null || String(raw).trim() === '') {
+        return DEFAULT_LENGTH;
+    }
+
+    const parsed = Number.parseInt(String(raw), 10);
+    if (!Number.isInteger(parsed) || parsed < MIN_LENGTH || parsed > MAX_LENGTH) {
+        throw new Error(`Invalid cache SHA length '${raw}'. Use an integer between ${MIN_LENGTH} and ${MAX_LENGTH}.`);
+    }
+
+    return parsed;
+}
+
 function ensureBranchDocsSnapshot(args) {
     const { branch, sha, docsDir, branchCacheDir } = args;
     const docsRel = String(docsDir || 'docs').replace(/^\/+|\/+$/g, '') || 'docs';
@@ -252,6 +273,7 @@ function runViteBuild(args) {
         GREG_DOCS_DIR: docsDir,
         GREG_DOCS_BASE: srcDir,
         GREG_ROOT_PATH: srcDir,
+        GREG_OUT_DIR: outDir,
         PATH:
             path.resolve(PROJECT_ROOT, 'node_modules/.bin') +
             (process.platform === 'win32' ? ';' : ':') +
@@ -259,7 +281,7 @@ function runViteBuild(args) {
     };
 
     console.log(`[greg] versions: vite build -> ${path.relative(PROJECT_ROOT, outDir)}`);
-    runCommand('vite', ['build', '--outDir', outDir, ...passthrough], {
+    runCommand('vite', ['build', ...passthrough], {
         stdio: 'inherit',
         shell: true,
         env,
@@ -443,6 +465,7 @@ async function main() {
     const args = parseArgs(process.argv.slice(2));
     const config = await loadGregConfig();
     const versioning = config.versioning ?? {};
+    const cacheShaLength = resolveCacheShaLength(versioning);
 
     const strategy = args.strategy || versioning.strategy || 'branches';
     validateVersioningConfig(versioning, strategy);
@@ -527,6 +550,7 @@ async function main() {
 
         for (const entry of entries) {
             const sha = getBranchSha(entry.branch);
+            const shortSha = toShortSha(sha, cacheShaLength);
             const snapshot = ensureBranchDocsSnapshot({
                 branch: entry.branch,
                 sha,
@@ -538,7 +562,7 @@ async function main() {
                 branchCacheDir,
                 'builds',
                 sanitizeSegment(entry.version),
-                `${sha}-${workspaceBuildFingerprint}`,
+                `${shortSha}-${workspaceBuildFingerprint}`,
             );
             const hasBuildCache = !args.rebuildAll && fs.existsSync(path.join(buildCache, 'index.html'));
 

package/scripts/generate-static.js

@@ -27,6 +27,12 @@ const DIST = path.resolve(distDir);
 const DOCS = path.resolve(docsDir);
 const ROOT_PATH = srcDir;
 
+function normalizeRouteForLog(route) {
+    const cleaned = String(route || '').trim().replace(/\\/g, '/').replace(/\/+/g, '/');
+    if (!cleaned || cleaned === '/') return '/';
+    return '/' + cleaned.replace(/^\/+|\/+$/g, '');
+}
+
 // ── Collect routes from the docs/ folder ────────────────────────────────────
 
 function collectRoutes(dir, base) {
@@ -58,7 +64,7 @@ const routes = [...new Set([
 
 const src = path.join(DIST, 'index.html');
 if (!fs.existsSync(src)) {
-    console.error('dist/index.html not found – run npm run build first.');
+    console.error(`${src} not found - run npm run build first.`);
     process.exit(1);
 }
 
@@ -73,7 +79,8 @@ for (const route of routes) {
     fs.mkdirSync(outDir, { recursive: true });
     fs.copyFileSync(src, outFile);
     count++;
-    console.log(`  ✓  ${route}/index.html`);
+    const routeLog = normalizeRouteForLog(route);
+    console.log(`  ✓  ${routeLog === '/' ? '/index.html' : `${routeLog}/index.html`}`);
 }
 
 console.log(`\nStatic export: ${count} routes written to dist/`);

package/src/lib/MarkdownDocs/loadGregConfig.js

@@ -6,24 +6,6 @@ function isPlainObject(value) {
     return value !== null && typeof value === 'object' && !Array.isArray(value);
 }
 
-function deepMerge(baseValue, overrideValue) {
-    if (!isPlainObject(baseValue) || !isPlainObject(overrideValue)) {
-        return overrideValue;
-    }
-
-    const result = { ...baseValue };
-    for (const [key, overrideEntry] of Object.entries(overrideValue)) {
-        const baseEntry = result[key];
-        if (isPlainObject(baseEntry) && isPlainObject(overrideEntry)) {
-            result[key] = deepMerge(baseEntry, overrideEntry);
-            continue;
-        }
-        result[key] = overrideEntry;
-    }
-
-    return result;
-}
-
 function normalizeConfig(value) {
     return isPlainObject(value) ? value : {};
 }
@@ -37,17 +19,6 @@ export function resolveMainGregConfigPath(rootDir = process.cwd()) {
     return null;
 }
 
-export function resolvePrvGregConfigPath(rootDir = process.cwd()) {
-    const prvPath = path.join(rootDir, 'prv', 'greg.config.js');
-    return fs.existsSync(prvPath) ? prvPath : null;
-}
-
-export function resolveGregConfigPaths(rootDir = process.cwd()) {
-    const mainConfigPath = resolveMainGregConfigPath(rootDir);
-    const prvConfigPath = resolvePrvGregConfigPath(rootDir);
-    return { mainConfigPath, prvConfigPath };
-}
-
 export async function loadGregConfigFile(configPath) {
     if (!configPath || !fs.existsSync(configPath)) return {};
 
@@ -70,13 +41,5 @@ export async function loadGregConfigFile(configPath) {
 }
 
 export async function loadGregConfig(rootDir = process.cwd()) {
-    const { mainConfigPath, prvConfigPath } = resolveGregConfigPaths(rootDir);
-    const mainConfig = await loadGregConfigFile(mainConfigPath);
-
-    if (!prvConfigPath) {
-        return mainConfig;
-    }
-
-    const prvConfig = await loadGregConfigFile(prvConfigPath);
-    return deepMerge(mainConfig, prvConfig);
+    return loadGregConfigFile(resolveMainGregConfigPath(rootDir));
 }

package/src/lib/MarkdownDocs/vitePluginGregConfig.js

@@ -10,7 +10,6 @@
  *   srcDir       string           – physical docs source directory, relative to project root (default: 'docs')
  *   srcExclude   string[]         – glob patterns to exclude from docs source (VitePress-compatible, default: [])
  *   docsBase     string           – URL prefix for the docs section, e.g. 'docs' → URLs like /docs/guide (default: 'docs')
- *   srcDir     string           – @deprecated, use docsBase instead
  *   version      string           – version badge text
  *   mainTitle    string           – site title shown in the header
  *   outline      OutlineOption    – global outline setting (VitePress-compatible)
@@ -22,12 +21,12 @@
  *   locales      Record<string, LocaleConfig> – VitePress-style locale map
  *   sidebar      'auto' | SidebarItem[]
  *
- * HMR: changing greg.config.* or prv/greg.config.js triggers a full page reload.
+ * HMR: changing greg.config.* triggers a full page reload.
  */
 
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { loadGregConfig, resolveGregConfigPaths } from './loadGregConfig.js';
+import { loadGregConfig, resolveMainGregConfigPath } from './loadGregConfig.js';
 import {
     DEFAULT_OUTPUT_BASE_DIR,
     DEFAULT_SITE_BASE,
@@ -43,10 +42,10 @@ const RESOLVED_ID = '\0' + VIRTUAL_ID;
 
 export function vitePluginGregConfig() {
     let root = process.cwd();
-    let { mainConfigPath, prvConfigPath } = resolveGregConfigPaths(root);
+    let mainConfigPath = resolveMainGregConfigPath(root);
 
     function isWatchedConfig(file) {
-        return file === mainConfigPath || file === prvConfigPath;
+        return file === mainConfigPath;
     }
 
     return {
@@ -84,7 +83,10 @@ export function vitePluginGregConfig() {
                 if (hasBase) {
                     viteConfig.base = normalizeBasePath(resolved.base, DEFAULT_SITE_BASE);
                 }
-                if (hasOutDir) {
+                const outDirOverride = process.env.GREG_OUT_DIR;
+                if (outDirOverride) {
+                    viteConfig.build = { outDir: outDirOverride };
+                } else if (hasOutDir) {
                     const outDir = String(resolved.outDir || DEFAULT_OUTPUT_BASE_DIR).trim() || DEFAULT_OUTPUT_BASE_DIR;
                     viteConfig.build = { outDir };
                 }
@@ -97,7 +99,7 @@ export function vitePluginGregConfig() {
 
         configResolved(config) {
             root = config.root;
-            ({ mainConfigPath, prvConfigPath } = resolveGregConfigPaths(root));
+            mainConfigPath = resolveMainGregConfigPath(root);
         },
 
         resolveId(id) {
@@ -106,7 +108,7 @@ export function vitePluginGregConfig() {
 
         async load(id) {
             if (id !== RESOLVED_ID) return;
-            if (!mainConfigPath && !prvConfigPath) return `export default {};`;
+            if (!mainConfigPath) return `export default {};`;
             try {
                 const config = await loadGregConfig(root);
                 return `export default ${JSON.stringify(config)};`;
@@ -117,7 +119,7 @@ export function vitePluginGregConfig() {
         },
 
         handleHotUpdate({ file, server }) {
-            ({ mainConfigPath, prvConfigPath } = resolveGregConfigPaths(root));
+            mainConfigPath = resolveMainGregConfigPath(root);
             if (isWatchedConfig(file)) {
                 const mod = server.moduleGraph.getModuleById(RESOLVED_ID);
                 if (mod) {