feat: basic implementation

Author: chenjiahan

README.md

@@ -1,10 +1,10 @@
-# rsbuild-plugin-example
+# @rsbuild/plugin-basic-ssl
 
-rsbuild-plugin-example is a Rsbuild plugin to do something.
+@rsbuild/plugin-basic-ssl is a Rsbuild plugin to do something.
 
 <p>
-  <a href="https://npmjs.com/package/rsbuild-plugin-example">
-   <img src="https://img.shields.io/npm/v/rsbuild-plugin-example?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
+  <a href="https://npmjs.com/package/@rsbuild/plugin-basic-ssl">
+   <img src="https://img.shields.io/npm/v/@rsbuild/plugin-basic-ssl?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
   </a>
   <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
 </p>
@@ -14,17 +14,17 @@ rsbuild-plugin-example is a Rsbuild plugin to do something.
 Install:
 
 ```bash
-npm add rsbuild-plugin-example -D
+npm add @rsbuild/plugin-basic-ssl -D
 ```
 
 Add plugin to your `rsbuild.config.ts`:
 
 ```ts
 // rsbuild.config.ts
-import { pluginExample } from "rsbuild-plugin-example";
+import { pluginBasicSsl } from "@rsbuild/plugin-basic-ssl";
 
 export default {
-  plugins: [pluginExample()],
+  plugins: [pluginBasicSsl()],
 };
 ```
 
@@ -39,7 +39,7 @@ Some description.
 - Example:
 
 ```js
-pluginExample({
+pluginBasicSsl({
   foo: "bar",
 });
 ```

package.json

@@ -1,7 +1,7 @@
 {
-	"name": "rsbuild-plugin-example",
+	"name": "@rsbuild/plugin-basic-ssl",
 	"version": "0.0.0",
-	"repository": "https://github.com/rspack-contrib/rsbuild-plugin-template",
+	"repository": "https://github.com/rspack-contrib/rsbuild-plugin-basic-ssl",
 	"license": "MIT",
 	"type": "module",
 	"exports": {
@@ -31,6 +31,9 @@
 			"biome check --write --no-errors-on-unmatched"
 		]
 	},
+  "dependencies": {
+    "selfsigned": "^2.4.1"
+  },
 	"devDependencies": {
 		"@biomejs/biome": "^1.8.3",
 		"@playwright/test": "^1.44.1",

playground/rsbuild.config.ts

@@ -1,6 +1,6 @@
 import { defineConfig } from '@rsbuild/core';
-import { pluginExample } from '../src';
+import { pluginBasicSsl } from '../src';
 
 export default defineConfig({
-	plugins: [pluginExample()],
+	plugins: [pluginBasicSsl()],
 });

pnpm-lock.yaml

@@ -1,16 +1,18 @@
 import type { RsbuildPlugin } from '@rsbuild/core';
+import { resolveHttpsConfig } from './util.js';
 
-export type PluginExampleOptions = {
-	foo?: string;
-	bar?: boolean;
-};
+export const PLUGIN_BASIC_SSL_NAME = 'rsbuild:basic-ssl';
 
-export const pluginExample = (
-	options: PluginExampleOptions = {},
-): RsbuildPlugin => ({
-	name: 'plugin-example',
-
-	setup() {
-		console.log('Hello Rsbuild!', options);
-	},
-});
+export function pluginBasicSsl(): RsbuildPlugin {
+	return {
+		name: PLUGIN_BASIC_SSL_NAME,
+		setup(api) {
+			api.modifyRsbuildConfig((config) => {
+				config.server = {
+					...config.server,
+					https: resolveHttpsConfig(config.server?.https),
+				};
+			});
+		},
+	};
+}

src/index.ts

@@ -0,0 +1,47 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import type { ServerConfig } from '@rsbuild/core';
+import selfsigned from 'selfsigned';
+
+type HttpsConfig = ServerConfig['https'];
+
+export const resolveHttpsConfig = (
+	config: HttpsConfig,
+): {
+	key: NonNullable<HttpsConfig>['key'];
+	cert: NonNullable<HttpsConfig>['cert'];
+} => {
+	const { key, cert } = config ?? {};
+
+	if (key && cert) {
+		return { key, cert };
+	}
+
+	const certPath = path.join(__dirname, 'fake-cert.pem');
+	if (fs.existsSync(certPath)) {
+		const stats = fs.statSync(certPath);
+		// Default validity period is 30 days
+		if (stats.mtimeMs <= Date.now() - 1000 * 60 * 60 * 24 * 30) {
+			const content = fs.readFileSync(certPath, { encoding: 'utf-8' });
+			return {
+				key: content,
+				cert: content,
+			};
+		}
+	}
+
+	const pem = selfsigned.generate(
+		[{ name: 'commonName', value: 'localhost' }],
+		{
+			days: 30,
+			keySize: 2048,
+		},
+	);
+
+	const content = pem.private + pem.cert;
+	fs.writeFileSync(certPath, content, { encoding: 'utf-8' });
+	return {
+		key: content,
+		cert: content,
+	};
+};

src/util.ts

@@ -2,15 +2,15 @@ import { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { expect, test } from '@playwright/test';
 import { createRsbuild } from '@rsbuild/core';
-import { pluginExample } from '../../src';
+import { pluginBasicSsl } from '../../src';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 test('should render page as expected', async ({ page }) => {
 	const rsbuild = await createRsbuild({
 		cwd: __dirname,
 		rsbuildConfig: {
-			plugins: [pluginExample()],
+			plugins: [pluginBasicSsl()],
 		},
 	});
 
@@ -26,7 +26,7 @@ test('should build succeed', async ({ page }) => {
 	const rsbuild = await createRsbuild({
 		cwd: __dirname,
 		rsbuildConfig: {
-			plugins: [pluginExample()],
+			plugins: [pluginBasicSsl()],
 		},
 	});
 

test/basic/index.test.ts

@@ -1,7 +1,7 @@
 import { defineConfig } from 'tsup';
 
 export default defineConfig({
-	entry: ['./src/*.ts'],
+	entry: ['./src/index.ts'],
 	format: ['esm', 'cjs'],
 	target: 'node18',
 	dts: true,