Support loading an HTML file with a custom name (#36)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
sindresorhus · Jan 22, 2024 · c307a57 · c307a57
1 parent 2968431
commit c307a57
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 5 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -22,6 +22,13 @@ declare namespace electronServe {
 		*/
 		hostname?: string;
 
+		/**
+		Custom HTML filename. This gets appended with `'.html'`.
+
+		@default 'index'
+		*/
+		file?: string;
+
 		/**
 		Whether [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) should be enabled.
 		Useful for testing purposes.

diff --git a/index.js b/index.js
@@ -9,7 +9,7 @@ const stat = promisify(fs.stat);
 // See https://cs.chromium.org/chromium/src/net/base/net_error_list.h
 const FILE_NOT_FOUND = -6;
 
-const getPath = async path_ => {
+const getPath = async (path_, file) => {
 	try {
 		const result = await stat(path_);
 
@@ -18,7 +18,7 @@ const getPath = async path_ => {
 		}
 
 		if (result.isDirectory()) {
-			return getPath(path.join(path_, 'index.html'));
+			return getPath(path.join(path_, `${file}.html`));
 		}
 	} catch (_) {}
 };
@@ -27,7 +27,8 @@ module.exports = options => {
 	options = Object.assign({
 		isCorsEnabled: true,
 		scheme: 'app',
-		hostname: '-'
+		hostname: '-',
+		file: 'index'
 	}, options);
 
 	if (!options.directory) {
@@ -37,9 +38,9 @@ module.exports = options => {
 	options.directory = path.resolve(electron.app.getAppPath(), options.directory);
 
 	const handler = async (request, callback) => {
-		const indexPath = path.join(options.directory, 'index.html');
+		const indexPath = path.join(options.directory, `${options.file}.html`);
 		const filePath = path.join(options.directory, decodeURIComponent(new URL(request.url).pathname));
-		const resolvedPath = await getPath(filePath);
+		const resolvedPath = await getPath(filePath, options.file);
 		const fileExtension = path.extname(filePath);
 
 		if (resolvedPath || !fileExtension || fileExtension === '.html' || fileExtension === '.asar') {

diff --git a/readme.md b/readme.md
@@ -64,6 +64,13 @@ Default: `'-'`
 
 Custom hostname.
 
+##### file
+
+Type: `string`\
+Default: `'index'`
+
+Custom HTML filename. This gets appended with `'.html'`.
+
 ##### isCorsEnabled
 
 Type: `boolean`\

diff --git a/test/fixture-custom-file.js b/test/fixture-custom-file.js
@@ -0,0 +1,14 @@
+'use strict';
+const {app, BrowserWindow} = require('electron');
+const serve = require('..');
+
+const loadUrl = serve({directory: __dirname, file: 'owl'});
+
+let mainWindow;
+
+(async () => {
+	await app.whenReady();
+
+	mainWindow = new BrowserWindow();
+	loadUrl(mainWindow);
+})();
diff --git a/test/owl.html b/test/owl.html
@@ -0,0 +1,9 @@
+<!doctype html>
+<html>
+	<head>
+		<meta charset="utf-8">
+	</head>
+	<body>
+		<h1>🦉</h1>
+	</body>
+</html>
diff --git a/test/test.js b/test/test.js
@@ -65,3 +65,15 @@ test('throws error if unresolved path has an extension other than .html', async
 	await t.throwsAsync(client.waitUntilTextExists('h1', '🦄', 5000));
 	t.pass();
 });
+
+test('serves directory custom file', async t => {
+	t.context.spectron = new Application({
+		path: electron,
+		args: ['fixture-custom-file.js']
+	});
+	await t.context.spectron.start();
+	const {client} = t.context.spectron;
+	await client.waitUntilWindowLoaded();
+	await client.waitUntilTextExists('h1', '🦉', 5000);
+	t.pass();
+});