feat(config): set unwrapSingleRootDir to true

Author: fbosch

README.md

@@ -102,7 +102,7 @@ These fields can be set in `defaults` and are inherited by every source unless o
 | `ignoreHidden`        | Skip hidden files and directories (dotfiles). Default: `false`.                                                                 |
 | `allowHosts`          | Allowed Git hosts. Default: `["github.com", "gitlab.com", "visualstudio.com"]`.                                                    |
 | `toc`                 | Generate per-source `TOC.md`. Default: `true`. Supports `true`, `false`, or a format: `"tree"` (human readable), `"compressed"` |
-| `unwrapSingleRootDir` | If the materialized output is nested under a single directory, unwrap it (recursively). Default: `false`.                       |
+| `unwrapSingleRootDir` | If the materialized output is nested under a single directory, unwrap it (recursively). Default: `true`.                        |
 
 ### Source options
 

src/cache/materialize.ts

@@ -175,7 +175,7 @@ const resolveMaterializeParams = (
 	...params,
 	exclude: params.exclude ?? [],
 	ignoreHidden: params.ignoreHidden ?? false,
-	unwrapSingleRootDir: params.unwrapSingleRootDir ?? false,
+	unwrapSingleRootDir: params.unwrapSingleRootDir ?? true,
 	json: params.json ?? false,
 	progressThrottleMs: params.progressThrottleMs ?? 120,
 });

src/config/index.ts

@@ -39,7 +39,7 @@ export const DEFAULT_CONFIG: DocsCacheConfig = {
 		ignoreHidden: false,
 		allowHosts: ["github.com", "gitlab.com", "visualstudio.com"],
 		toc: true,
-		unwrapSingleRootDir: false,
+		unwrapSingleRootDir: true,
 	},
 	sources: [],
 } as const;

tests/edge-cases-security.test.js

@@ -161,9 +161,7 @@ test("materialize handles deeply nested directories", async () => {
 
 	// Verify deeply nested file was materialized
 	const { access } = await import("node:fs/promises");
-	await access(
-		path.join(cacheDir, "test", "a", "b", "c", "d", "e", "f", "g", "deep.md"),
-	);
+	await access(path.join(cacheDir, "test", "deep.md"));
 });
 
 test("materialize handles files with special characters in names", async () => {

tests/sync-include-exclude.test.js

@@ -247,11 +247,8 @@ test("ignoreHidden excludes nested hidden directories", async () => {
 	);
 
 	const docsRoot = path.join(cacheDir, "local");
-	assert.equal(await exists(path.join(docsRoot, "docs", "guide.md")), true);
-	assert.equal(
-		await exists(path.join(docsRoot, "docs", ".git", "config")),
-		false,
-	);
+	assert.equal(await exists(path.join(docsRoot, "guide.md")), true);
+	assert.equal(await exists(path.join(docsRoot, ".git", "config")), false);
 	assert.equal(
 		await exists(path.join(docsRoot, "src", ".vscode", "settings.json")),
 		false,
@@ -429,7 +426,7 @@ test("sync re-materializes when include rules change", async () => {
 
 	const docsRoot = path.join(cacheDir, "local");
 	assert.equal(await exists(path.join(docsRoot, "README.md")), false);
-	assert.equal(await exists(path.join(docsRoot, "docs", "guide.md")), true);
+	assert.equal(await exists(path.join(docsRoot, "guide.md")), true);
 
 	const updatedConfig = {
 		...baseConfig,
@@ -450,5 +447,5 @@ test("sync re-materializes when include rules change", async () => {
 	await runSync(syncOptions, deps);
 
 	assert.equal(await exists(path.join(docsRoot, "README.md")), true);
-	assert.equal(await exists(path.join(docsRoot, "docs", "guide.md")), false);
+	assert.equal(await exists(path.join(docsRoot, "guide.md")), false);
 });

tests/sync-materialize.test.js

@@ -197,12 +197,7 @@ test("sync decodes percent-encoded include patterns", async () => {
 		},
 	);
 
-	const materializedPath = path.join(
-		cacheDir,
-		"local",
-		decodedDir,
-		"README.md",
-	);
+	const materializedPath = path.join(cacheDir, "local", "README.md");
 	assert.equal(await readFile(materializedPath, "utf8"), "hello");
 });
 
@@ -434,7 +429,6 @@ test("sync target can unwrap single root directory", async () => {
 				id: "local",
 				repo: "https://example.com/repo.git",
 				include: ["17/umbraco-forms/**"],
-				unwrapSingleRootDir: true,
 			},
 		],
 	};
@@ -529,6 +523,7 @@ test("sync re-materializes when unwrapSingleRootDir changes", async () => {
 
 	await writeConfigWithUnwrap(false);
 	await run();
+	assert.equal(await exists(path.join(cacheDir, "local", "README.md")), false);
 	assert.equal(
 		await exists(
 			path.join(cacheDir, "local", "17", "umbraco-forms", "README.md"),