feat(config): add unwrapSingleRootDir option

Author: fbosch

src/config-schema.ts

@@ -21,6 +21,7 @@ export const DefaultsSchema = z
 		maxFiles: z.number().min(1).optional(),
 		allowHosts: z.array(z.string().min(1)).min(1),
 		toc: z.union([z.boolean(), TocFormatSchema]).optional(),
+		unwrapSingleRootDir: z.boolean().optional(),
 	})
 	.strict();
 

src/config.ts

@@ -25,6 +25,7 @@ export interface DocsCacheDefaults {
 	maxFiles?: number;
 	allowHosts: string[];
 	toc?: boolean | TocFormat;
+	unwrapSingleRootDir?: boolean;
 }
 
 export interface DocsCacheSource {
@@ -84,6 +85,7 @@ export const DEFAULT_CONFIG: DocsCacheConfig = {
 		maxBytes: 200000000,
 		allowHosts: ["github.com", "gitlab.com"],
 		toc: true,
+		unwrapSingleRootDir: false,
 	},
 	sources: [],
 };
@@ -299,6 +301,13 @@ export const validateConfig = (input: unknown): DocsCacheConfig => {
 				defaultsInput.toc !== undefined
 					? (defaultsInput.toc as boolean | TocFormat)
 					: defaultValues.toc,
+			unwrapSingleRootDir:
+				defaultsInput.unwrapSingleRootDir !== undefined
+					? assertBoolean(
+							defaultsInput.unwrapSingleRootDir,
+							"defaults.unwrapSingleRootDir",
+						)
+					: defaultValues.unwrapSingleRootDir,
 		};
 	} else if (targetModeOverride !== undefined) {
 		defaults = {
@@ -431,7 +440,8 @@ export const resolveSources = (
 		maxFiles: source.maxFiles ?? defaults.maxFiles,
 		integrity: source.integrity,
 		toc: source.toc ?? defaults.toc,
-		unwrapSingleRootDir: source.unwrapSingleRootDir,
+		unwrapSingleRootDir:
+			source.unwrapSingleRootDir ?? defaults.unwrapSingleRootDir,
 	}));
 };
 

src/materialize.ts

@@ -204,11 +204,11 @@ export const materializeSource = async (params: MaterializeParams) => {
 			resolved.unwrapSingleRootDir,
 		);
 		const targetDirs = new Set<string>();
-		for (const { relativePath, normalized } of entries) {
+		for (const { normalized } of entries) {
 			const rootPath = unwrapPrefix
 				? normalized.replace(unwrapPrefix, "")
-				: relativePath;
-			targetDirs.add(path.dirname(rootPath));
+				: normalized;
+			targetDirs.add(path.posix.dirname(rootPath));
 		}
 		await Promise.all(
 			Array.from(targetDirs, (dir) =>

src/sync.ts

@@ -133,9 +133,14 @@ const normalizeRulesValue = (
 };
 
 const computeRulesHash = (source: DocsCacheResolvedSource) => {
-	const payload = Object.fromEntries(
-		RULES_HASH_KEYS.map((key) => [key, normalizeRulesValue(key, source[key])]),
+	const entries = RULES_HASH_KEYS.map((key) => [
+		key,
+		normalizeRulesValue(key, source[key]),
+	]) as Array<[string, unknown]>;
+	entries.sort(([left]: [string, unknown], [right]: [string, unknown]) =>
+		left.localeCompare(right),
 	);
+	const payload = Object.fromEntries(entries);
 	const hash = createHash("sha256");
 	hash.update(JSON.stringify(payload));
 	return hash.digest("hex");