chore: improve

umijs · Dec 20, 2024 · 9356ff3 · 9356ff3
1 parent 68bdad8
commit 9356ff3
Show file tree

Hide file tree

Showing 11 changed files with 91 additions and 78 deletions.
diff --git a/crates/binding/src/js_hook.rs b/crates/binding/src/js_hook.rs
@@ -3,6 +3,7 @@ use napi::NapiRaw;
 use napi_derive::napi;
 use serde_json::Value;
 
+use crate::js_plugin::PluginContext;
 use crate::threadsafe_function::ThreadsafeFunction;
 
 #[napi(object)]
@@ -81,19 +82,21 @@ pub struct JsHooks {
     pub transform_include: Option<JsFunction>,
 }
 
+type ResolveIdFuncParams = (PluginContext, String, String, ResolveIdParams);
+
 pub struct TsFnHooks {
-    pub build_start: Option<ThreadsafeFunction<(), ()>>,
-    pub build_end: Option<ThreadsafeFunction<(), ()>>,
-    pub write_bundle: Option<ThreadsafeFunction<(), ()>>,
-    pub generate_end: Option<ThreadsafeFunction<Value, ()>>,
-    pub load: Option<ThreadsafeFunction<String, Option<LoadResult>>>,
-    pub load_include: Option<ThreadsafeFunction<String, Option<bool>>>,
-    pub watch_changes: Option<ThreadsafeFunction<(String, WatchChangesParams), ()>>,
-    pub resolve_id:
-        Option<ThreadsafeFunction<(String, String, ResolveIdParams), Option<ResolveIdResult>>>,
-    pub _on_generate_file: Option<ThreadsafeFunction<WriteFile, ()>>,
-    pub transform: Option<ThreadsafeFunction<(String, String), Option<TransformResult>>>,
-    pub transform_include: Option<ThreadsafeFunction<String, Option<bool>>>,
+    pub build_start: Option<ThreadsafeFunction<PluginContext, ()>>,
+    pub build_end: Option<ThreadsafeFunction<PluginContext, ()>>,
+    pub write_bundle: Option<ThreadsafeFunction<PluginContext, ()>>,
+    pub generate_end: Option<ThreadsafeFunction<(PluginContext, Value), ()>>,
+    pub load: Option<ThreadsafeFunction<(PluginContext, String), Option<LoadResult>>>,
+    pub load_include: Option<ThreadsafeFunction<(PluginContext, String), Option<bool>>>,
+    pub watch_changes: Option<ThreadsafeFunction<(PluginContext, String, WatchChangesParams), ()>>,
+    pub resolve_id: Option<ThreadsafeFunction<ResolveIdFuncParams, Option<ResolveIdResult>>>,
+    pub _on_generate_file: Option<ThreadsafeFunction<(PluginContext, WriteFile), ()>>,
+    pub transform:
+        Option<ThreadsafeFunction<(PluginContext, String, String), Option<TransformResult>>>,
+    pub transform_include: Option<ThreadsafeFunction<(PluginContext, String), Option<bool>>>,
 }
 
 impl TsFnHooks {

diff --git a/crates/binding/src/js_plugin.rs b/crates/binding/src/js_plugin.rs
@@ -6,10 +6,11 @@ use mako::ast::file::{Content, JsContent};
 use mako::compiler::Context;
 use mako::plugin::{Plugin, PluginGenerateEndParams, PluginLoadParam, PluginResolveIdParams};
 use mako::resolve::{ExternalResource, Resolution, ResolvedResource, ResolverResource};
+use napi_derive::napi;
 
 use crate::js_hook::{
-    LoadResult, ResolveIdParams, ResolveIdResult, TransformResult, TsFnHooks,
-    WatchChangesParams, WriteFile,
+    LoadResult, ResolveIdParams, ResolveIdResult, TransformResult, TsFnHooks, WatchChangesParams,
+    WriteFile,
 };
 
 fn content_from_result(result: TransformResult) -> Result<Content> {
@@ -27,6 +28,17 @@ fn content_from_result(result: TransformResult) -> Result<Content> {
     }
 }
 
+#[napi]
+pub struct PluginContext {}
+
+#[napi]
+impl PluginContext {
+    #[napi]
+    pub fn warn(&self, msg: String) {
+        println!("WARN: {}", msg)
+    }
+}
+
 pub struct JsPlugin {
     pub hooks: TsFnHooks,
     pub name: Option<String>,
@@ -44,27 +56,25 @@ impl Plugin for JsPlugin {
 
     fn build_start(&self, _context: &Arc<Context>) -> Result<()> {
         if let Some(hook) = &self.hooks.build_start {
-            hook.call(())?
+            hook.call(PluginContext {})?
         }
         Ok(())
     }
 
     fn load(&self, param: &PluginLoadParam, _context: &Arc<Context>) -> Result<Option<Content>> {
         if let Some(hook) = &self.hooks.load {
             if self.hooks.load_include.is_some()
-                && self
-                    .hooks
-                    .load_include
-                    .as_ref()
-                    .unwrap()
-                    .call(param.file.path.to_string_lossy().to_string())?
-                    == Some(false)
+                && self.hooks.load_include.as_ref().unwrap().call((
+                    PluginContext {},
+                    param.file.path.to_string_lossy().to_string(),
+                ))? == Some(false)
             {
                 return Ok(None);
             }
-            let x: Option<LoadResult> = hook.call(
+            let x: Option<LoadResult> = hook.call((
+                PluginContext {},
                 param.file.path.to_string_lossy().to_string(),
-            )?;
+            ))?;
             if let Some(x) = x {
                 return content_from_result(TransformResult {
                     content: x.content,
@@ -85,6 +95,7 @@ impl Plugin for JsPlugin {
     ) -> Result<Option<ResolverResource>> {
         if let Some(hook) = &self.hooks.resolve_id {
             let x: Option<ResolveIdResult> = hook.call((
+                PluginContext {},
                 source.to_string(),
                 importer.to_string(),
                 ResolveIdParams {
@@ -116,17 +127,18 @@ impl Plugin for JsPlugin {
         // keep generate_end for compatibility
         // since build_end does not have none error params in unplugin's api spec
         if let Some(hook) = &self.hooks.generate_end {
-            hook.call(serde_json::to_value(param)?)?
+            hook.call((PluginContext {}, serde_json::to_value(param)?))?
         }
         if let Some(hook) = &self.hooks.build_end {
-            hook.call(())?
+            hook.call(PluginContext {})?
         }
         Ok(())
     }
 
     fn watch_changes(&self, id: &str, event: &str, _context: &Arc<Context>) -> Result<()> {
         if let Some(hook) = &self.hooks.watch_changes {
             hook.call((
+                PluginContext {},
                 id.to_string(),
                 WatchChangesParams {
                     event: event.to_string(),
@@ -138,17 +150,20 @@ impl Plugin for JsPlugin {
 
     fn write_bundle(&self, _context: &Arc<Context>) -> Result<()> {
         if let Some(hook) = &self.hooks.write_bundle {
-            hook.call(())?
+            hook.call(PluginContext {})?
         }
         Ok(())
     }
 
     fn before_write_fs(&self, path: &std::path::Path, content: &[u8]) -> Result<()> {
         if let Some(hook) = &self.hooks._on_generate_file {
-            hook.call(WriteFile {
-                path: path.to_string_lossy().to_string(),
-                content: content.to_vec(),
-            })?;
+            hook.call((
+                PluginContext {},
+                WriteFile {
+                    path: path.to_string_lossy().to_string(),
+                    content: content.to_vec(),
+                },
+            ))?;
         }
         Ok(())
     }
@@ -160,7 +175,7 @@ impl Plugin for JsPlugin {
         _context: &Arc<Context>,
     ) -> Result<Option<Content>> {
         if let Some(hook) = &self.hooks.transform_include {
-            if hook.call(path.to_string())? == Some(false) {
+            if hook.call((PluginContext {}, path.to_string()))? == Some(false) {
                 return Ok(None);
             }
         }
@@ -172,7 +187,8 @@ impl Plugin for JsPlugin {
                 _ => return Ok(None),
             };
 
-            let result: Option<TransformResult> = hook.call((content_str, path.to_string()))?;
+            let result: Option<TransformResult> =
+                hook.call((PluginContext {}, content_str, path.to_string()))?;
 
             if let Some(result) = result {
                 return content_from_result(result).map(Some);

diff --git a/e2e/fixtures/plugins.context/mako.config.json b/e2e/fixtures/plugins.context/mako.config.json
@@ -1,3 +1,6 @@
 {
+  "plugins": [
+    "./plugin"
+  ],
   "minify": false
 }
diff --git a/e2e/fixtures/plugins.context/node_modules/plugin/index.js b/e2e/fixtures/plugins.context/node_modules/plugin/index.js
diff --git a/e2e/fixtures/plugins.context/plugin.js b/e2e/fixtures/plugins.context/plugin.js
@@ -0,0 +1,6 @@
+
+module.exports = {
+  async load(path) {
+    path.endsWith('.hoo');
+  }
+};
diff --git a/e2e/fixtures/plugins.context/plugins.config.js b/e2e/fixtures/plugins.context/plugins.config.js
@@ -1,10 +1,14 @@
 module.exports = [
   {
+    async loadInclude(path) {
+      // this.warn('loadInclude: ' + path);
+      path.endsWith('.hoo');
+      return true;
+    },
     async load(path) {
       if (path.endsWith('.hoo')) {
-        console.log('----');
-        console.log('load', path, this, this.error, this.root);
-        console.log('----');
+        // console.log('load', path, this, this.warn);
+        this.warn('load: ' + path);
         return {
           content: `export default () => <Foooo>.hoo</Foooo>;`,
           type: 'jsx',

diff --git a/e2e/fixtures/plugins/node_modules/plugin/index.js b/e2e/fixtures/plugins/node_modules/plugin/index.js
diff --git a/packages/mako/binding.d.ts b/packages/mako/binding.d.ts
@@ -270,3 +270,6 @@ export interface BuildParams {
   watch: boolean;
 }
 export declare function build(buildParams: BuildParams): Promise<void>;
+export class PluginContext {
+  warn(msg: string): void;
+}
diff --git a/packages/mako/binding.js b/packages/mako/binding.js
@@ -304,6 +304,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`);
 }
 
-const { build } = nativeBinding;
+const { PluginContext, build } = nativeBinding;
 
+module.exports.PluginContext = PluginContext;
 module.exports.build = build;
diff --git a/packages/mako/src/index.ts b/packages/mako/src/index.ts
@@ -135,27 +135,6 @@ export async function build(params: BuildParams) {
     });
   }
 
-  // add context to each plugin's hook
-  params.config.plugins.forEach((plugin: any) => {
-    Object.keys(plugin).forEach((key) => {
-      const oldValue = plugin[key];
-      if (typeof oldValue === 'function') {
-        plugin[key] = (context: any, ...args: any[]) => {
-          const c = {
-            ...(context || {}),
-            // error: (err: any) => {
-            //   console.error(err);
-            // },
-            // log: (...args: any[]) => {
-            //   console.log(...args);
-            // },
-          };
-          return oldValue.apply(c, [...args]);
-        };
-      }
-    });
-  });
-
   // support dump mako config
   if (process.env.DUMP_MAKO_CONFIG) {
     const configFile = path.join(params.root, 'mako.config.json');
@@ -206,6 +185,24 @@ export async function build(params: BuildParams) {
       );
     }
   });
+
+  // add context to each plugin's hook
+  plugins.forEach((plugin: any) => {
+    Object.keys(plugin).forEach((key) => {
+      const oldValue = plugin[key];
+      if (typeof oldValue === 'function') {
+        plugin[key] = (context: any, ...args: any[]) => {
+          return oldValue.apply(
+            {
+              warn: context.warn.bind(context),
+            },
+            [...args],
+          );
+        };
+      }
+    });
+  });
+
   params.config = omit(params.config, [
     'less',
     'sass',

diff --git a/scripts/mako.js b/scripts/mako.js
@@ -18,11 +18,6 @@ build({
 
 function getPlugins() {
   let plugins = [];
-  const hooksPath = path.join(cwd, 'hooks.config.js');
-  if (fs.existsSync(hooksPath)) {
-    let hooks = require(hooksPath);
-    plugins.push(hooks);
-  }
   const pluginsPath = path.join(cwd, 'plugins.config.js');
   if (fs.existsSync(pluginsPath)) {
     plugins.push(...require(pluginsPath));