refactor: optimize runtime multiple line string literal (#12381)

LingyuCoder · web-flow · commit 730b2bd30d25 · 2025-12-08T10:45:20.000+08:00
refactor: optimize RuntimeTemplate API usage across plugins
diff --git a/crates/rspack_core/src/chunk_graph/mod.rs b/crates/rspack_core/src/chunk_graph/mod.rs
@@ -103,7 +103,14 @@ impl ChunkGraph {
 
       let table_body = requests.clone();
 
-      format!("\n<<table bgcolor=\"{bg_color}\">\n{table_header}\n{table_body}\n</table>>\n")
+      format!(
+        r#"
+<<table bgcolor="{bg_color}">
+{table_header}
+{table_body}
+</table>>
+"#
+      )
     };
 
     // push entry_point chunk group into visiting queue
diff --git a/crates/rspack_core/src/runtime_template.rs b/crates/rspack_core/src/runtime_template.rs
@@ -423,9 +423,17 @@ impl RuntimeTemplate {
       .environment
       .supports_arrow_function()
     {
-      format!("({args}) => {{\n{body}\n}}")
+      format!(
+        r#"({args}) => {{
+{body}
+}}"#
+      )
     } else {
-      format!("function({args}) {{\n{body}\n}}")
+      format!(
+        r#"function({args}) {{
+{body}
+}}"#
+      )
     }
   }
 
@@ -883,7 +891,9 @@ impl RuntimeTemplate {
     let header = if weak {
       runtime_requirements.insert(RuntimeGlobals::MODULE_FACTORIES);
       Some(format!(
-        "if(!{}[{module_id_expr}]) {{\n {} \n}}",
+        r#"if(!{}[{module_id_expr}]) {{
+ {} 
+}}"#,
         self.render_runtime_globals(&RuntimeGlobals::MODULE_FACTORIES),
         self.weak_error(request)
       ))
@@ -928,7 +938,10 @@ impl RuntimeTemplate {
         ) {
           if let Some(header) = header {
             appending = format!(
-              ".then(function() {{\n {header}\nreturn {}\n}})",
+              r#".then(function() {{
+ {header}
+return {}
+}})"#,
               self.module_raw(compilation, runtime_requirements, dep_id, request, weak)
             )
           } else {
@@ -941,7 +954,9 @@ impl RuntimeTemplate {
           }
           appending.push_str(
             format!(
-              ".then(function(m){{\n return {}(m, {fake_type}) \n}})",
+              r#".then(function(m){{
+ return {}(m, {fake_type}) 
+}})"#,
               self.render_runtime_globals(&RuntimeGlobals::CREATE_FAKE_NAMESPACE_OBJECT)
             )
             .as_str(),
@@ -953,7 +968,11 @@ impl RuntimeTemplate {
               "{}({module_id_expr}, {fake_type}))",
               self.render_runtime_globals(&RuntimeGlobals::CREATE_FAKE_NAMESPACE_OBJECT)
             );
