feat: add selfsignedOptions option (#8)

Author: chenjiahan

README.md

@@ -66,6 +66,30 @@ pluginBasicSsl({
 });
 ```
 
+### selfsignedOptions
+
+Options passing to `selfsigned`, see [selfsigned - Options](https://github.com/jfromaniello/selfsigned?tab=readme-ov-file#options) for details.
+
+- **Type:** `SelfsignedOptions`
+- **Default:**
+
+```ts
+const defaultOptions = {
+  days: 30,
+  keySize: 2048,
+};
+```
+
+- **Example:**
+
+```ts
+pluginBasicSsl({
+  selfsignedOptions: {
+    days: 100,
+  },
+});
+```
+
 ## License
 
 [MIT](./LICENSE).

src/index.ts

@@ -1,4 +1,5 @@
 import type { RsbuildPlugin } from '@rsbuild/core';
+import type { SelfsignedOptions } from 'selfsigned';
 import { resolveHttpsConfig } from './util.js';
 
 export const PLUGIN_BASIC_SSL_NAME = 'rsbuild:basic-ssl';
@@ -14,6 +15,10 @@ export type PluginBasicSslOptions = {
 	 * @default __dirname
 	 */
 	outputPath?: string;
+	/**
+	 * Options passing to `selfsigned`.
+	 */
+	selfsignedOptions?: SelfsignedOptions;
 };
 
 export const pluginBasicSsl = (

src/util.ts

@@ -33,13 +33,19 @@ export const resolveHttpsConfig = async (
 		options.filename ?? 'fake-cert.pem',
 	);
 
+	const selfsignedOptions = {
+		days: 30,
+		keySize: 2048,
+		...options.selfsignedOptions,
+	};
+
 	if (fs.existsSync(certPath)) {
 		const stats = await fs.promises.stat(certPath);
 		const timeDiff = Date.now() - stats.mtimeMs;
 		const daysDiff = timeDiff / (1000 * 60 * 60 * 24);
 
 		// Default validity period is 30 days
-		if (daysDiff < 30) {
+		if (daysDiff < selfsignedOptions.days) {
 			const content = await fs.promises.readFile(certPath, {
 				encoding: 'utf-8',
 			});
@@ -52,10 +58,7 @@ export const resolveHttpsConfig = async (
 
 	const pem = selfsigned.generate(
 		[{ name: 'commonName', value: 'localhost' }],
-		{
-			days: 30,
-			keySize: 2048,
-		},
+		selfsignedOptions,
 	);
 
 	const content = pem.private + pem.cert;

test/selfsigned-options/index.test.ts

@@ -0,0 +1,35 @@
+import { dirname, join } 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 selfsigned options', async () => {
+	const rsbuild = await createRsbuild({
+		cwd: __dirname,
+		rsbuildConfig: {
+			plugins: [
+				pluginBasicSsl({
+					selfsignedOptions: {
+						days: 1,
+					},
+				}),
+			],
+			server: {
+				port: 3300,
+			},
+		},
+	});
+
+	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/selfsigned-options/rsbuild.config.ts

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

test/selfsigned-options/src/index.js

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