[feat] prefer functions to globs (#2430)

Author: ignatiusmb

.changeset/nasty-seas-reflect.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+Exports and files property in config.kit.package now accepts a function rather than an object

.changeset/stupid-laws-jog.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+Renamed property exclude to files in config.kit.serviceWorker and now accepts a function instead

documentation/docs/14-configuration.md

@@ -32,14 +32,9 @@ const config = {
 		package: {
 			dir: 'package',
 			emitTypes: true,
-			exports: {
-				include: ['**'],
-				exclude: ['**/_*']
-			},
-			files: {
-				include: ['**'],
-				exclude: []
-			}
+			// excludes all .d.ts and files starting with _ as the name
+			exports: (filepath) => !/^_|\/_|\.d\.ts$/.test(filepath),
+			files: () => true
 		},
 		paths: {
 			assets: '',
@@ -53,7 +48,7 @@ const config = {
 		},
 		router: true,
 		serviceWorker: {
-			exclude: []
+			files: (filepath) => !/\.DS_STORE/.test(filepath)
 		},
 		ssr: true,
 		target: null,
@@ -132,8 +127,27 @@ Options related to [creating a package](#packaging).
 
 - `dir` - output directory
 - `emitTypes` - by default, `svelte-kit package` will automatically generate types for your package in the form of `d.ts.` files. While generating types is configurable, we believe it is best for the ecosystem quality to generate types, always. Please make sure you have a good reason when setting it to `false` (for example when you want to provide handwritten type definitions instead)
-- `exports` - contains an `includes` and an `excludes` array which specifies which files to mark as exported from the `exports` field of the `package.json`. Will merge existing values if available with values from `package.json` taking precedence
-- `files` - contains an `includes` and an `excludes` array which specifies which files to process and copy over when packaging
+- `exports` - a function with the type of `(filepath: string) => boolean`. When `true`, the filepath will be included in the `exports` field of the `package.json`. Any existing values in the `package.json` source will be merged with values from the original `exports` field taking precedence
+- `files` - a function with the type of `(filepath: string) => boolean`. When `true`, the file will be processed and copied over to the final output folder, specified in `dir`
+
+For advanced `filepath` matching, you can use `exports` and `files` options in conjunction with a globbing library:
+
+```js
+// svelte.config.js
+import mm from 'micromatch';
+
+export default {
+	kit: {
+		package: {
+			exports: (filepath) => {
+				if (filepath.endsWith('.d.ts')) return false;
+				return mm.isMatch(filepath, ['!**/_*', '!**/internal/**'])
+			},
+			files: mm.matcher('!**/build.*')
+		}
+	}
+};
+```
 
 ### paths
 
@@ -181,7 +195,7 @@ Enables or disables the client-side [router](#ssr-and-javascript-router) app-wid
 
 An object containing zero or more of the following values:
 
-- `exclude` - an array of glob patterns relative to `files.assets` dir. Files matching any of these would not be available in `$service-worker.files` e.g. if `files.assets` has value `static` then ['og-tags-images/**/*'] would match all files under `static/og-tags-images` dir.
+- `files` - a function with the type of `(filepath: string) => boolean`. When `true`, the given file will be available in `$service-worker.files`, otherwise it will be excluded.
 
 ### ssr
 

packages/kit/package.json

@@ -19,7 +19,6 @@
 		"@types/amphtml-validator": "^1.0.1",
 		"@types/cookie": "^0.4.1",
 		"@types/marked": "^3.0.1",
-		"@types/micromatch": "^4.0.2",
 		"@types/mime": "^2.0.3",
 		"@types/node": "^16.9.1",
 		"@types/rimraf": "^3.0.2",
@@ -31,7 +30,6 @@
 		"kleur": "^4.1.4",
 		"locate-character": "^2.0.5",
 		"marked": "^3.0.4",
-		"micromatch": "^4.0.4",
 		"mime": "^2.5.2",
 		"node-fetch": "3.0.0-beta.9",
 		"port-authority": "^1.1.2",

packages/kit/src/core/config/index.spec.js

@@ -1,12 +1,18 @@
 import { test } from 'uvu';
 import * as assert from 'uvu/assert';
+
+import { remove_keys } from '../../utils/object.js';
 import { validate_config } from './index.js';
 
 test('fills in defaults', () => {
 	const validated = validate_config({});
 
-	// @ts-expect-error - can't test equality of a function
-	delete validated.kit.vite;
+	assert.equal(validated.kit.package.exports(''), true);
+	assert.equal(validated.kit.package.files(''), true);
+	assert.equal(validated.kit.serviceWorker.files(''), true);
+	assert.equal(validated.kit.vite(), {});
+
+	remove_keys(validated, ([, v]) => typeof v === 'function');
 
 	assert.equal(validated, {
 		extensions: ['.svelte'],
@@ -28,19 +34,9 @@ test('fills in defaults', () => {
 			hydrate: true,
 			package: {
 				dir: 'package',
-				emitTypes: true,
-				exports: {
-					include: ['**'],
-					exclude: ['**/_*']
-				},
-				files: {
-					include: ['**'],
-					exclude: []
-				}
-			},
-			serviceWorker: {
-				exclude: []
+				emitTypes: true
 			},
+			serviceWorker: {},
 			paths: {
 				base: '',
 				assets: ''
@@ -111,10 +107,12 @@ test('fills in partial blanks', () => {
 		}
 	});
 
+	assert.equal(validated.kit.package.exports(''), true);
+	assert.equal(validated.kit.package.files(''), true);
+	assert.equal(validated.kit.serviceWorker.files(''), true);
 	assert.equal(validated.kit.vite(), {});
 
-	// @ts-expect-error - can't test equality of a function
-	delete validated.kit.vite;
+	remove_keys(validated, ([, v]) => typeof v === 'function');
 
 	assert.equal(validated, {
 		extensions: ['.svelte'],
@@ -136,19 +134,9 @@ test('fills in partial blanks', () => {
 			hydrate: true,
 			package: {
 				dir: 'package',
-				emitTypes: true,
-				exports: {
-					include: ['**'],
-					exclude: ['**/_*']
-				},
-				files: {
-					include: ['**'],
-					exclude: []
-				}
-			},
-			serviceWorker: {
-				exclude: []
+				emitTypes: true
 			},
+			serviceWorker: {},
 			paths: {
 				base: '',
 				assets: ''

packages/kit/src/core/config/options.js

@@ -75,14 +75,9 @@ const options = object(
 
 			package: object({
 				dir: string('package'),
-				exports: object({
-					include: array_of_strings(['**']),
-					exclude: array_of_strings(['**/_*'])
-				}),
-				files: object({
-					include: array_of_strings(['**']),
-					exclude: array_of_strings([])
-				}),
+				// excludes all .d.ts and filename starting with _
+				exports: fun((filepath) => !/^_|\/_|\.d\.ts$/.test(filepath)),
+				files: fun(() => true),
 				emitTypes: boolean(true)
 			}),
 
@@ -167,7 +162,7 @@ const options = object(
 			router: boolean(true),
 
 			serviceWorker: object({
-				exclude: array_of_strings([])
+				files: fun((filename) => !/\.DS_STORE/.test(filename))
 			}),
 
 			ssr: boolean(true),
@@ -266,19 +261,6 @@ function string(fallback, allow_empty = true) {
 	});
 }
 
-/**
- * @param {string[]} array
- * @returns {Validator}
- */
-function array_of_strings(array) {
-	return validate(array, (input, keypath) => {
-		if (!Array.isArray(input) || !input.every((glob) => typeof glob === 'string')) {
-			throw new Error(`${keypath} must be an array of strings`);
-		}
-		return input;
-	});
-}
-
 /**
  * @param {boolean} fallback
  * @returns {Validator}
@@ -310,6 +292,19 @@ function list(options, fallback = options[0]) {
 	});
 }
 
+/**
+ * @param {(filename: string) => boolean} fallback
+ * @returns {Validator}
+ */
+function fun(fallback) {
+	return validate(fallback, (input, keypath) => {
+		if (typeof input !== 'function') {
+			throw new Error(`${keypath} should be a function, if specified`);
+		}
+		return input;
+	});
+}
+
 /**
  * @param {string} input
  * @param {string} keypath

packages/kit/src/core/config/test/index.js

@@ -1,7 +1,10 @@
 import { join } from 'path';
-import { test } from 'uvu';
-import * as assert from 'uvu/assert';
 import { fileURLToPath } from 'url';
+
+import * as assert from 'uvu/assert';
+import { test } from 'uvu';
+
+import { remove_keys } from '../../../utils/object.js';
 import { load_config } from '../index.js';
 
 const __filename = fileURLToPath(import.meta.url);
@@ -14,9 +17,7 @@ async function testLoadDefaultConfig(path) {
 	const cwd = join(__dirname, 'fixtures', path);
 
 	const config = await load_config({ cwd });
-
-	// @ts-expect-error - can't test equality of a function
-	delete config.kit.vite;
+	remove_keys(config, ([, v]) => typeof v === 'function');
 
 	assert.equal(config, {
 		extensions: ['.svelte'],
@@ -38,19 +39,9 @@ async function testLoadDefaultConfig(path) {
 			hydrate: true,
 			package: {
 				dir: 'package',
-				emitTypes: true,
-				exports: {
-					include: ['**'],
-					exclude: ['**/_*']
-				},
-				files: {
-					include: ['**'],
-					exclude: []
-				}
-			},
-			serviceWorker: {
-				exclude: []
+				emitTypes: true
 			},
+			serviceWorker: {},
 			paths: { base: '', assets: '' },
 			prerender: {
 				crawl: true,

packages/kit/src/core/create_manifest_data/index.js

@@ -2,7 +2,6 @@ import fs from 'fs';
 import path from 'path';
 import mime from 'mime';
 import { posixify } from '../utils.js';
-import glob from 'tiny-glob/sync.js';
 
 /**
  * A portion of a file or directory name where the name has been split into
@@ -26,44 +25,6 @@ import glob from 'tiny-glob/sync.js';
 
 const specials = new Set(['__layout', '__layout.reset', '__error']);
 
-/**
- *
- * @param {import('types/config').ValidatedConfig} config
- * @returns {import('types/internal').ManifestData['assets']}
- */
-function get_assets_list(config) {
-	const assets_dir = config.kit.files.assets;
-	/**
-	 * @type {import('types/internal').Asset[]}
-	 */
-	let assets = [];
-	if (fs.existsSync(assets_dir)) {
-		/**
-		 * @type {string[]}
-		 */
-		const exclusions = config.kit.serviceWorker.exclude || [];
-
-		exclusions.push('**/.DS_STORE');
-
-		/**
-		 * @type {string[]}
-		 */
-		let excluded_paths = [];
-
-		exclusions.forEach((exclusion) => {
-			excluded_paths = [
-				...excluded_paths,
-				...glob(exclusion, {
-					cwd: assets_dir,
-					dot: true
-				})
-			];
-		});
-		assets = list_files(assets_dir, '', [], excluded_paths);
-	}
-	return assets;
-}
-
 /**
  * @param {{
  *   config: import('types/config').ValidatedConfig;
@@ -276,8 +237,12 @@ export default function create_manifest_data({ config, output, cwd = process.cwd
 
 	walk(config.kit.files.routes, [], [], [layout], [error]);
 
+	const assets = fs.existsSync(config.kit.files.assets)
+		? list_files({ config, dir: config.kit.files.assets, path: '' })
+		: [];
+
 	return {
-		assets: get_assets_list(config),
+		assets,
 		layout,
 		error,
 		components,
@@ -419,24 +384,23 @@ function get_pattern(segments, add_trailing_slash) {
 }
 
 /**
- * @param {string} dir
- * @param {string} path
- * @param {import('types/internal').Asset[]} files
- * @param {string[]} excluded_paths Paths relative to dir which should be excluded from files list.
+ * @param {{
+ *  config: import('types/config').ValidatedConfig;
+ * 	dir: string;
+ * 	path: string;
+ * 	files?: import('types/internal').Asset[]
+ * }} args
  */
-function list_files(dir, path, files = [], excluded_paths = []) {
+function list_files({ config, dir, path, files = [] }) {
 	fs.readdirSync(dir).forEach((file) => {
 		const full = `${dir}/${file}`;
 
 		const stats = fs.statSync(full);
 		const joined = path ? `${path}/${file}` : file;
 
 		if (stats.isDirectory()) {
-			list_files(full, joined, files, excluded_paths);
-		} else {
-			if (excluded_paths.includes(joined)) {
-				return;
-			}
+			list_files({ config, dir: full, path: joined, files });
+		} else if (config.kit.serviceWorker.files(joined)) {
 			files.push({
 				file: joined,
 				size: stats.size,

packages/kit/src/core/create_manifest_data/index.spec.js

@@ -22,7 +22,7 @@ const create = (dir, extensions = ['.svelte']) => {
 			},
 			appDir: '_app',
 			serviceWorker: {
-				exclude: []
+				files: (filepath) => !/\.DS_STORE/.test(filepath)
 			}
 		}
 	};