feat: New std translation

仅限于 emmylua_ls.
在启动时会根据翻译文件生成对应语言std目录到文件系统中, 例如
resources/std-zh_CN

Author: xuhuanzy

Cargo.lock

@@ -27,6 +27,8 @@ pub use emmylua_codestyle::*;
 pub use locale::get_locale_code;
 use lsp_types::Uri;
 pub use profile::Profile;
+pub use resources::get_best_resources_dir;
+pub use resources::load_resource_from_include_dir;
 use resources::load_resource_std;
 pub use semantic::*;
 use std::{collections::HashSet, path::PathBuf, sync::Arc};

crates/emmylua_code_analysis/src/lib.rs

@@ -2,10 +2,10 @@ mod best_resource_path;
 
 use std::path::{Path, PathBuf};
 
-use best_resource_path::get_best_resources_dir;
+pub use best_resource_path::get_best_resources_dir;
 use include_dir::{Dir, DirEntry, include_dir};
 
-use crate::{LuaFileInfo, load_workspace_files};
+use crate::{LuaFileInfo, get_locale_code, load_workspace_files};
 
 static RESOURCE_DIR: Dir = include_dir!("$CARGO_MANIFEST_DIR/resources");
 const VERSION: &str = env!("CARGO_PKG_VERSION");
@@ -14,13 +14,15 @@ pub fn load_resource_std(
     create_resources_dir: Option<String>,
     is_jit: bool,
 ) -> (PathBuf, Vec<LuaFileInfo>) {
+    // 指定了输出的资源目录, 目前只有 lsp 会指定
     if let Some(create_resources_dir) = create_resources_dir {
         let resource_path = if create_resources_dir.is_empty() {
             get_best_resources_dir()
         } else {
             PathBuf::from(&create_resources_dir)
         };
-        let std_dir = PathBuf::from(&resource_path).join("std");
+        // 此时会存在 i18n, 我们需要根据当前语言环境切换到对应语言的 std 目录
+        let std_dir = get_std_dir(&resource_path);
         let result = load_resource_from_file_system(&resource_path);
         if let Some(mut files) = result {
             if !is_jit {
@@ -29,7 +31,7 @@ pub fn load_resource_std(
             return (std_dir, files);
         }
     }
-
+    // 没有指定资源目录, 那么直接使用默认的资源目录, 此时不会存在 i18n
     let resoucres_dir = get_best_resources_dir();
     let std_dir = resoucres_dir.join("std");
     let files = load_resource_from_include_dir();
@@ -60,19 +62,20 @@ pub fn load_resource_std(
 fn remove_jit_resource(files: &mut Vec<LuaFileInfo>) {
     files.retain(|file| {
         let path = Path::new(&file.path);
-        let should_remove = path.ends_with("std/jit.lua")
-            || path.ends_with("std/jit/profile.lua")
-            || path.ends_with("std/jit/util.lua")
-            || path.ends_with("std/string/buffer.lua")
-            || path.ends_with("std/table/clear.lua")
-            || path.ends_with("std/table/new.lua")
-            || path.ends_with("std/ffi.lua");
+        let should_remove = path.ends_with("jit.lua")
+            || path.ends_with("jit/profile.lua")
+            || path.ends_with("jit/util.lua")
+            || path.ends_with("string/buffer.lua")
+            || path.ends_with("table/clear.lua")
+            || path.ends_with("table/new.lua")
+            || path.ends_with("ffi.lua");
 
         !should_remove
     });
 }
 
 fn load_resource_from_file_system(resources_dir: &Path) -> Option<Vec<LuaFileInfo>> {
+    // lsp i18n 的资源在更早之前的 crates\emmylua_ls\src\handlers\initialized\std_i18n.rs 中写入到文件系统
     if check_need_dump_to_file_system() {
         log::info!("Creating resources dir: {:?}", resources_dir);
         let files = load_resource_from_include_dir();
@@ -109,7 +112,7 @@ fn load_resource_from_file_system(resources_dir: &Path) -> Option<Vec<LuaFileInf
         }
     }
 
-    let std_dir = resources_dir.join("std");
+    let std_dir = get_std_dir(&resources_dir);
     let match_pattern = vec!["**/*.lua".to_string()];
     let files = match load_workspace_files(&std_dir, &match_pattern, &Vec::new(), &Vec::new(), None)
     {
@@ -146,7 +149,7 @@ fn check_need_dump_to_file_system() -> bool {
     false
 }
 
-fn load_resource_from_include_dir() -> Vec<LuaFileInfo> {
+pub fn load_resource_from_include_dir() -> Vec<LuaFileInfo> {
     let mut files = Vec::new();
     walk_resource_dir(&RESOURCE_DIR, &mut files);
     files
@@ -170,3 +173,11 @@ fn walk_resource_dir(dir: &Dir, files: &mut Vec<LuaFileInfo>) {
         }
     }
 }
+
+// 优先使用当前语言环境的 std-{locale} 目录, 否则回退到默认的 std 目录
+fn get_std_dir(resources_dir: &Path) -> PathBuf {
+    let locale = get_locale_code(&rust_i18n::locale());
+    Some(resources_dir.join(format!("std-{locale}")))
+        .filter(|p| locale != "en" && p.exists())
+        .unwrap_or_else(|| resources_dir.join("std"))
+}

crates/emmylua_code_analysis/src/resources/mod.rs

@@ -40,6 +40,7 @@ itertools.workspace = true
 dirs.workspace = true
 wax.workspace = true
 internment.workspace = true
+include_dir.workspace = true
 
 [dependencies.clap]
 workspace = true

crates/emmylua_ls/Cargo.toml

@@ -2,6 +2,7 @@ mod client_config;
 mod codestyle;
 mod collect_files;
 mod locale;
+mod std_i18n;
 
 use std::{path::PathBuf, sync::Arc};
 
@@ -12,7 +13,9 @@ use crate::{
         WorkspaceFileMatcher, WorkspaceFolder, get_client_id, load_emmy_config,
     },
     handlers::{
-        initialized::collect_files::calculate_include_and_exclude,
+        initialized::{
+            collect_files::calculate_include_and_exclude, std_i18n::try_generate_translated_std,
+        },
         text_document::register_files_watch,
     },
     logger::init_logger,
@@ -246,6 +249,7 @@ pub async fn init_std_lib(
     if cmd_args.load_stdlib.0 {
         // double update config
         analysis.update_config(emmyrc);
+        try_generate_translated_std();
         analysis.init_std_lib(cmd_args.resources_path.0.clone());
     }