Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support case sensitive #1714

Merged
merged 24 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions crates/mako/src/compiler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}),
Expand Down
1 change: 1 addition & 0 deletions crates/mako/src/plugins.rs
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
127 changes: 127 additions & 0 deletions crates/mako/src/plugins/case_sensitive.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
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;
if !_param.file.path.starts_with(root) {
return false;

Check warning on line 26 in crates/mako/src/plugins/case_sensitive.rs

View check run for this annotation

Codecov / codecov/patch

crates/mako/src/plugins/case_sensitive.rs#L26

Added line #L26 was not covered by tests
}
let path_components = file_path.iter();
for component in path_components {
if component.to_string_lossy() == "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_or_else(|e| e.into_inner());
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();

Check warning on line 50 in crates/mako/src/plugins/case_sensitive.rs

View check run for this annotation

Codecov / codecov/patch

crates/mako/src/plugins/case_sensitive.rs#L50

Added line #L50 was not covered by tests
} 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 {

Check warning on line 83 in crates/mako/src/plugins/case_sensitive.rs

View check run for this annotation

Codecov / codecov/patch

crates/mako/src/plugins/case_sensitive.rs#L83

Added line #L83 was not covered by tests
"case_sensitive_plugin"
}

Check warning on line 85 in crates/mako/src/plugins/case_sensitive.rs

View check run for this annotation

Codecov / codecov/patch

crates/mako/src/plugins/case_sensitive.rs#L85

Added line #L85 was not covered by tests

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());
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions crates/mako/test/build/case-sensitive/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import UmiLogo from "./Assets/umi-logo.png";
console.log(UmiLogo);
6 changes: 6 additions & 0 deletions crates/mako/test/build/case-sensitive/mako.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"duplicatePackageChecker": {
"verbose": true,
"showHelp": true
}
}
8 changes: 8 additions & 0 deletions crates/mako/test/build/case-sensitive/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "test",
"version": "1.0.0",
"dependencies": {
"a": "~1.0.0",
"b": "~1.0.0"
}
}
Loading