Merge pull request #20 from CloudCannon/hugo/solo-branch-index-collec…

…tions Prevent creating collections for hugo folders with only branch index files
CloudCannon · Sep 12, 2024 · 203218f · 203218f
2 parents eafa59c + 9be55b7
commit 203218f
Show file tree

Hide file tree

Showing 218 changed files with 63,883 additions and 39 deletions.
diff --git a/src/index.js b/src/index.js
@@ -56,6 +56,7 @@ export async function generateConfiguration(filePaths, options) {
 						source,
 						config,
 						basePath: findBasePath(collectionPaths),
+						filePaths,
 					}),
 				),
 			paths: options?.config?.paths ?? undefined,

diff --git a/src/ssgs/eleventy.js b/src/ssgs/eleventy.js
@@ -64,7 +64,7 @@ export default class Eleventy extends Ssg {
 	 *
 	 * @param key {string}
 	 * @param path {string}
-	 * @param options {{ config?: Record<string, any>; basePath?: string; }=}
+	 * @param options {import('../types').GenerateCollectionConfigOptions}
 	 * @returns {import('@cloudcannon/configuration-types').CollectionConfig}
 	 */
 	generateCollectionConfig(key, path, options) {
@@ -86,7 +86,7 @@ export default class Eleventy extends Ssg {
 	 * `collections_config` entry.
 	 *
 	 * @param collectionPaths {string[]}
-	 * @param options {{ config?: Record<string, any>; source?: string; basePath: string; }}
+	 * @param options {import('../types').GenerateCollectionsConfigOptions}
 	 * @returns {string[]}
 	 */
 	filterContentCollectionPaths(collectionPaths, options) {

diff --git a/src/ssgs/hugo.js b/src/ssgs/hugo.js
@@ -64,13 +64,17 @@ export default class Hugo extends Ssg {
 	 *
 	 * @param key {string}
 	 * @param path {string}
-	 * @param options {{ config?: Record<string, any>; basePath: string; }}
+	 * @param options {import('../types').GenerateCollectionConfigOptions}
 	 * @returns {import('@cloudcannon/configuration-types').CollectionConfig}
 	 */
 	generateCollectionConfig(key, path, options) {
 		const collectionConfig = super.generateCollectionConfig(key, path, options);
 
-		if (path !== options.basePath) {
+		const hasParentCollectionPath = options.collectionPaths.some((otherCollectionPath) => {
+			return joinPaths([options.source, path]).startsWith(`${otherCollectionPath}/`);
+		});
+
+		if (hasParentCollectionPath) {
 			collectionConfig.glob =
 				typeof collectionConfig.glob === 'string'
 					? [collectionConfig.glob]
@@ -107,7 +111,7 @@ export default class Hugo extends Ssg {
 	 * `collections_config` entry.
 	 *
 	 * @param collectionPaths {string[]}
-	 * @param options {{ config?: Record<string, any>; source?: string; basePath: string; }}
+	 * @param options {import('../types').GenerateCollectionsConfigOptions}
 	 * @returns {string[]}
 	 */
 	filterContentCollectionPaths(collectionPaths, options) {
@@ -119,10 +123,23 @@ export default class Hugo extends Ssg {
 	 * Generates collections config from a set of paths.
 	 *
 	 * @param collectionPaths {string[]}
-	 * @param options {{ config?: Record<string, any>; source?: string; basePath: string; }}
+	 * @param options {import('../types').GenerateCollectionsConfigOptions}
 	 * @returns {import('../types').CollectionsConfig}
 	 */
 	generateCollectionsConfig(collectionPaths, options) {
+		// Remove collection paths with a parent collection path and only a branch index file
+		collectionPaths = collectionPaths.filter((collectionPath) => {
+			const hasNonBranchIndexFile = options.filePaths.some(
+				(filePath) => filePath.startsWith(`${collectionPath}/`) && !filePath.endsWith('/_index.md'),
+			);
+
+			const hasParentCollectionPath = collectionPaths.some((otherCollectionPath) =>
+				collectionPath.startsWith(`${otherCollectionPath}/`),
+			);
+
+			return hasNonBranchIndexFile || !hasParentCollectionPath;
+		});
+
 		const collectionPathsOutsideExampleSite = collectionPaths.filter(
 			(path) => !path.includes('exampleSite/'),
 		);

diff --git a/src/ssgs/jekyll.js b/src/ssgs/jekyll.js
@@ -149,11 +149,11 @@ export default class Jekyll extends Ssg {
 	 *
 	 * @param key {string}
 	 * @param path {string}
-	 * @param options {{ config?: Record<string, any>; basePath?: string; collection: Record<string, any> | undefined; }}
+	 * @param options {import('../types').GenerateCollectionConfigOptionsJekyll}
 	 * @returns {import('@cloudcannon/configuration-types').CollectionConfig}
 	 */
 	generateCollectionConfig(key, path, options) {
-		const collectionConfig = super.generateCollectionConfig(key, path);
+		const collectionConfig = super.generateCollectionConfig(key, path, options);
 
 		const isKnownOutputCollection =
 			key === 'pages' ||
@@ -204,7 +204,7 @@ export default class Jekyll extends Ssg {
 	 * Generates collections config from a set of paths.
 	 *
 	 * @param collectionPaths {string[]}
-	 * @param options {{ config?: Record<string, any>; source?: string; basePath: string; }}
+	 * @param options {import('../types').GenerateCollectionsConfigOptions}
 	 * @returns {import('../types').CollectionsConfig}
 	 */
 	generateCollectionsConfig(collectionPaths, options) {
@@ -220,6 +220,8 @@ export default class Jekyll extends Ssg {
 			const collection = collections[key];
 
 			collectionsConfig[collectionKey] = this.generateCollectionConfig(collectionKey, path, {
+				...options,
+				collectionPaths,
 				collection,
 			});
 		}
@@ -255,7 +257,11 @@ export default class Jekyll extends Ssg {
 			const pathInCollectionsDir = stripTopPath(path, collectionsDir);
 			const key = this.generateCollectionsConfigKey(pathInCollectionsDir, collectionsConfig);
 			const collection = collections[stripTopPath(path, collectionsDir).replace(/^\/?_/, '')];
-			collectionsConfig[key] = this.generateCollectionConfig(key, path, { collection });
+			collectionsConfig[key] = this.generateCollectionConfig(key, path, {
+				...options,
+				collectionPaths,
+				collection,
+			});
 		}
 
 		// Add matching post/draft collections
@@ -271,15 +277,23 @@ export default class Jekyll extends Ssg {
 				collectionsConfig[postsKey] ||= this.generateCollectionConfig(
 					postsKey,
 					toPostsPath(collectionConfig.path),
-					{ collection: collections?.posts },
+					{
+						...options,
+						collectionPaths,
+						collection: collections?.posts,
+					},
 				);
 			} else if (isPostsPath(collectionConfig.path)) {
 				// Ensure there is a matching drafts collection
 				const draftsKey = toDraftsKey(key);
 				collectionsConfig[draftsKey] ||= this.generateCollectionConfig(
 					draftsKey,
 					toDraftsPath(collectionConfig.path),
-					{ collection: collections?.drafts || collections?.posts },
+					{
+						...options,
+						collectionPaths,
+						collection: collections?.drafts || collections?.posts,
+					},
 				);
 			}
 		}

diff --git a/src/ssgs/ssg.js b/src/ssgs/ssg.js
@@ -348,7 +348,7 @@ export default class Ssg {
 	 *
 	 * @param key {string}
 	 * @param path {string}
-	 * @param _options {{ config?: Record<string, any>; basePath?: string; }=}
+	 * @param _options {import('../types').GenerateCollectionConfigOptions}
 	 * @returns {import('@cloudcannon/configuration-types').CollectionConfig}
 	 */
 	generateCollectionConfig(key, path, _options) {
@@ -385,7 +385,7 @@ export default class Ssg {
 	 * `collections_config` entry.
 	 *
 	 * @param collectionPaths {string[]}
-	 * @param _options {{ config?: Record<string, any>; source?: string; basePath: string; }}
+	 * @param _options {import('../types').GenerateCollectionsConfigOptions}
 	 * @returns {string[]}
 	 */
 	filterContentCollectionPaths(collectionPaths, _options) {
@@ -396,7 +396,7 @@ export default class Ssg {
 	 * Generates collections config from a set of paths.
 	 *
 	 * @param collectionPaths {string[]}
-	 * @param options {{ config?: Record<string, any>; source?: string; basePath: string; }}
+	 * @param options {import('../types').GenerateCollectionsConfigOptions}
 	 * @returns {import('../types').CollectionsConfig}
 	 */
 	generateCollectionsConfig(collectionPaths, options) {
@@ -426,7 +426,11 @@ export default class Ssg {
 			}
 
 			const key = this.generateCollectionsConfigKey(pathInBasePath, collectionsConfig);
-			collectionsConfig[key] = this.generateCollectionConfig(key, path, { ...options, basePath });
+			collectionsConfig[key] = this.generateCollectionConfig(key, path, {
+				...options,
+				collectionPaths,
+				basePath,
+			});
 		}
 
 		return collectionsConfig;

diff --git a/src/ssgs/static.js b/src/ssgs/static.js
@@ -15,13 +15,16 @@ export default class Static extends Ssg {
 	/**
 	 * Generates collections config from a set of paths.
 	 *
-	 * @param _collectionPaths {string[]}
-	 * @param options {{ config?: Record<string, any>; source?: string; basePath: string }}
+	 * @param collectionPaths {string[]}
+	 * @param options {import('../types').GenerateCollectionsConfigOptions}
 	 * @returns {import('../types').CollectionsConfig}
 	 */
-	generateCollectionsConfig(_collectionPaths, options) {
+	generateCollectionsConfig(collectionPaths, options) {
 		return {
-			pages: this.generateCollectionConfig('pages', options?.source ?? ''),
+			pages: this.generateCollectionConfig('pages', options?.source ?? '', {
+				...options,
+				collectionPaths,
+			}),
 		};
 	}
 }
diff --git a/src/types.d.ts b/src/types.d.ts
@@ -50,3 +50,19 @@ export interface BuildCommands {
 	environment: Record<string, BuildCommandSuggestion>;
 	preserved: BuildCommandSuggestion[];
 }
+
+export interface GenerateCollectionsConfigOptions {
+	config?: Record<string, any>;
+	source?: string;
+	basePath: string;
+	filePaths: string[];
+}
+
+export interface GenerateCollectionConfigOptions extends GenerateCollectionsConfigOptions {
+	collectionPaths: string[];
+}
+
+export interface GenerateCollectionConfigOptionsJekyll extends GenerateCollectionConfigOptions {
+	/** The matching Jekyll collection from _config.yml */
+	collection: Record<string, any> | undefined;
+}
diff --git a/toolproof_tests/hugo/base.toolproof.yml b/toolproof_tests/hugo/base.toolproof.yml
@@ -32,9 +32,6 @@ steps:
       ╎        "path": "data",
       ╎        "name": "Data",
       ╎        "icon": "data_usage",
-      ╎        "glob": [
-      ╎          "!_index.md"
-      ╎        ],
       ╎        "disable_url": true,
       ╎        "disable_add": true,
       ╎        "disable_add_folder": true,

diff --git a/toolproof_tests/hugo/data-dir.toolproof.yml b/toolproof_tests/hugo/data-dir.toolproof.yml
@@ -34,9 +34,6 @@ steps:
       ╎        "path": "stats",
       ╎        "name": "Stats",
       ╎        "icon": "stars",
-      ╎        "glob": [
-      ╎          "!_index.md"
-      ╎        ],
       ╎        "disable_url": true,
       ╎        "disable_add": true,
       ╎        "disable_add_folder": true,

diff --git a/toolproof_tests/hugo/data-only.toolproof.yml b/toolproof_tests/hugo/data-only.toolproof.yml
@@ -15,9 +15,6 @@ steps:
       ╎        "path": "data",
       ╎        "name": "Data",
       ╎        "icon": "data_usage",
-      ╎        "glob": [
-      ╎          "!_index.md"
-      ╎        ],
       ╎        "disable_url": true,
       ╎        "disable_add": true,
       ╎        "disable_add_folder": true,

diff --git a/toolproof_tests/hugo/example-site-only.toolproof.yml b/toolproof_tests/hugo/example-site-only.toolproof.yml
@@ -31,9 +31,6 @@ steps:
       ╎        "path": "data",
       ╎        "name": "Data",
       ╎        "icon": "data_usage",
-      ╎        "glob": [
-      ╎          "!_index.md"
-      ╎        ],
       ╎        "disable_url": true,
       ╎        "disable_add": true,
       ╎        "disable_add_folder": true,

diff --git a/toolproof_tests/hugo/one-branch-index.toolproof.yml b/toolproof_tests/hugo/one-branch-index.toolproof.yml
@@ -0,0 +1,38 @@
+name: Hugo one branch index
+
+steps:
+  - step: I have a "src/hugo.yaml" file with the content ""
+  - step: I have a "src/content/_index.md" file with the content ""
+  - ref: ./../core/run_gadget.toolproof.yml
+  - snapshot: stdout
+    snapshot_content: |-
+      ╎{
+      ╎  "ssg": "hugo",
+      ╎  "config": {
+      ╎    "collections_config": {
+      ╎      "content": {
+      ╎        "path": "content",
+      ╎        "name": "Content",
+      ╎        "icon": "wysiwyg"
+      ╎      }
+      ╎    },
+      ╎    "timezone": "Pacific/Auckland",
+      ╎    "markdown": {
+      ╎      "engine": "commonmark",
+      ╎      "options": {
+      ╎        "gfm": true,
+      ╎        "linkify": false,
+      ╎        "table": false,
+      ╎        "strikethrough": false,
+      ╎        "subscript": false,
+      ╎        "superscript": false,
+      ╎        "heading_ids": false,
+      ╎        "breaks": false,
+      ╎        "xhtml": false,
+      ╎        "attributes": false,
+      ╎        "typographer": false,
+      ╎        "treat_indentation_as_code": true
+      ╎      }
+      ╎    }
+      ╎  }
+      ╎}
diff --git a/toolproof_tests/hugo/one-nested-branch-index.toolproof.yml b/toolproof_tests/hugo/one-nested-branch-index.toolproof.yml
@@ -0,0 +1,38 @@
+name: Hugo one nested branch index
+
+steps:
+  - step: I have a "src/hugo.yaml" file with the content ""
+  - step: I have a "src/content/blog/_index.md" file with the content ""
+  - ref: ./../core/run_gadget.toolproof.yml
+  - snapshot: stdout
+    snapshot_content: |-
+      ╎{
+      ╎  "ssg": "hugo",
+      ╎  "config": {
+      ╎    "collections_config": {
+      ╎      "content_blog": {
+      ╎        "path": "content/blog",
+      ╎        "name": "Content Blog",
+      ╎        "icon": "content_copy"
+      ╎      }
+      ╎    },
+      ╎    "timezone": "Pacific/Auckland",
+      ╎    "markdown": {
+      ╎      "engine": "commonmark",
+      ╎      "options": {
+      ╎        "gfm": true,
+      ╎        "linkify": false,
+      ╎        "table": false,
+      ╎        "strikethrough": false,
+      ╎        "subscript": false,
+      ╎        "superscript": false,
+      ╎        "heading_ids": false,
+      ╎        "breaks": false,
+      ╎        "xhtml": false,
+      ╎        "attributes": false,
+      ╎        "typographer": false,
+      ╎        "treat_indentation_as_code": true
+      ╎      }
+      ╎    }
+      ╎  }
+      ╎}
diff --git a/toolproof_tests/hugo/one-nested-page.toolproof.yml b/toolproof_tests/hugo/one-nested-page.toolproof.yml
@@ -14,10 +14,7 @@ steps:
       ╎      "content_blog": {
       ╎        "path": "content/blog",
       ╎        "name": "Content Blog",
-      ╎        "icon": "content_copy",
-      ╎        "glob": [
-      ╎          "!_index.md"
-      ╎        ]
+      ╎        "icon": "content_copy"
       ╎      }
       ╎    },
       ╎    "timezone": "Pacific/Auckland",

diff --git a/toolproof_tests/hugo/subfolder-source.toolproof.yml b/toolproof_tests/hugo/subfolder-source.toolproof.yml
@@ -34,9 +34,6 @@ steps:
       ╎        "path": "data",
       ╎        "name": "Data",
       ╎        "icon": "data_usage",
-      ╎        "glob": [
-      ╎          "!_index.md"
-      ╎        ],
       ╎        "disable_url": true,
       ╎        "disable_add": true,
       ╎        "disable_add_folder": true,