farm-fe · wre232114 · Jul 8, 2024 · Apr 30, 2024 · Apr 30, 2024 · Apr 30, 2024
diff --git a/.changeset/proud-snakes-wash.md b/.changeset/proud-snakes-wash.md
@@ -0,0 +1,8 @@
+---
+'create-farm-plugin': patch
+'@farmfe/plugin-react': patch
+'@farmfe/plugin-sass': patch
+'@farmfe/core': patch
+---
+
+feat: normalize usage of rust plugins and js plugins
diff --git a/crates/core/src/config/persistent_cache.rs b/crates/core/src/config/persistent_cache.rs
@@ -91,7 +91,10 @@ impl PersistentCacheConfig {
           let mut content = String::new();
 
           for dep in &cloned_obj.build_dependencies {
-            if !PathBuf::from(dep).exists() || !PathBuf::from(dep).is_file() {
+            if !PathBuf::from(dep).exists()
+              || !PathBuf::from(dep).is_file()
+              || dep.ends_with(".farm")
+            {
               content.push_str(dep);
             } else {
               let c = std::fs::read_to_string(dep).unwrap();

diff --git a/examples/external/package.json b/examples/external/package.json
@@ -14,6 +14,7 @@
     "@farmfe/cli": "^1.0.1",
     "@farmfe/core": "^1.1.1",
     "@types/jquery": "^3.5.29",
+    "jquery": "^3.7.1",
     "typescript": "^5.4.3"
   }
 }
diff --git a/examples/vite-adapter-react/farm.config.ts b/examples/vite-adapter-react/farm.config.ts
@@ -1,11 +1,17 @@
 import { defineConfig } from '@farmfe/core';
 import Pages from 'vite-plugin-pages';
+import react from '@farmfe/plugin-react'
 
 export default defineConfig({
-  plugins: ['@farmfe/plugin-react'],
-  vitePlugins:[
-   Pages({
-      resolver:'react'
-    }),
+  plugins: [
+    react({ runtime: 'automatic', refresh: true})
+  ],
+  compilation:{
+    persistentCache: false
+  },
+  vitePlugins: [
+    Pages({
+      resolver: 'react'
+    })
   ]
 });
diff --git a/examples/vite-adapter-react/index.html b/examples/vite-adapter-react/index.html
@@ -4,10 +4,10 @@
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Document</title>
+  <title>${title}$</title>
 </head>
 <body>
   <div id="root"></div>
   <script src="./src/index.tsx"></script>
 </body>
-</html>
+</html>
diff --git a/examples/vite-adapter-react/package.json b/examples/vite-adapter-react/package.json
@@ -15,6 +15,7 @@
     "@farmfe/plugin-react": "workspace:*",
     "@types/react": "18",
     "@types/react-dom": "18",
+    "farm-plugin-remove-console": "^0.1.4",
     "react-refresh": "^0.14.0",
     "vite-plugin-pages": "^0.32.0"
   },

diff --git a/examples/vite-adapter-react/src/index.tsx b/examples/vite-adapter-react/src/index.tsx
@@ -8,6 +8,7 @@ const container = document.querySelector('#root');
 const root = createRoot(container);
 
 function App() {
+  console.log('this is a react app');
   return <Suspense fallback={<p>Loading...</p>}>{useRoutes(routes)}</Suspense>;
 }
 

diff --git a/packages/core/src/config/constants.ts b/packages/core/src/config/constants.ts
@@ -13,3 +13,5 @@ export const CUSTOM_KEYS = {
   external_record: 'external.record',
   runtime_isolate: 'runtime.isolate'
 };
+
+export const FARM_RUST_PLUGIN_FUNCTION_ENTRY = 'func.js';
diff --git a/packages/core/src/plugin/rust/rustPluginResolver.ts b/packages/core/src/plugin/rust/rustPluginResolver.ts
@@ -2,8 +2,16 @@ import { createRequire } from 'node:module';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
 
-export type RustPlugin = string | [string, Record<string, unknown>];
+export type RustPlugin = string | [string, any];
 
+type RustPluginPathObject = {
+  binary: string;
+  options: Record<string, any>;
+};
+
+type RustPluginFunction = (
+  options?: Record<string, any>
+) => [string, typeof options];
 /**
  * Resolve the binary plugin file, return [filePath, jsonStringifiedOptions]
  * @param plugin rust plugin config
@@ -18,7 +26,7 @@ export async function rustPluginResolver(
   if (typeof plugin === 'string') {
     pluginPath = plugin;
   } else if (Array.isArray(plugin) && plugin.length === 2) {
-    [pluginPath, options] = [plugin[0], JSON.stringify(plugin[1])];
+    [pluginPath, options] = [plugin[0], JSON.stringify(plugin[1]) ?? '{}'];
   } else {
     throw new Error(
       'Invalid config: [plugins]. A rust plugin must be a string, or [string, Record<string, any>]'
@@ -39,13 +47,22 @@ export async function rustPluginResolver(
     } else {
       pluginPath = await import(pluginPath).then((m) => m.default);
     }
+    // console.log(pluginPath);
+
+    // Calling the plugin as a function
+    if (typeof pluginPath === 'function') {
+      const [_path, _options] = (pluginPath as RustPluginFunction)();
+      options = JSON.stringify({
+        ..._options,
+        ...JSON.parse(options)
+      });
+      pluginPath = _path;
+    }
 
     // The entry js file should return { binary: string, options: Record<string, any> } when it's not string
     if (typeof pluginPath !== 'string') {
-      const { binary, options: pluginOptions } = pluginPath as {
-        binary: string;
-        options: Record<string, any>;
-      };
+      const { binary, options: pluginOptions } =
+        pluginPath as RustPluginPathObject;
       options = JSON.stringify({
         ...pluginOptions,
         ...JSON.parse(options)

diff --git a/packages/create-farm-plugin/index.ts b/packages/create-farm-plugin/index.ts
@@ -173,10 +173,6 @@ function replaceNamePlaceholders(
       name: '<FARM-RUST-PLUGIN-NPM-NAME>',
       replace: () => options.pluginName
     },
-    {
-      name: '<FARM-RUST-PLUGIN-NPM-NAME>',
-      replace: () => options.pluginName
-    },
     {
       name: '<FARM-RUST-PLUGIN-CARGO-NAME>',
       replace: () => {

diff --git a/packages/create-farm-plugin/templates/rust/options.d.ts b/packages/create-farm-plugin/templates/rust/options.d.ts
@@ -0,0 +1,3 @@
+export interface IPluginOptions {
+
+}
diff --git a/packages/create-farm-plugin/templates/rust/package.json b/packages/create-farm-plugin/templates/rust/package.json
@@ -23,9 +23,9 @@
   },
   "exports": {
     ".": {
-      "import": "./scripts/index.js",
-      "require": "./scripts/index.js",
-      "types": "./scripts/index.d.ts"
+      "import": "./scripts/func.js",
+      "types": "./scripts/index.d.ts",
+      "default": "./scripts/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -37,6 +37,7 @@
     "prepublishOnly": "farm-plugin-tools prepublish"
   },
   "files": [
-    "scripts"
+    "scripts",
+    "options.d.ts"
   ]
 }
diff --git a/packages/create-farm-plugin/templates/rust/scripts/func.js b/packages/create-farm-plugin/templates/rust/scripts/func.js
@@ -0,0 +1,3 @@
+import binPath from "./index.js";
+
+export default (options)=>[binPath,options];
diff --git a/packages/create-farm-plugin/templates/rust/scripts/index.d.ts b/packages/create-farm-plugin/templates/rust/scripts/index.d.ts
@@ -1,2 +1,3 @@
-const binPath: string;
+import type { IPluginOptions } from '../options.d';
+declare const binPath: (options?: IPluginOptions) => [string, IPluginOptions];
 export default binPath;