feat: add CaseSensitivePlugin

crates/mako/src/compiler.rs

@@ -244,6 +244,7 @@ impl Compiler {
             Arc::new(plugins::copy::CopyPlugin {}),
             Arc::new(plugins::import::ImportPlugin {}),
             // file types
+            Arc::new(plugins::case_sensitive::CaseSensitivePlugin::new()),
             Arc::new(plugins::context_module::ContextModulePlugin {}),
             Arc::new(plugins::runtime::MakoRuntime {}),
             Arc::new(plugins::invalid_webpack_syntax::InvalidWebpackSyntaxPlugin {}),

crates/mako/src/plugins.rs

@@ -1,5 +1,6 @@
 pub mod async_runtime;
 pub mod bundless_compiler;
+pub mod case_sensitive;
 pub mod central_ensure;
 pub mod context_module;
 pub mod copy;

crates/mako/src/plugins/case_sensitive.rs

@@ -0,0 +1,124 @@
+use std::collections::HashMap;
+use std::fs;
+use std::path::PathBuf;
+use std::sync::{Arc, Mutex};
+
+use anyhow::{anyhow, Result};
+
+use crate::ast::file::Content;
+use crate::compiler::Context;
+use crate::plugin::{Plugin, PluginLoadParam};
+
+pub struct CaseSensitivePlugin {
+    cache_map: Arc<Mutex<HashMap<String, Vec<String>>>>,
+}
+
+impl CaseSensitivePlugin {
+    pub fn new() -> Self {
+        CaseSensitivePlugin {
+            cache_map: Default::default(),
+        }
+    }
+
+    pub fn is_checkable(&self, _param: &PluginLoadParam, root: &String) -> bool {
+        let file_path = &_param.file.path.to_string_lossy().to_string();
+        if !file_path.starts_with(root) {
+            return false;
+        }
+        if file_path.contains("/node_modules/") {
+            return false;
+        }
+        true
+    }
+
+    pub fn check_case_sensitive(&self, file: &PathBuf, root: &String) -> String {
+        // 可变变量，在循环内会被修改
+        let mut file_path = file.clone();
+        let mut case_name = String::new();
+        // 缓存map，file path做为key存在对应路径下的文件名和文件夹名
+        let mut cache_map = self.cache_map.lock().unwrap();
+        while file_path.to_string_lossy().len() >= root.len() {
+            if let Some(current) = file_path.file_name() {
+                let current_str = current.to_string_lossy().to_string();
+                file_path.pop(); // parent directory
+                let mut entries: Vec<String> = Vec::new();
+                if let Some(dir) = file_path.to_str() {
+                    if let Some(i) = cache_map.get(dir as &str) {
+                        entries = i.to_vec();
+                    } else {
+                        if let Ok(files) = fs::read_dir(file_path.clone()) {
+                            for entry in files {
+                                if let Ok(entry) = entry {
+                                    // Here, `entry` is a `DirEntry`.
+                                    entries.push(entry.file_name().to_string_lossy().to_string());
+                                }
+                            }
+                        }
+                        cache_map.insert(dir.to_string(), entries.to_vec());
+                    }
+                }
+                if !entries.contains(&current_str) {
+                    if let Some(correct_name) = entries
+                        .iter()
+                        .find(|&x| x.to_lowercase() == current_str.to_lowercase())
+                    {
+                        case_name = correct_name.clone();
+                        println!(
+                            "File name is case-insensitive. Correct name is: {}",
+                            correct_name
+                        );
+                        break;
+                    }
+                }
+            }
+        }
+        case_name
+    }
+}
+
+impl Plugin for CaseSensitivePlugin {
+    fn name(&self) -> &str {
+        "case_sensitive_plugin"
+    }
+
+    fn load(&self, _param: &PluginLoadParam, _context: &Arc<Context>) -> Result<Option<Content>> {
+        println!("case_sensitive_plugin");
+        let root = &_context.root.to_string_lossy().to_string();
+        if self.is_checkable(_param, root) {
+            let dist_path = self.check_case_sensitive(&_param.file.path, root);
+            if !dist_path.is_empty() {
+                return Err(anyhow!(
+                    "{} does not match the corresponding path on disk [{}]",
+                    _param.file.path.to_string_lossy().to_string(),
+                    dist_path
+                ));
+            }
+        }
+        Ok(None)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use std::path::PathBuf;
+
+    use crate::ast::file::File;
+    use crate::plugin::Plugin;
+    use crate::plugins::case_sensitive::{CaseSensitivePlugin, PluginLoadParam};
+    use crate::utils::test_helper::setup_compiler;
+
+    #[test]
+    fn test_case_sensitive_checker() {
+        let root = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("test/build/case-sensitive");
+        let compiler = setup_compiler("test/build/case-sensitive", false);
+        let plugin = CaseSensitivePlugin::new();
+        let file = &File::new(
+            root.join("Assets/umi-logo.png")
+                .to_string_lossy()
+                .to_string(),
+            compiler.context.clone(),
+        );
+        let result = plugin.load(&PluginLoadParam { file }, &compiler.context);
+        assert!(result.is_err());
+    }
+}

crates/mako/test/build/case-sensitive/index.ts

@@ -0,0 +1,2 @@
+import UmiLogo from "./Assets/umi-logo.png";
+console.log(UmiLogo);

crates/mako/test/build/case-sensitive/mako.config.json

@@ -0,0 +1,6 @@
+{
+  "duplicatePackageChecker": {
+    "verbose": true,
+    "showHelp": true
+  }
+}

crates/mako/test/build/case-sensitive/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "test",
+  "version": "1.0.0",
+  "dependencies": {
+    "a": "~1.0.0",
+    "b": "~1.0.0"
+  }
+}