feat: add filename option (#5)

Author: chenjiahan

README.md

@@ -32,6 +32,24 @@ export default {
 
 Then visit the https URL of the page, and confirm in your browser.
 
+## Options
+
+If you need to customize the compilation behavior of Sass, you can use the following configs.
+
+### filename
+
+Filename of the generated certificate.
+
+- **Type:** `string`
+- **Default:** `'fake-cert.pem'`
+- **Example:**
+
+```ts
+pluginBasicSsl({
+  filename: 'foo.pem',
+});
+```
+
 ## License
 
 [MIT](./LICENSE).

src/index.ts

@@ -3,16 +3,24 @@ import { resolveHttpsConfig } from './util.js';
 
 export const PLUGIN_BASIC_SSL_NAME = 'rsbuild:basic-ssl';
 
-export function pluginBasicSsl(): RsbuildPlugin {
-	return {
-		name: PLUGIN_BASIC_SSL_NAME,
-		setup(api) {
-			api.modifyRsbuildConfig((config) => {
-				config.server = {
-					...config.server,
-					https: resolveHttpsConfig(config.server?.https),
-				};
-			});
-		},
-	};
-}
+export type PluginBasicSslOptions = {
+	/**
+	 * Filename of the generated certificate
+	 * @default 'fake-cert.pem'
+	 */
+	filename?: string;
+};
+
+export const pluginBasicSsl = (
+	options: PluginBasicSslOptions = {},
+): RsbuildPlugin => ({
+	name: PLUGIN_BASIC_SSL_NAME,
+	setup(api) {
+		api.modifyRsbuildConfig((config) => {
+			config.server = {
+				...config.server,
+				https: resolveHttpsConfig(config.server?.https, options),
+			};
+		});
+	},
+});

src/util.ts

@@ -2,11 +2,13 @@ import fs from 'node:fs';
 import path from 'node:path';
 import type { ServerConfig } from '@rsbuild/core';
 import selfsigned from 'selfsigned';
+import type { PluginBasicSslOptions } from './index.js';
 
 type HttpsConfig = ServerConfig['https'];
 
 export const resolveHttpsConfig = (
 	config: HttpsConfig,
+	options: PluginBasicSslOptions,
 ): {
 	key: NonNullable<HttpsConfig>['key'];
 	cert: NonNullable<HttpsConfig>['cert'];
@@ -17,7 +19,7 @@ export const resolveHttpsConfig = (
 		return { key, cert };
 	}
 
-	const certPath = path.join(__dirname, 'fake-cert.pem');
+	const certPath = path.join(__dirname, options.filename ?? 'fake-cert.pem');
 
 	if (fs.existsSync(certPath)) {
 		const stats = fs.statSync(certPath);

test/filename/index.test.ts

@@ -0,0 +1,33 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { expect, test } from '@playwright/test';
+import { createRsbuild } from '@rsbuild/core';
+import { pluginBasicSsl } from '../../dist';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+test('should print HTTPS server URLs when custom filename', async () => {
+	const rsbuild = await createRsbuild({
+		cwd: __dirname,
+		rsbuildConfig: {
+			plugins: [
+				pluginBasicSsl({
+					filename: 'foo.pem',
+				}),
+			],
+			server: {
+				port: 3100,
+			},
+		},
+	});
+
+	const { server, urls } = await rsbuild.startDevServer();
+
+	await new Promise((resolve) => {
+		rsbuild.onDevCompileDone(resolve);
+	});
+
+	expect(urls.every((url) => url.startsWith('https'))).toBeTruthy();
+
+	await server.close();
+});

test/filename/rsbuild.config.ts

@@ -0,0 +1,5 @@
+import { pluginBasicSsl } from '@rsbuild/plugin-basic-ssl';
+
+export default {
+	plugins: [pluginBasicSsl()],
+};

test/filename/src/index.js

@@ -0,0 +1 @@
+console.log('1');