fix(config): prevent ERR_UNSUPPORTED_ESM_URL_SCHEME on Windows

Closes #327
Closes #328

Co-authored-by: Tyler Butler <tyler@tylerbutler.com>

Author: JamieMason

.github/workflows/ci.yaml

@@ -69,7 +69,5 @@ jobs:
         run: just check-clippy
       - name: Cargo test
         run: just test
-      # - name: Test issue 327
-      #   run: just test-js-config-loading
       - name: Test issue 311 and 319
         run: just test-glob-matching

justfile

@@ -156,16 +156,6 @@ serve-coverage:
 test:
     cargo test -- --nocapture --color=always
 
-test-js-config-loading:
-    #!/usr/bin/env bash
-    set -euo pipefail
-    cargo build
-    PROJECT_ROOT=$(pwd)
-
-    echo "JS/TS Config should be read without errors"
-    cd "$PROJECT_ROOT/fixtures/js-config-loading"
-    ../../target/debug/syncpack list
-
 test-glob-matching:
     #!/usr/bin/env bash
     set -euo pipefail

src/rcfile/javascript.rs

@@ -1,5 +1,9 @@
 use {serde::Deserialize, std::path::Path};
 
+#[cfg(test)]
+#[path = "javascript_test.rs"]
+mod tests;
+
 /// The JSON returned to Rust from JavaScript when evaluating a config file
 #[derive(Debug, Deserialize)]
 #[serde(tag = "_tag")]
@@ -16,10 +20,10 @@ pub enum JsResult {
 }
 
 pub fn get_javascript_contents(file_path: &Path) -> String {
-  let escaped_file_path = file_path.to_string_lossy().replace('\\', "\\\\");
+  let escaped_file_path = file_path.to_string_lossy().replace('\\', "\\\\").replace('\'', "\\'");
   format!(
     r#"
-    import('{escaped_file_path}')
+    import(require('node:url').pathToFileURL('{escaped_file_path}').href)
       .then(findConfig)
       .then((value) => {{
         if (isNonEmptyObject(value)) {{

src/rcfile/javascript_test.rs

@@ -0,0 +1,26 @@
+use {super::get_javascript_contents, std::path::Path};
+
+#[test]
+fn import_uses_path_to_file_url() {
+  let script = get_javascript_contents(Path::new("/home/jamie/syncpack.config.cjs"));
+  assert!(script.contains("import(require('node:url').pathToFileURL("));
+}
+
+#[test]
+fn require_uses_raw_path() {
+  let script = get_javascript_contents(Path::new("/home/jamie/syncpack.config.cjs"));
+  assert!(script.contains("require('/home/jamie/syncpack.config.cjs')"));
+}
+
+#[test]
+fn escapes_windows_backslashes() {
+  let script = get_javascript_contents(Path::new(r"C:\Users\jamie\syncpack.config.cjs"));
+  assert!(script.contains(r"C:\\Users\\jamie\\syncpack.config.cjs"));
+  assert!(!script.contains(r"'C:\Users"));
+}
+
+#[test]
+fn escapes_single_quotes() {
+  let script = get_javascript_contents(Path::new("/home/jamie's projects/syncpack.config.cjs"));
+  assert!(script.contains(r"/home/jamie\'s projects/syncpack.config.cjs"));
+}

tests/js_config_loading_test.rs

@@ -0,0 +1,27 @@
+use std::{path::PathBuf, process::Command};
+
+fn fixture_dir() -> PathBuf {
+  PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("fixtures/js-config-loading")
+}
+
+fn run_syncpack(args: &[&str]) -> (String, String, i32) {
+  let output = Command::new(env!("CARGO_BIN_EXE_syncpack"))
+    .args(args)
+    .current_dir(fixture_dir())
+    .output()
+    .expect("failed to run syncpack");
+  let stdout = String::from_utf8(output.stdout).unwrap();
+  let stderr = String::from_utf8(output.stderr).unwrap();
+  let code = output.status.code().unwrap_or(1);
+  (stdout, stderr, code)
+}
+
+#[test]
+fn loads_cjs_config_without_error() {
+  let (_stdout, stderr, code) = run_syncpack(&["list"]);
+  assert_eq!(code, 0, "syncpack list exited {code}\nstderr:\n{stderr}");
+  assert!(
+    !stderr.contains("ERR_UNSUPPORTED_ESM_URL_SCHEME"),
+    "regression of issue #327:\n{stderr}"
+  );
+}