Move compress inside kit (#5822)

* move tiny-glob dependency * add compress to builder * replace compress with builder.compress * add changeset * Clarify directory type description. Co-authored-by: Ben McCann <[email protected]> * Update .changeset/cyan-radios-attend.md Co-authored-by: Ben McCann <[email protected]> Co-authored-by: Rich Harris <[email protected]>
sveltejs · Aug 6, 2022 · 9304c9d · 9304c9d
1 parent d74ef25
commit 9304c9d
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 113 deletions.
diff --git a/.changeset/cyan-radios-attend.md b/.changeset/cyan-radios-attend.md
@@ -0,0 +1,7 @@
+---
+'@sveltejs/adapter-node': patch
+'@sveltejs/adapter-static': patch
+'@sveltejs/kit': patch
+---
+
+Move `compress` logic to `Builder` API
diff --git a/packages/adapter-node/index.js b/packages/adapter-node/index.js
@@ -1,11 +1,5 @@
-import { createReadStream, createWriteStream, existsSync, statSync, writeFileSync } from 'fs';
-import { pipeline } from 'stream';
-import glob from 'tiny-glob';
+import { writeFileSync } from 'fs';
 import { fileURLToPath } from 'url';
-import { promisify } from 'util';
-import zlib from 'zlib';
-
-const pipe = promisify(pipeline);
 
 const files = fileURLToPath(new URL('./files', import.meta.url).href);
 
@@ -49,51 +43,9 @@ export default function (opts = {}) {
 
 			if (precompress) {
 				builder.log.minor('Compressing assets');
-				await compress(`${out}/client`);
-				await compress(`${out}/prerendered`);
+				await builder.compress(`${out}/client`);
+				await builder.compress(`${out}/prerendered`);
 			}
 		}
 	};
 }
-
-/**
- * @param {string} directory
- */
-async function compress(directory) {
-	if (!existsSync(directory)) {
-		return;
-	}
-
-	const files = await glob('**/*.{html,js,json,css,svg,xml,wasm}', {
-		cwd: directory,
-		dot: true,
-		absolute: true,
-		filesOnly: true
-	});
-
-	await Promise.all(
-		files.map((file) => Promise.all([compress_file(file, 'gz'), compress_file(file, 'br')]))
-	);
-}
-
-/**
- * @param {string} file
- * @param {'gz' | 'br'} format
- */
-async function compress_file(file, format = 'gz') {
-	const compress =
-		format == 'br'
-			? zlib.createBrotliCompress({
-					params: {
-						[zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT,
-						[zlib.constants.BROTLI_PARAM_QUALITY]: zlib.constants.BROTLI_MAX_QUALITY,
-						[zlib.constants.BROTLI_PARAM_SIZE_HINT]: statSync(file).size
-					}
-			  })
-			: zlib.createGzip({ level: zlib.constants.Z_BEST_COMPRESSION });
-
-	const source = createReadStream(file);
-	const destination = createWriteStream(`${file}.${format}`);
-
-	await pipe(source, compress, destination);
-}
diff --git a/packages/adapter-node/package.json b/packages/adapter-node/package.json
@@ -31,9 +31,6 @@
 		"format": "npm run lint -- --write",
 		"prepublishOnly": "npm run build"
 	},
