@lynx-js/vanilla-rsbuild-plugin 0.0.2 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # `@lynx-js/vanilla-rsbuild-plugin`
 
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies [[`b900a78`](https://github.com/lynx-family/lynx-stack/commit/b900a78a43914adf2aae60849e2d6433be5eb797)]:
+  - @lynx-js/template-webpack-plugin@0.16.1
+
+## 0.1.0
+
+### Minor Changes
+
+- **BREAKING CHANGE**: Require `@lynx-js/rspeedy` `^0.17.0` in the plugins that read the build engine config through `Symbol.for('@lynx-js/rsbuild-plugin:config')`, since the engine that ships with `0.16` does not expose it. The plugins that do not touch the engine keep their existing range and add `^0.17.0` to it. ([#3682](https://github.com/lynx-family/lynx-stack/pull/3682))
+
+### Patch Changes
+
+- Declare the build host as an optional peer dependency. `@rsbuild/core` covers a plain Rsbuild build, and `@lynx-js/rspeedy` covers an Rspeedy one, so whichever host is installed is version-checked. ([#3678](https://github.com/lynx-family/lynx-stack/pull/3678))
+
+- Honor `output.distPath.intermediate`. The Lynx build engine now resolves the intermediate directory, so the option is no longer ignored by the plugins that emit a Lynx bundle. ([#3676](https://github.com/lynx-family/lynx-stack/pull/3676))
+
+- Resolve the bundle filename through `getLynxConfig(api).resolveBundleFilename()` instead of reading `output.filename` out of the Rspeedy config. A configured filename is now honored when the plugins are used with Rsbuild directly. ([#3651](https://github.com/lynx-family/lynx-stack/pull/3651))
+
+- Expose `Symbol.for('LynxTemplatePlugin')` from `pluginLynx` instead of from each DSL plugin, so the plugins that tap the template hooks work with the build engine alone. ([#3675](https://github.com/lynx-family/lynx-stack/pull/3675))
+
+- Wrap the background chunk again. The runtime wrapper only matched assets under `.rspeedy/`, so once the intermediate directory moved to `.lynx/` the background chunk shipped without the wrapper and failed on load with `ReferenceError: lynx is not defined`. The wrapper now targets the background asset the plugin emits, wherever the intermediate directory lives. ([#3745](https://github.com/lynx-family/lynx-stack/pull/3745))
+- Updated dependencies [[`c21cddd`](https://github.com/lynx-family/lynx-stack/commit/c21cddd0b75290330b6891f041db63ee5b28f492), [`f743e12`](https://github.com/lynx-family/lynx-stack/commit/f743e123e058d8f97720b1ce8c4a3d6601c8f7be), [`5637926`](https://github.com/lynx-family/lynx-stack/commit/5637926c579bac5e9b78a02b982b1110cf4421d4), [`cdceffc`](https://github.com/lynx-family/lynx-stack/commit/cdceffc6f3fb9ac7b5ce1f48b7edb53c7788c057), [`6da3e18`](https://github.com/lynx-family/lynx-stack/commit/6da3e189f58637e14318782c176ed5970b59f75d), [`5637926`](https://github.com/lynx-family/lynx-stack/commit/5637926c579bac5e9b78a02b982b1110cf4421d4), [`eaefef6`](https://github.com/lynx-family/lynx-stack/commit/eaefef64d9874a8236d99b8abe17978d803a02da), [`0be26e9`](https://github.com/lynx-family/lynx-stack/commit/0be26e91d362041d1b0f568d15828d92f0ed2a6d), [`32ba734`](https://github.com/lynx-family/lynx-stack/commit/32ba7347d1733eb4b2e19e95d7b7415ae78e23d2)]:
+  - @lynx-js/template-webpack-plugin@0.16.0
+  - @lynx-js/runtime-wrapper-webpack-plugin@0.2.4
+
 ## 0.0.2
 
 ### Patch Changes

package/dist/index.js

@@ -2,11 +2,10 @@ import { statSync } from "node:fs";
 import node_path from "node:path";
 import { RuntimeWrapperWebpackPlugin } from "@lynx-js/runtime-wrapper-webpack-plugin";
 import { LynxEncodePlugin, LynxTemplatePlugin, WebEncodePlugin } from "@lynx-js/template-webpack-plugin";
+const S_LYNX_CONFIG = Symbol.for('@lynx-js/rsbuild-plugin:config');
 const PLUGIN_NAME = 'lynx:vanilla';
 const VANILLA_WEBPACK_PLUGIN_NAME = 'VanillaLynxWebpackPlugin';
 const DEFAULT_ENGINE_VERSION = '3.5';
-const DEFAULT_BUNDLE_FILENAME = '[name].[platform].bundle';
-const INTERMEDIATE_DIR = '.rspeedy';
 const LAYERS = Object.freeze({
     BACKGROUND: 'vanilla:background',
     MAIN_THREAD: 'vanilla:main-thread'
@@ -36,11 +35,6 @@ function resolvePluginOptions(api, options) {
 }
 function exposeVanillaCapabilities(api) {
     api.expose(Symbol.for('LAYERS'), LAYERS);
-    api.expose(Symbol.for('LynxTemplatePlugin'), {
-        LynxTemplatePlugin: {
-            getLynxTemplatePluginHooks: LynxTemplatePlugin.getLynxTemplatePluginHooks.bind(LynxTemplatePlugin)
-        }
-    });
 }
 function disableVanillaHotUpdates(api) {
     api.modifyRsbuildConfig((config, { mergeRsbuildConfig })=>mergeRsbuildConfig(config, {
@@ -52,7 +46,8 @@ function disableVanillaHotUpdates(api) {
 }
 function setupVanillaBundler(api, options) {
     api.modifyBundlerChain((chain, { environment })=>{
-        const rspeedyFilename = api.useExposed(Symbol.for('rspeedy.api'))?.config?.output?.filename;
+        const lynxConfig = api.useExposed(S_LYNX_CONFIG);
+        if (!lynxConfig) throw new Error('No Lynx config exposed. `pluginLynx` has to be applied for the Lynx build engine to be configured.');
         const platform = getVanillaPlatform(environment.name);
         if (!platform) return;
         const entries = resolveVanillaEntries(api, chain.entryPoints.entries() ?? {}, options.entries);
@@ -60,7 +55,7 @@ function setupVanillaBundler(api, options) {
             bundleFilename: options.bundleFilename,
             engineVersion: options.engineVersion,
             platform: environment.name,
-            rspeedyFilename
+            lynxConfig
         };
         chain.entryPoints.clear();
         const artifacts = entries.map(([entryName, entry])=>addVanillaEntry(chain, entryName, entry, entryContext));
@@ -72,8 +67,11 @@ function addVanillaEntry(chain, entryName, entry, context) {
     const hasBackground = void 0 !== backgroundSource;
     const backgroundEntry = `${entryName}__background`;
     const mainThreadEntry = `${entryName}__main-thread`;
-    const backgroundAsset = node_path.posix.join(INTERMEDIATE_DIR, entryName, 'background.js');
-    const mainThreadAsset = node_path.posix.join(INTERMEDIATE_DIR, entryName, 'main-thread.js');
+    const intermediateDir = context.lynxConfig.resolveIntermediateDir({
+        entryName
+    });
+    const backgroundAsset = node_path.posix.join(intermediateDir, 'background.js');
+    const mainThreadAsset = node_path.posix.join(intermediateDir, 'main-thread.js');
     if (hasBackground) chain.entry(backgroundEntry).add({
         layer: LAYERS.BACKGROUND,
         import: backgroundSource,
@@ -97,12 +95,13 @@ function addVanillaEntry(chain, entryName, entry, context) {
                 mainThreadEntry
             ],
             dsl: 'react_nodiff',
-            filename: resolveBundleFilename(context.rspeedyFilename, context.bundleFilename, entryName, context.platform),
-            intermediate: node_path.posix.join(INTERMEDIATE_DIR, entryName),
+            filename: resolveVanillaBundleFilename(context.lynxConfig, context.bundleFilename, entryName, context.platform),
+            intermediate: intermediateDir,
             targetSdkVersion: context.engineVersion
         }
     ]);
     return {
+        backgroundAsset: hasBackground ? backgroundAsset : void 0,
         hasBackground,
         mainThreadAsset
     };
@@ -112,7 +111,9 @@ function addVanillaBundlerPlugins(chain, artifacts, engineVersion, platform) {
     if ('lynx' === platform && artifacts.some((artifact)=>artifact.hasBackground)) chain.plugin(`${PLUGIN_NAME}:runtime-wrapper`).use(RuntimeWrapperWebpackPlugin, [
         {
             targetSdkVersion: engineVersion,
-            test: /^\.rspeedy\/.+\/background\.js$/
+            test: artifacts.flatMap((artifact)=>void 0 === artifact.backgroundAsset ? [] : [
+                    artifact.backgroundAsset
+                ])
         }
     ]);
     if ('lynx' === platform) chain.plugin(LynxEncodePlugin.name).use(LynxEncodePlugin, []);
@@ -195,14 +196,17 @@ function resolveOptionalSource(source, conventionSource) {
     if (source) return source;
     return conventionSource && isFile(conventionSource) ? conventionSource : void 0;
 }
-function resolveBundleFilename(rspeedyFilename, option, entryName, platform) {
-    const configured = option ?? ('object' == typeof rspeedyFilename ? rspeedyFilename.bundle ?? rspeedyFilename.template : rspeedyFilename) ?? DEFAULT_BUNDLE_FILENAME;
+function resolveVanillaBundleFilename(lynxConfig, option, entryName, platform) {
     const context = {
         entryName,
         lazyBundle: false,
         platform
     };
-    const filename = 'function' == typeof configured ? configured(context) : configured;
+    if (void 0 === option) return lynxConfig.resolveBundleFilename({
+        entryName,
+        platform
+    });
+    const filename = 'function' == typeof option ? option(context) : option;
     return filename.replaceAll('[name]', entryName).replaceAll('[platform]', platform);
 }
 function createVanillaWebpackPlugin(mainThreadAssets) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/vanilla-rsbuild-plugin",
-  "version": "0.0.2",
+  "version": "0.1.1",
   "description": "An Rsbuild plugin for building Vanilla Lynx applications with Element PAPI.",
   "keywords": [
     "rsbuild",
@@ -32,14 +32,27 @@
     "README.md"
   ],
   "dependencies": {
-    "@lynx-js/runtime-wrapper-webpack-plugin": "0.2.3",
-    "@lynx-js/template-webpack-plugin": "0.15.2"
+    "@lynx-js/runtime-wrapper-webpack-plugin": "0.2.4",
+    "@lynx-js/template-webpack-plugin": "0.16.1"
   },
   "devDependencies": {
-    "@rsbuild/core": "2.1.10",
-    "@rstest/core": "0.11.6",
-    "@lynx-js/rspeedy": "0.16.5",
-    "@lynx-js/test-tools": "0.0.0"
+    "@lynx-js/rsbuild-plugin": "0.1.2",
+    "@lynx-js/rspeedy": "0.17.2",
+    "@lynx-js/test-tools": "0.0.0",
+    "@rsbuild/core": "2.2.4",
+    "@rstest/core": "0.11.12"
+  },
+  "peerDependencies": {
+    "@lynx-js/rspeedy": "^0.17.0",
+    "@rsbuild/core": "^2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@lynx-js/rspeedy": {
+      "optional": true
+    },
+    "@rsbuild/core": {
+      "optional": true
+    }
   },
   "engines": {
     "node": ">=18"