Merge pull request #9 from CloudCannon/feat/more-build-suggestion-fields

Add suggestion fields for preserved paths and environments

src/ssgs/hugo.js

@@ -112,6 +112,16 @@ export default class Hugo extends Ssg {
 			attribution: 'most common for Hugo sites',
 		});
 
+		commands.environment['HUGO_CACHEDIR'] = {
+			value: '/usr/local/__site/src/.hugo_cache/',
+			attribution: 'recommended for Hugo sites',
+		};
+
+		commands.preserved.push({
+			value: '.hugo_cache/,resources/',
+			attribution: 'recommended for speeding up Hugo builds',
+		});
+
 		return commands;
 	}
 }

src/ssgs/jekyll.js

@@ -368,6 +368,11 @@ export default class Jekyll extends Ssg {
 			attribution: 'most common for Jekyll sites',
 		});
 
+		commands.environment['JEKYLL_ENV'] = {
+			value: 'production',
+			attribution: 'recommended for hosted Jekyll sites',
+		};
+
 		return commands;
 	}
 }

src/ssgs/ssg.js

@@ -383,7 +383,13 @@ export default class Ssg {
 	 */
 	async generateBuildCommands(filePaths, options) {
 		/** @type {import('../types').BuildCommands} */
-		const commands = { install: [], build: [], output: [] };
+		const commands = {
+			install: [],
+			build: [],
+			output: [],
+			preserved: [],
+			environment: {},
+		};
 
 		const packageJsonPath = joinPaths([options.source, 'package.json']);
 		if (filePaths.includes(packageJsonPath)) {
@@ -392,6 +398,11 @@ export default class Ssg {
 				attribution: 'because of your `package.json` file',
 			});
 
+			commands.preserved.push({
+				value: 'node_modules/',
+				attribution: 'because of your `package.json` file',
+			});
+
 			try {
 				const raw = options.readFile ? await options.readFile(packageJsonPath) : undefined;
 				const parsed = raw ? JSON.parse(raw) : undefined;

src/types.d.ts

@@ -47,4 +47,6 @@ export interface BuildCommands {
 	install: BuildCommandSuggestion[];
 	build: BuildCommandSuggestion[];
 	output: BuildCommandSuggestion[];
+	environment: Record<string, BuildCommandSuggestion>;
+	preserved: BuildCommandSuggestion[];
 }