-	"dependencies": {
-		"tiny-glob": "^0.2.9"
-	},
 	"devDependencies": {
 		"@rollup/plugin-json": "^4.1.0",
 		"@sveltejs/kit": "workspace:*",

diff --git a/packages/adapter-static/index.js b/packages/adapter-static/index.js
@@ -1,12 +1,5 @@
-import { createReadStream, createWriteStream, statSync } from 'fs';
-import { pipeline } from 'stream';
-import glob from 'tiny-glob';
-import { promisify } from 'util';
-import zlib from 'zlib';
 import { platforms } from './platforms.js';
 
-const pipe = promisify(pipeline);
-
 /** @type {import('.').default} */
 export default function (options) {
 	return {
@@ -49,13 +42,13 @@ export default function (options) {
 			if (precompress) {
 				if (pages === assets) {
 					builder.log.minor('Compressing assets and pages');
-					await compress(assets);
+					await builder.compress(assets);
 				} else {
 					builder.log.minor('Compressing assets');
-					await compress(assets);
+					await builder.compress(assets);
 
 					builder.log.minor('Compressing pages');
-					await compress(pages);
+					await builder.compress(pages);
 				}
 			}
 
@@ -69,41 +62,3 @@ export default function (options) {
 		}
 	};
 }
-
-/**
- * @param {string} directory
- */
-async function compress(directory) {
-	const files = await glob('**/*.{html,js,json,css,svg,xml,wasm}', {
-		cwd: directory,
-		dot: true,
-		absolute: true,
-		filesOnly: true
-	});
-
-	await Promise.all(
-		files.map((file) => Promise.all([compress_file(file, 'gz'), compress_file(file, 'br')]))
-	);
-}
-
-/**
- * @param {string} file
- * @param {'gz' | 'br'} format
- */
-async function compress_file(file, format = 'gz') {
-	const compress =
-		format == 'br'
-			? zlib.createBrotliCompress({
-					params: {
-						[zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT,
-						[zlib.constants.BROTLI_PARAM_QUALITY]: zlib.constants.BROTLI_MAX_QUALITY,
-						[zlib.constants.BROTLI_PARAM_SIZE_HINT]: statSync(file).size
-					}
-			  })
-			: zlib.createGzip({ level: zlib.constants.Z_BEST_COMPRESSION });
-
-	const source = createReadStream(file);
-	const destination = createWriteStream(`${file}.${format}`);
-
-	await pipe(source, compress, destination);
-}
diff --git a/packages/adapter-static/package.json b/packages/adapter-static/package.json
@@ -24,9 +24,6 @@
 		"format": "npm run lint -- --write",
 		"test": "uvu test test.js"
 	},
-	"dependencies": {
-		"tiny-glob": "^0.2.9"
-	},
 	"devDependencies": {
 		"@sveltejs/kit": "workspace:*",
 		"@types/node": "^16.11.36",

diff --git a/packages/kit/package.json b/packages/kit/package.json
@@ -12,7 +12,8 @@
 	"dependencies": {
 		"@sveltejs/vite-plugin-svelte": "^1.0.1",
 		"chokidar": "^3.5.3",
-		"sade": "^1.8.1"
+		"sade": "^1.8.1",
+		"tiny-glob": "^0.2.9"
 	},
 	"devDependencies": {
 		"@playwright/test": "^1.23.4",

diff --git a/packages/kit/src/core/adapt/builder.js b/packages/kit/src/core/adapt/builder.js
@@ -1,3 +1,8 @@
+import glob from 'tiny-glob';
+import zlib from 'zlib';
+import { existsSync, statSync, createReadStream, createWriteStream } from 'fs';
+import { pipeline } from 'stream';
+import { promisify } from 'util';
 import { copy, rimraf, mkdirp } from '../../utils/filesystem.js';
 import { generate_manifest } from '../generate_manifest/index.js';
 
@@ -25,6 +30,30 @@ export function create_builder({ config, build_data, prerendered, log }) {
 		return true;
 	}
 
+	const pipe = promisify(pipeline);
+
+	/**
+	 * @param {string} file
+	 * @param {'gz' | 'br'} format
+	 */
+	async function compress_file(file, format = 'gz') {
+		const compress =
+			format == 'br'
+				? zlib.createBrotliCompress({
+						params: {
+							[zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT,
+							[zlib.constants.BROTLI_PARAM_QUALITY]: zlib.constants.BROTLI_MAX_QUALITY,
+							[zlib.constants.BROTLI_PARAM_SIZE_HINT]: statSync(file).size
+						}
+				  })
+				: zlib.createGzip({ level: zlib.constants.Z_BEST_COMPRESSION });
+
+		const source = createReadStream(file);
+		const destination = createWriteStream(`${file}.${format}`);
+
+		await pipe(source, compress, destination);
+	}
+
 	return {
 		log,
 		rimraf,
@@ -151,6 +180,23 @@ export function create_builder({ config, build_data, prerendered, log }) {
 			);
 		},
 
+		async compress(directory) {
+			if (!existsSync(directory)) {
+				return;
+			}
+
+			const files = await glob('**/*.{html,js,json,css,svg,xml,wasm}', {
+				cwd: directory,
+				dot: true,
+				absolute: true,
+				filesOnly: true
+			});
+
+			await Promise.all(
+				files.map((file) => Promise.all([compress_file(file, 'gz'), compress_file(file, 'br')]))
+			);
+		},
+
 		async prerender() {
 			throw new Error(
 				'builder.prerender() has been removed. Prerendering now takes place in the build phase — see builder.prerender and builder.writePrerendered'

diff --git a/packages/kit/types/index.d.ts b/packages/kit/types/index.d.ts
@@ -80,6 +80,11 @@ export interface Builder {
 			replace?: Record<string, string>;
 		}
 	): string[];
+
+	/**
+	 * @param {string} directory Path to the directory containing the files to be compressed
+	 */
+	compress(directory: string): void;
 }
 
 export interface Config {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml