@savvy-web/rspress-builder 0.12.0 → 1.0.0

package/README.md

@@ -17,19 +17,20 @@ pnpm add -D @savvy-web/rspress-builder
 
 ## Quick start
 
-Add a `savvy.build.ts` to the plugin package root. `definePlugin` returns a standard bundler config, which the re-exported `runBuild` consumes unchanged:
+Add a `savvy.build.ts` to the plugin package root and call `build()` — it derives `cwd` and `argv` from `process` and applies the `definePlugin` preset automatically:
 
 ```ts
 // savvy.build.ts
-import { definePlugin, runBuild } from "@savvy-web/rspress-builder";
+import { build } from "@savvy-web/rspress-builder";
 
-const config = definePlugin({ runtime: true, dtsBundledPackages: ["@rspress/core"] });
+await build();
+```
 
-export default config;
+Pass options to tune the preset — for example, to bundle `@rspress/core` declarations into the output types or disable the runtime bundle for a plugin with no browser component:
 
-if (import.meta.main) {
-  await runBuild(config, { cwd: import.meta.dirname, argv: process.argv.slice(2) });
-}
+```ts
+await build({ dtsBundledPackages: ["@rspress/core"] });
+await build({ runtime: false });
 ```
 
 Wire the build targets into `package.json` scripts and run them with Node's native TypeScript support:
@@ -45,6 +46,8 @@ Wire the build targets into `package.json` scripts and run them with Node's nati
 
 The plugin entry (`.`) builds for Node with `@rspress/core` externalized. The runtime entry (`./runtime`) builds for the browser, bundleless, with CSS modules enabled and React, `@rspress/core` and `@theme` externalized so RSPress provides them at site build time.
 
+For advanced use, `definePlugin` and `runBuild` remain exported as primitives.
+
 ## Configuration
 
 `definePlugin` keeps a small surface because RSPress plugins have a fixed shape:

package/{public/ecma.json → ecma.json}

@@ -8,12 +8,12 @@
 		"declarationMap": false,
 		"emitDeclarationOnly": false,
 		"esModuleInterop": true,
+		"exactOptionalPropertyTypes": true,
 		"explainFiles": false,
 		"forceConsistentCasingInFileNames": true,
 		"incremental": true,
 		"isolatedDeclarations": false,
 		"isolatedModules": true,
-		"exactOptionalPropertyTypes": true,
 		"jsx": "preserve",
 		"lib": ["esnext"],
 		"module": "nodenext",
@@ -28,8 +28,8 @@
 		"target": "es2025",
 		"tsBuildInfoFile": "${configDir}/dist/.tsbuildinfo.lib",
 		"typeRoots": ["${configDir}/node_modules/@types", "${configDir}/types"],
-		"verbatimModuleSyntax": true,
-		"types": ["node"]
+		"types": ["node"],
+		"verbatimModuleSyntax": true
 	},
 	"exclude": ["${configDir}/node_modules", "${configDir}/dist/**/*"],
 	"include": [

package/index.d.ts

@@ -48,6 +48,14 @@ interface RspressPluginOptions {
  * @public
  */
 declare function definePlugin(options?: RspressPluginOptions): BuildConfig;
+/**
+ * Front door for building an RSPress plugin. Applies the {@link definePlugin} preset
+ * and runs the build, deriving `cwd` and `argv` from `process.argv`. For advanced use,
+ * {@link definePlugin} and `runBuild` remain exported.
+ *
+ * @public
+ */
+declare function build(options?: RspressPluginOptions, overrides?: Partial<RunOptions>): Promise<void>;
 //#endregion
-export { RspressBundleOptions, RspressPluginOptions, type RunOptions, definePlugin, runBuild };
+export { RspressBundleOptions, RspressPluginOptions, type RunOptions, build, definePlugin, runBuild };
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -1,3 +1,4 @@
+import { dirname } from "node:path";
 import { defineBuild, runBuild } from "@savvy-web/bundler";
 
 //#region src/index.ts
@@ -50,6 +51,20 @@ function definePlugin(options = {}) {
 		...overrides.length > 0 ? { overrides } : {}
 	});
 }
+/**
+* Front door for building an RSPress plugin. Applies the {@link definePlugin} preset
+* and runs the build, deriving `cwd` and `argv` from `process.argv`. For advanced use,
+* {@link definePlugin} and `runBuild` remain exported.
+*
+* @public
+*/
+async function build(options = {}, overrides = {}) {
+	return runBuild(definePlugin(options), {
+		cwd: process.argv[1] ? dirname(process.argv[1]) : process.cwd(),
+		argv: process.argv.slice(2),
+		...overrides
+	});
+}
 
 //#endregion
-export { definePlugin, runBuild };
+export { build, definePlugin, runBuild };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@savvy-web/rspress-builder",
-	"version": "0.12.0",
+	"version": "1.0.0",
 	"private": false,
 	"description": "RSPress plugin builder for the Silk Suite, built on @savvy-web/bundler",
 	"homepage": "https://github.com/savvy-web/systems/tree/main/packages/rspress-builder",
@@ -24,14 +24,14 @@
 			"types": "./index.d.ts",
 			"import": "./index.js"
 		},
-		"./rspress-env.d.ts": "./public/rspress-env.d.ts",
-		"./tsconfig/ecma.json": "./public/ecma.json",
-		"./tsconfig/plugin.json": "./public/tsconfig/plugin.json",
+		"./rspress-env.d.ts": "./rspress-env.d.ts",
+		"./tsconfig/ecma.json": "./ecma.json",
+		"./tsconfig/plugin.json": "./tsconfig/plugin.json",
 		"./package.json": "./package.json"
 	},
 	"dependencies": {
-		"@savvy-web/bundler": "0.12.0",
-		"@savvy-web/tsdown-plugins": "0.12.0",
+		"@savvy-web/bundler": "1.0.0",
+		"@savvy-web/tsdown-plugins": "1.0.0",
 		"@tsdown/css": "^0.22.3"
 	},
 	"peerDependencies": {