More build suggestions

src/defaults.js

@@ -1,20 +1,20 @@
 /** @type {import('@cloudcannon/configuration-types').MarkdownAttributeElementOptions} */
 export const commonmarkAttributeElementOptions = {
-    inline: 'none',
-    block: 'space right',
-    img: 'right',
-    ul: 'below',
-    ol: 'below',
-    li: 'space right',
-    table: 'newline below',
-    blockquote: 'below',
-}
+	inline: 'none',
+	block: 'space right',
+	img: 'right',
+	ul: 'below',
+	ol: 'below',
+	li: 'space right',
+	table: 'newline below',
+	blockquote: 'below',
+};
 
 /** @type {import('@cloudcannon/configuration-types').MarkdownAttributeElementOptions} */
 export const kramdownAttributeElementOptions = {
-    inline: 'right',
-    block: 'below',
-    tr: 'none',
-    td: 'none',
-    li: 'right-of-prefix',
-}
+	inline: 'right',
+	block: 'below',
+	tr: 'none',
+	td: 'none',
+	li: 'right-of-prefix',
+};

src/ssgs/astro.js

@@ -0,0 +1,29 @@
+import Ssg from './ssg.js';
+
+export default class Astro extends Ssg {
+	constructor() {
+		super('astro');
+	}
+
+	/**
+	 * Generates a list of build suggestions.
+	 *
+	 * @param filePaths {string[]} List of input file paths.
+	 * @param options {{ config?: Record<string, any>; source?: string; readFile?: (path: string) => Promise<string | undefined>; }}
+	 * @returns {Promise<import('../types').BuildCommands>}
+	 */
+	async generateBuildCommands(filePaths, options) {
+		const commands = await super.generateBuildCommands(filePaths, options);
+
+		commands.build.push({
+			value: 'npx astro build',
+			attribution: 'default for Astro sites',
+		});
+		commands.output.push({
+			value: 'dist',
+			attribution: 'default for Astro sites',
+		});
+
+		return commands;
+	}
+}

src/ssgs/bridgetown.js

