Add sanitizeFileName option

docs/999-big-list-of-options.md

@@ -1320,6 +1320,14 @@ Default: `false`
 
 Generate `const` declarations for exports rather than `var` declarations.
 
+#### output.sanitizeFileName
+Type: `boolean | (string) => string`<br>
+Default: `true`
+
+Set to `false` to disable all chunk name sanitizations (removal of `\0`, `?` and `*` characters).
+
+Alternatively set to a function to allow custom chunk name sanitization.
+
 #### output.strict
 Type: `boolean`<br>
 CLI: `--strict`/`--no-strict`<br>

src/Chunk.ts

@@ -210,6 +210,7 @@ export default class Chunk {
 	} = Object.create(null);
 	private renderedModuleSources = new Map<Module, MagicString>();
 	private renderedSource: MagicStringBundle | null = null;
+	private sanitizeFileName: (id: string) => string;
 	private sortedExportNames: string[] | null = null;
 	private strictFacade = false;
 	private usedModules: Module[] = undefined as any;
@@ -254,6 +255,12 @@ export default class Chunk {
 			}
 		}
 		this.suggestedVariableName = makeLegal(this.generateVariableName());
+		if (this.outputOptions.sanitizeFileName === false)
+			this.sanitizeFileName = (id) => id;
+		else if (typeof this.outputOptions.sanitizeFileName === 'function')
+			this.sanitizeFileName = this.outputOptions.sanitizeFileName;
+		else
+			this.sanitizeFileName = sanitizeFileName;
 	}
 
 	canModuleBeFacade(module: Module, exposedVariables: Set<Variable>): boolean {
@@ -424,7 +431,8 @@ export default class Chunk {
 							? this.computeContentHashWithDependencies(addons, options, existingNames)
 							: '[hash]',
 					name: () => this.getChunkName()
-				}
+				},
+				this.sanitizeFileName
 			),
 			existingNames
 		);
@@ -437,7 +445,7 @@ export default class Chunk {
 		unsetOptions: Set<string>
 	): string {
 		const id = this.orderedModules[0].id;
-		const sanitizedId = sanitizeFileName(id);
+		const sanitizedId = this.sanitizeFileName(id);
 		let path: string;
 		if (isAbsolute(id)) {
 			const extension = extname(id);
@@ -501,7 +509,7 @@ export default class Chunk {
 	}
 
 	getChunkName(): string {
-		return this.name || (this.name = sanitizeFileName(this.getFallbackChunkName()));
+		return this.name || (this.name = this.sanitizeFileName(this.getFallbackChunkName()));
 	}
 
 	getExportNames(): string[] {
@@ -816,7 +824,7 @@ export default class Chunk {
 		if (fileName) {
 			this.fileName = fileName;
 		} else {
-			this.name = sanitizeFileName(name || getChunkNameFromModule(facadedModule));
+			this.name = this.sanitizeFileName(name || getChunkNameFromModule(facadedModule));
 		}
 	}
 

src/rollup/types.d.ts

@@ -649,6 +649,7 @@ export interface OutputOptions {
 	preferConst?: boolean;
 	preserveModules?: boolean;
 	preserveModulesRoot?: string;
+	sanitizeFileName?: boolean | ((fileName: string) => string);
 	sourcemap?: boolean | 'inline' | 'hidden';
 	sourcemapExcludeSources?: boolean;
 	sourcemapFile?: string;
@@ -693,6 +694,7 @@ export interface NormalizedOutputOptions {
 	preferConst: boolean;
 	preserveModules: boolean;
 	preserveModulesRoot: string | undefined;
+	sanitizeFileName: boolean | ((fileName: string) => string);
 	sourcemap: boolean | 'inline' | 'hidden';
 	sourcemapExcludeSources: boolean;
 	sourcemapFile: string | undefined;

src/utils/options/mergeOptions.ts

@@ -223,6 +223,7 @@ function mergeOutputOptions(
 		preferConst: getOption('preferConst'),
 		preserveModules: getOption('preserveModules'),
 		preserveModulesRoot: getOption('preserveModulesRoot'),
+		sanitizeFileName: getOption('sanitizeFileName'),
 		sourcemap: getOption('sourcemap'),
 		sourcemapExcludeSources: getOption('sourcemapExcludeSources'),
 		sourcemapFile: getOption('sourcemapFile'),

src/utils/options/normalizeOutputOptions.ts

@@ -66,6 +66,7 @@ export function normalizeOutputOptions(
 		preferConst: (config.preferConst as boolean | undefined) || false,
 		preserveModules,
 		preserveModulesRoot: getPreserveModulesRoot(config),
+		sanitizeFileName: config.sanitizeFileName as NormalizedOutputOptions['sanitizeFileName'] ?? true,
 		sourcemap: (config.sourcemap as boolean | 'inline' | 'hidden' | undefined) || false,
 		sourcemapExcludeSources: (config.sourcemapExcludeSources as boolean | undefined) || false,
 		sourcemapFile: config.sourcemapFile as string | undefined,

src/utils/relativeId.ts

@@ -1,5 +1,5 @@
 import { basename, extname, isAbsolute, relative, resolve } from './path';
-import { sanitizeFileName } from './sanitizeFileName';
+import { sanitizeFileName as defaultSanitizeFileName } from './sanitizeFileName';
 
 export function getAliasName(id: string) {
 	const base = basename(id);
@@ -11,7 +11,7 @@ export default function relativeId(id: string) {
 	return relative(resolve(), id);
 }
 
-export function isPlainPathFragment(name: string) {
+export function isPlainPathFragment(name: string, sanitizeFileName = defaultSanitizeFileName) {
 	// not starting with "/", "./", "../"
 	return (
 		name[0] !== '/' &&

src/utils/renderNamePattern.ts

@@ -1,13 +1,15 @@
 import { errFailedValidation, error } from './error';
 import { extname } from './path';
 import { isPlainPathFragment } from './relativeId';
+import { sanitizeFileName as defaultSanitizeFileName } from './sanitizeFileName';
 
 export function renderNamePattern(
 	pattern: string,
 	patternName: string,
-	replacements: { [name: string]: () => string }
+	replacements: { [name: string]: () => string },
+	sanitizeFileName = defaultSanitizeFileName
 ) {
-	if (!isPlainPathFragment(pattern))
+	if (!isPlainPathFragment(pattern, sanitizeFileName))
 		return error(
 			errFailedValidation(
 				`Invalid pattern "${pattern}" for "${patternName}", patterns can be neither absolute nor relative paths and must not contain invalid characters.`

test/function/samples/output-options-hook/_config.js

@@ -42,6 +42,7 @@ module.exports = {
 					plugins: [],
 					preferConst: false,
 					preserveModules: false,
+					sanitizeFileName: true,
 					sourcemap: false,
 					sourcemapExcludeSources: false,
 					strict: true,

test/hooks/index.js

@@ -1100,6 +1100,27 @@ describe('hooks', () => {
 			});
 	});
 
+	it('supports disabling sanitization for in-memory / in-browser / non-fs builds', () => {
+		return rollup
+			.rollup({
+				input: 'input.js',
+				plugins: [{
+					resolveId: id => id,
+					load: () => `export default 5`
+				}]
+			})
+			.then(bundle => {
+				return bundle.generate({
+					format: 'es',
+					sanitizeFileName: false,
+					entryFileNames: 'test:[name]'
+				});
+			})
+			.then(({ output }) => {
+				assert.strictEqual(output[0].fileName, 'test:input');
+			});
+	});
+
 	describe('deprecated', () => {
 		it('caches chunk emission in transform hook', () => {
 			let cache;