-            appending = format!(".then(function() {{\n {header} return {expr};\n}})");
+            appending = format!(
+              r#".then(function() {{
+ {header} return {expr};
+}})"#
+            );
           } else {
             runtime_requirements.insert(RuntimeGlobals::REQUIRE);
             appending = format!(
diff --git a/crates/rspack_plugin_banner/src/lib.rs b/crates/rspack_plugin_banner/src/lib.rs
@@ -94,7 +94,11 @@ fn wrap_comment(str: &str) -> String {
   let result = TRIALING_WHITESPACE.replace_all(&result, "\n");
   let result = result.trim_end();
 
-  format!("/*!\n * {result}\n */")
+  format!(
+    r#"/*!
+ * {result}
+ */"#
+  )
 }
 
 #[plugin]
diff --git a/crates/rspack_plugin_devtool/src/eval_source_map_dev_tool_plugin.rs b/crates/rspack_plugin_devtool/src/eval_source_map_dev_tool_plugin.rs
@@ -221,7 +221,10 @@ async fn eval_source_map_devtool_plugin_render_module_content(
         .unwrap_or_else(|e| panic!("{}", e.to_string()));
       let base64 = base64::encode_to_string(&map_buffer);
       let footer = format!(
-        "\n//# sourceMappingURL=data:application/json;charset=utf-8;base64,{base64}\n//# sourceURL=webpack-internal:///{module_id}\n"
+        r#"
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,{base64}
+//# sourceURL=webpack-internal:///{module_id}
+"#
       );
       let module_content =
         simd_json::to_string(&format!("{{{source}{footer}\n}}")).expect("should convert to string");
diff --git a/crates/rspack_plugin_esm_library/src/dependency/dyn_import.rs b/crates/rspack_plugin_esm_library/src/dependency/dyn_import.rs
@@ -86,7 +86,9 @@ fn then_expr(
         );
         appending.push_str(
           format!(
-            ".then(function(m){{\n return {}(m, {fake_type}) \n}})",
+            r#".then(function(m){{
+ return {}(m, {fake_type}) 
+}})"#,
             compilation
               .runtime_template
               .render_runtime_globals(&RuntimeGlobals::CREATE_FAKE_NAMESPACE_OBJECT)
diff --git a/crates/rspack_plugin_esm_library/src/link.rs b/crates/rspack_plugin_esm_library/src/link.rs
@@ -380,7 +380,11 @@ impl EsmLibraryPlugin {
           namespace_object_sources.insert(
             *module_info_id,
             format!(
-              "// NAMESPACE OBJECT: {}\nvar {} = {{}};\n{}({});\n{}\n",
+              r#"// NAMESPACE OBJECT: {}
+var {} = {{}};
+{}({});
+{}
+"#,
               module_readable_identifier,
               name,
               compilation
diff --git a/crates/rspack_plugin_esm_library/src/render.rs b/crates/rspack_plugin_esm_library/src/render.rs
@@ -232,7 +232,9 @@ impl EsmLibraryPlugin {
         ChunkGraph::get_tree_runtime_requirements(compilation, chunk_ukey);
       if tree_runtime_requirements.contains(RuntimeGlobals::MODULE_FACTORIES) {
         runtime_source.add(RawStringSource::from(format!(
-          "\nvar {} = {{}};\n",
+          r#"
+var {} = {{}};
+"#,
           compilation
             .runtime_template
             .render_runtime_variable(&RuntimeVariable::Modules)
@@ -681,7 +683,9 @@ impl EsmLibraryPlugin {
 
     if use_require || module_cache {
       source.add(RawStringSource::from(format!(
-        "// The module cache\nvar {} = {{}};\n",
+        r#"// The module cache
+var {} = {{}};
+"#,
         compilation
           .runtime_template
           .render_runtime_variable(&RuntimeVariable::ModuleCache)
@@ -690,18 +694,26 @@ impl EsmLibraryPlugin {
 
     if use_require {
       source.add(RawStringSource::from(format!(
-        "// The require function\nfunction {}(moduleId) {{\n",
+        r#"// The require function
+function {}(moduleId) {{
+"#,
         compilation
           .runtime_template
           .render_runtime_globals(&RuntimeGlobals::REQUIRE)
       )));
       source.add(RawStringSource::from(
         JsPlugin::render_require(chunk_ukey, compilation).join("\n"),
       ));
-      source.add(RawStringSource::from_static("\n}\n"));
+      source.add(RawStringSource::from_static(
+        r#"
+}
+"#,
+      ));
     } else if require_scope_used {
       source.add(RawStringSource::from(format!(
-        "// The require scope\nvar {} = {{}};\n",
+        r#"// The require scope
+var {} = {{}};
+"#,
         compilation
           .runtime_template
           .render_runtime_globals(&RuntimeGlobals::REQUIRE)
@@ -710,7 +722,9 @@ impl EsmLibraryPlugin {
 
     if module_factories {
       source.add(RawStringSource::from(format!(
-        "// expose the modules object ({modules})\n{module_factories} = {modules};\n",
+        r#"// expose the modules object ({modules})
+{module_factories} = {modules};
+"#,
         module_factories = compilation
           .runtime_template
           .render_runtime_globals(&RuntimeGlobals::MODULE_FACTORIES),
@@ -722,7 +736,9 @@ impl EsmLibraryPlugin {
 
     if runtime_requirements.contains(RuntimeGlobals::MODULE_CACHE) {
       source.add(RawStringSource::from(format!(
-        "// expose the module cache\n{} = {};\n",
+        r#"// expose the module cache
+{} = {};
+"#,
         compilation
           .runtime_template
           .render_runtime_globals(&RuntimeGlobals::MODULE_CACHE),
@@ -734,7 +750,9 @@ impl EsmLibraryPlugin {
 
     if intercept_module_execution {
       source.add(RawStringSource::from(format!(
-        "// expose the module execution interceptor\n{} = [];\n",
+        r#"// expose the module execution interceptor
+{} = [];
+"#,
         compilation
           .runtime_template
           .render_runtime_globals(&RuntimeGlobals::INTERCEPT_MODULE_EXECUTION)
diff --git a/crates/rspack_plugin_extract_css/src/plugin.rs b/crates/rspack_plugin_extract_css/src/plugin.rs
@@ -394,7 +394,10 @@ despite it was not able to fulfill desired ordering with these modules:
         let req_str = readable_identifier.cow_replace("*/", "*_/");
         let req_str_star = "*".repeat(req_str.len());
         RawStringSource::from(format!(
-          "/*!****{req_str_star}****!*\\\n  !*** {req_str} ***!\n  \\****{req_str_star}****/\n"
+          r#"/*!****{req_str_star}****!*\
+  !*** {req_str} ***!
+  \****{req_str_star}****/
+"#
         ))
       });
 
diff --git a/crates/rspack_plugin_javascript/src/dependency/esm/esm_export_imported_specifier_dependency.rs b/crates/rspack_plugin_javascript/src/dependency/esm/esm_export_imported_specifier_dependency.rs
@@ -812,7 +812,9 @@ impl ESMExportImportedSpecifierDependency {
         ctxt.init_fragments.push(
           NormalInitFragment::new(
             format!(
-              "{content}\n/* reexport */ {}({}, __rspack_reexport);\n",
+              r#"{content}
+/* reexport */ {}({}, __rspack_reexport);
+"#,
               compilation
                 .runtime_template
                 .render_runtime_globals(&RuntimeGlobals::DEFINE_PROPERTY_GETTERS),
diff --git a/crates/rspack_plugin_javascript/src/plugin/mod.rs b/crates/rspack_plugin_javascript/src/plugin/mod.rs
@@ -302,7 +302,9 @@ var module = ({}[moduleId] = {{"#,
     if use_require || module_cache {
       header.push(
         format!(
-          "// The module cache\nvar {} = {{}};\n",
+          r#"// The module cache
+var {} = {{}};
+"#,
           runtime_template.render_runtime_variable(&RuntimeVariable::ModuleCache)
         )
         .into(),
@@ -314,23 +316,37 @@ var module = ({}[moduleId] = {{"#,
       // (see MakeDeferredNamespaceObjectRuntimeModule)
       // This requires all deferred imports to a module can get the module export object before the module
       // is evaluated.
-      header.push("// The deferred module cache\nvar __rspack_deferred_exports = {};\n".into());
+      header.push(
+        r#"// The deferred module cache
+var __rspack_deferred_exports = {};
+"#
+        .into(),
+      );
     }
 
     if use_require {
       header.push(
         format!(
-          "// The require function\nfunction {}(moduleId) {{\n",
+          r#"// The require function
+function {}(moduleId) {{
+"#,
           runtime_template.render_runtime_globals(&RuntimeGlobals::REQUIRE)
         )
         .into(),
       );
       header.extend(Self::render_require(chunk_ukey, compilation));
-      header.push("\n}\n".into());
+      header.push(
+        r#"
+}
+"#
+        .into(),
+      );
     } else if require_scope_used {
       header.push(
         format!(
-          "// The require scope\nvar {} = {{}};\n",
+          r#"// The require scope
+var {} = {{}};
+"#,
           runtime_template.render_runtime_globals(&RuntimeGlobals::REQUIRE)
         )
         .into(),
@@ -341,7 +357,9 @@ var module = ({}[moduleId] = {{"#,
     {
       header.push(
         format!(
-          "// expose the modules object ({modules})\n{module_factories} = {modules};\n",
+          r#"// expose the modules object ({modules})
+{module_factories} = {modules};
+"#,
           modules = runtime_template.render_runtime_variable(&RuntimeVariable::Modules),
           module_factories =
             runtime_template.render_runtime_globals(&RuntimeGlobals::MODULE_FACTORIES)
@@ -353,7 +371,9 @@ var module = ({}[moduleId] = {{"#,
     if runtime_requirements.contains(RuntimeGlobals::MODULE_CACHE) {
       header.push(
         format!(
-          "// expose the module cache\n{} = {};\n",
+          r#"// expose the module cache
+{} = {};
+"#,
           runtime_template.render_runtime_globals(&RuntimeGlobals::MODULE_CACHE),
           runtime_template.render_runtime_variable(&RuntimeVariable::ModuleCache),
         )
@@ -364,7 +384,9 @@ var module = ({}[moduleId] = {{"#,
     if intercept_module_execution {
       header.push(
         format!(
-          "// expose the module execution interceptor\n{} = [];\n",
+          r#"// expose the module execution interceptor
+{} = [];
+"#,
           runtime_template.render_runtime_globals(&RuntimeGlobals::INTERCEPT_MODULE_EXECUTION)
         )
         .into(),
@@ -581,7 +603,9 @@ var module = ({}[moduleId] = {{"#,
           allow_inline_startup = false;
           header.push(
             format!(
-              "// the startup function\n{} = {};\n",
+              r#"// the startup function
+{} = {};
+"#,
               runtime_template.render_runtime_globals(&RuntimeGlobals::STARTUP),
               compilation.runtime_template.basic_function(
                 "",
@@ -610,7 +634,9 @@ var module = ({}[moduleId] = {{"#,
       } else if runtime_requirements.contains(RuntimeGlobals::STARTUP) {
         header.push(
           format!(
-            "// the startup function\n// It's empty as no entry modules are in this chunk\n{} = function(){{}};",
+            r#"// the startup function
+// It's empty as no entry modules are in this chunk
+{} = function(){{}};"#,
             runtime_template.render_runtime_globals(&RuntimeGlobals::STARTUP)
           )
           .into(),
@@ -619,7 +645,9 @@ var module = ({}[moduleId] = {{"#,
     } else if runtime_requirements.contains(RuntimeGlobals::STARTUP) {
       header.push(
         format!(
-          "// the startup function\n// It's empty as some runtime module handles the default behavior\n{} = function(){{}};",
+          r#"// the startup function
+// It's empty as some runtime module handles the default behavior
+{} = function(){{}};"#,
           runtime_template.render_runtime_globals(&RuntimeGlobals::STARTUP)
         )
         .into(),
diff --git a/crates/rspack_plugin_library/src/system_library_plugin.rs b/crates/rspack_plugin_library/src/system_library_plugin.rs
@@ -146,7 +146,10 @@ async fn render(
     .iter()
     .map(|name| {
       format!(
-        "function(module) {{\n\tObject.keys(module).forEach(function(key) {{\n {name}[key] = module[key]; }})\n}}"
+        r#"function(module) {{
+	Object.keys(module).forEach(function(key) {{
+ {name}[key] = module[key]; }})
+}}"#
       )
     })
     .collect::<Vec<_>>()
diff --git a/crates/rspack_plugin_module_info_header/src/lib.rs b/crates/rspack_plugin_module_info_header/src/lib.rs
@@ -158,7 +158,13 @@ impl ModuleInfoHeaderPlugin {
 
     let req_stars_str = "*".repeat(req.len());
 
-    format!("\n/*!****{req_stars_str}****!*\\\n  !*** {req} ***!\n  \\****{req_stars_str}****/\n")
+    format!(
+      r#"
+/*!****{req_stars_str}****!*\
+  !*** {req} ***!
+  \****{req_stars_str}****/
+"#
+    )
   }
 }
 
diff --git a/crates/rspack_plugin_runtime/src/common_js_chunk_format.rs b/crates/rspack_plugin_runtime/src/common_js_chunk_format.rs
@@ -135,7 +135,9 @@ async fn render_chunk(
   if chunk.has_entry_module(&compilation.chunk_graph) {
     let runtime_chunk_output_name = get_runtime_chunk_output_name(compilation, chunk_ukey).await?;
     sources.add(RawStringSource::from(format!(
-      "// load runtime\nvar {} = require({});\n",
+      r#"// load runtime
+var {} = require({});
+"#,
       compilation
         .runtime_template
         .render_runtime_globals(&RuntimeGlobals::REQUIRE),
diff --git a/crates/rspack_plugin_runtime/src/runtime_module/export_require.rs b/crates/rspack_plugin_runtime/src/runtime_module/export_require.rs
diff --git a/crates/rspack_plugin_sri/src/runtime.rs b/crates/rspack_plugin_sri/src/runtime.rs