@@ -1,3 +1,4 @@
+import { joinPaths } from '../utility.js';
 import Ssg from './ssg.js';
 
 export default class Bridgetown extends Ssg {
@@ -12,4 +13,43 @@ export default class Bridgetown extends Ssg {
 	templateExtensions() {
 		return super.templateExtensions().concat(['.liquid']);
 	}
+
+	/**
+	 * Generates a list of build suggestions.
+	 *
+	 * @param filePaths {string[]} List of input file paths.
+	 * @param options {{ config?: Record<string, any>; source?: string; readFile?: (path: string) => Promise<string | undefined>; }}
+	 * @returns {Promise<import('../types').BuildCommands>}
+	 */
+	async generateBuildCommands(filePaths, options) {
+		const commands = await super.generateBuildCommands(filePaths, options);
+
+		if (filePaths.includes(joinPaths([options.source, 'Gemfile']))) {
+			commands.install.unshift({
+				value: 'bundle install',
+				attribution: 'because of your Gemfile',
+			});
+
+			if (options.source) {
+				commands.environment['BUNDLE_GEMFILE'] = {
+					value: joinPaths([options.source, 'Gemfile']),
+					attribution: 'because of your Gemfile',
+				};
+			}
+		}
+
+		if (filePaths.includes('bin/bridgetown')) {
+			commands.build.unshift({
+				value: 'bin/bridgetown deploy',
+				attribution: 'most common for Bridgetown sites',
+			});
+		}
+
+		commands.output.unshift({
+			value: 'output',
+			attribution: 'most common for Bridgetown sites',
+		});
+
+		return commands;
+	}
 }

src/ssgs/gatsby.js

@@ -0,0 +1,29 @@
+import Ssg from './ssg.js';
+
+export default class Gatsby extends Ssg {
+	constructor() {
+		super('gatsby');
+	}
+
+	/**
+	 * Generates a list of build suggestions.
+	 *
+	 * @param filePaths {string[]} List of input file paths.
+	 * @param options {{ config?: Record<string, any>; source?: string; readFile?: (path: string) => Promise<string | undefined>; }}
+	 * @returns {Promise<import('../types').BuildCommands>}
+	 */
+	async generateBuildCommands(filePaths, options) {
+		const commands = await super.generateBuildCommands(filePaths, options);
+
+		commands.build.unshift({
+			value: 'npx gatsby build',
+			attribution: 'default for Gatsby sites',
+		});
+		commands.output.unshift({
+			value: 'public',
+			attribution: 'default for Gatsby sites',
+		});
+
+		return commands;
+	}
+}

src/ssgs/hugo.js

@@ -196,14 +196,15 @@ export default class Hugo extends Ssg {
 			headingTags.forEach((tag) => {
 				attribute_elements[tag] = !!parser?.attribute?.title ? 'space right' : 'none';
 			});
-			
+
 			/** @type {(keyof HTMLElementTagNameMap)[]} */
 			const otherTags = ['blockquote', 'hr', 'ol', 'ul', 'p', 'table'];
 			otherTags.forEach((tag) => {
 				attribute_elements[tag] = !!parser?.attribute?.block ? 'below' : 'none';
 			});
 
-			const imgAttrsAllowed = !!parser?.attribute?.block && parser?.wrapStandAloneImageWithinParagraph === false;
+			const imgAttrsAllowed =
+				!!parser?.attribute?.block && parser?.wrapStandAloneImageWithinParagraph === false;
 			attribute_elements.img = imgAttrsAllowed ? 'below' : 'none';
 
 			options.attribute_elements = attribute_elements;
@@ -225,8 +226,13 @@ export default class Hugo extends Ssg {
 	async generateBuildCommands(filePaths, options) {
 		const commands = await super.generateBuildCommands(filePaths, options);
 
+		commands.install.unshift({
+			value: 'export NODE_PATH=`pwd`/node_modules:$NODE_PATH',
+			attribution: 'workaround for a Hugo issue', // https://github.com/gohugoio/hugo/issues/9800
+		});
+
 		commands.build.unshift({
-			value: 'hugo',
+			value: 'hugo -b /',
 			attribution: 'most common for Hugo sites',
 		});
 		commands.output.unshift({

src/ssgs/jekyll.js

@@ -290,7 +290,6 @@ export default class Jekyll extends Ssg {
 
 			options.attributes = true;
 			options.attribute_elements = kramdownAttributeElementOptions;
-
 		} else if (config) {
 			const commonmarkConfig = config?.['commonmark'] || {};
 
@@ -346,6 +345,13 @@ export default class Jekyll extends Ssg {
 				value: 'bundle exec jekyll build',
 				attribution: 'because of your Gemfile',
 			});
+
+			if (options.source) {
+				commands.environment['BUNDLE_GEMFILE'] = {
+					value: joinPaths([options.source, 'Gemfile']),
+					attribution: 'because of your Gemfile',
+				};
+			}
 		} else {
 			commands.build.unshift({
 				value: 'jekyll build',

src/ssgs/lume.js

@@ -0,0 +1,29 @@
+import Ssg from './ssg.js';
+
+export default class Lume extends Ssg {
+	constructor() {
+		super('lume');
+	}
+
+	/**
+	 * Generates a list of build suggestions.
+	 *
+	 * @param filePaths {string[]} List of input file paths.
+	 * @param options {{ config?: Record<string, any>; source?: string; readFile?: (path: string) => Promise<string | undefined>; }}
+	 * @returns {Promise<import('../types.js').BuildCommands>}
+	 */
+	async generateBuildCommands(filePaths, options) {
+		const commands = await super.generateBuildCommands(filePaths, options);
+
+		commands.build.push({
+			value: 'deno task lume',
+			attribution: 'default for Lume sites',
+		});
+		commands.output.unshift({
+			value: '_site',
+			attribution: 'most common for Lume sites',
+		});
+
+		return commands;
+	}
+}

src/ssgs/mkdocs.js

@@ -0,0 +1,29 @@
+import Ssg from './ssg.js';
+
+export default class MkDocs extends Ssg {
+	constructor() {
+		super('mkdocs');
+	}
+
+	/**
+	 * Generates a list of build suggestions.
+	 *
+	 * @param filePaths {string[]} List of input file paths.
+	 * @param options {{ config?: Record<string, any>; source?: string; readFile?: (path: string) => Promise<string | undefined>; }}
+	 * @returns {Promise<import('../types').BuildCommands>}
+	 */
+	async generateBuildCommands(filePaths, options) {
+		const commands = await super.generateBuildCommands(filePaths, options);
+
+		commands.build.push({
+			value: 'npx mkdocs build',
+			attribution: 'default for MkDocs sites',
+		});
+		commands.output.unshift({
+			value: 'site',
+			attribution: 'most common for MkDocs sites',
+		});
+
+		return commands;
+	}
+}

src/ssgs/next-js.js

@@ -20,4 +20,26 @@ export default class NextJs extends Ssg {
 			'public/', // static assets
 		]);
 	}
+
+	/**
+	 * Generates a list of build suggestions.
+	 *
+	 * @param filePaths {string[]} List of input file paths.
+	 * @param options {{ config?: Record<string, any>; source?: string; readFile?: (path: string) => Promise<string | undefined>; }}
+	 * @returns {Promise<import('../types').BuildCommands>}
+	 */
+	async generateBuildCommands(filePaths, options) {
+		const commands = await super.generateBuildCommands(filePaths, options);
+
+		commands.build.unshift({
+			value: 'npx next build && npx next export',
+			attribution: 'most common for Next.js sites',
+		});
+		commands.output.unshift({
+			value: 'out',
+			attribution: 'default for Next.js sites',
+		});
+
+		return commands;
+	}
 }

src/ssgs/nuxt-js.js

@@ -0,0 +1,29 @@
+import Ssg from './ssg.js';
+
+export default class NuxtJs extends Ssg {
+	constructor() {
+		super('nuxtjs');
+	}
+
+	/**
+	 * Generates a list of build suggestions.
+	 *
+	 * @param filePaths {string[]} List of input file paths.
+	 * @param options {{ config?: Record<string, any>; source?: string; readFile?: (path: string) => Promise<string | undefined>; }}
+	 * @returns {Promise<import('../types').BuildCommands>}
+	 */
+	async generateBuildCommands(filePaths, options) {
+		const commands = await super.generateBuildCommands(filePaths, options);
+
+		commands.build.push({
+			value: 'npx nuxt generate',
+			attribution: 'default for Nuxt sites',
+		});
+		commands.output.unshift({
+			value: 'dist',
+			attribution: 'most common for Nuxt sites',
+		});
+
+		return commands;
+	}
+}