feat(relay): Support multi-project mode (#318)

packages/relay/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @swc/plugin-relay
 
+## 2.0.9
+
+### Patch Changes
+
+- be5f997: Support multi-project mode
+
 ## 2.0.8
 
 ### Patch Changes

packages/relay/README.md

@@ -28,6 +28,22 @@ module.exports = {
             eagerEsModules: true,
           },
         ],
+        // Or if you want to use multiple projects
+        [
+          "@swc/plugin-relay",
+          {
+            projects: [
+              {
+                rootDir: path.resolve(__dirname, '../project1'),
+              },
+              {
+                rootDir: path.resolve(__dirname, '../project2'),
+              }
+            ],
+            language: "typescript",
+            eagerEsModules: true,
+          },
+        ],
       ],
     },
     parser: {
@@ -88,6 +104,12 @@ In this example typescript graphql files will output transpiled import path of `
 
 # @swc/plugin-relay
 
+## 2.0.9
+
+### Patch Changes
+
+- be5f997: Support multi-project mode
+
 ## 2.0.8
 
 ### Patch Changes

packages/relay/README.md.tmpl

@@ -28,6 +28,22 @@ module.exports = {
             eagerEsModules: true,
           },
         ],
+        // Or if you want to use multiple projects
+        [
+          "@swc/plugin-relay",
+          {
+            projects: [
+              {
+                rootDir: path.resolve(__dirname, '../project1'),
+              },
+              {
+                rootDir: path.resolve(__dirname, '../project2'),
+              }
+            ],
+            language: "typescript",
+            eagerEsModules: true,
+          },
+        ],
       ],
     },
     parser: {

packages/relay/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swc/plugin-relay",
-  "version": "2.0.8",
+  "version": "2.0.9",
   "description": "SWC plugin for relay",
   "main": "swc_plugin_relay.wasm",
   "types": "./types.d.ts",

packages/relay/src/lib.rs

@@ -6,7 +6,7 @@ use swc_core::{
     ecma::{ast::Program, visit::FoldWith},
     plugin::{plugin_transform, proxies::TransformPluginProgramMetadata},
 };
-use swc_relay::{relay, Config, OutputFileExtension, RelayLanguageConfig};
+use swc_relay::{relay, Config, OutputFileExtension, ProjectConfig, RelayLanguageConfig};
 
 #[derive(Deserialize)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
@@ -16,6 +16,9 @@ struct WasmConfig {
     #[serde(default)]
     artifact_directory: Option<PathBuf>,
 
+    #[serde(default)]
+    projects: Vec<ProjectConfig>,
+
     #[serde(default)]
     language: RelayLanguageConfig,
 
@@ -50,14 +53,15 @@ fn relay_plugin_transform(program: Program, metadata: TransformPluginProgramMeta
     let root_dir = plugin_config.root_dir;
 
     let config = Config {
+        projects: plugin_config.projects,
         artifact_directory: plugin_config.artifact_directory,
         language: plugin_config.language,
         eager_es_modules: plugin_config.eager_es_modules,
         output_file_extension: plugin_config.output_file_extension,
     };
 
     let mut relay = relay(
-        &config,
+        config,
         filename,
         root_dir,
         None,

packages/relay/transform/Cargo.toml

@@ -11,7 +11,7 @@ homepage     = { workspace = true }
 license      = { workspace = true }
 repository   = { workspace = true }
 rust-version = { workspace = true }
-version      = "0.44.16"
+version      = "0.44.17"
 
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

packages/relay/transform/src/lib.rs

@@ -98,27 +98,41 @@ impl RelayImport {
     }
 }
 
-struct Relay<'a> {
+struct Relay {
     root_dir: PathBuf,
     pages_dir: Option<PathBuf>,
     file_name: FileName,
-    config: &'a Config,
+    config: Config,
     imports: Vec<RelayImport>,
     unresolved_mark: Option<Mark>,
 }
 
 #[derive(Deserialize, Debug, Default, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct Config {
+    #[serde(default)]
+    pub projects: Vec<ProjectConfig>,
+
+    #[serde(default)]
     pub artifact_directory: Option<PathBuf>,
+
     #[serde(default)]
     pub language: RelayLanguageConfig,
+
     #[serde(default)]
     pub eager_es_modules: bool,
     #[serde(default)]
     pub output_file_extension: OutputFileExtension,
 }
 
+#[derive(Deserialize, Debug, Default, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct ProjectConfig {
+    pub root_dir: PathBuf,
+    #[serde(default)]
+    pub artifact_directory: Option<PathBuf>,
+}
+
 fn pull_first_operation_name_from_tpl(tpl: &TaggedTpl) -> Option<String> {
     tpl.tpl.quasis.iter().find_map(|quasis| {
         static OPERATION_REGEX: Lazy<Regex> =
@@ -148,7 +162,7 @@ fn build_require_expr_from_path(path: &str, mark: Option<Mark>) -> Expr {
     })
 }
 
-impl<'a> Fold for Relay<'a> {
+impl Fold for Relay {
     fn fold_expr(&mut self, expr: Expr) -> Expr {
         let expr = expr.fold_children_with(self);
 
@@ -190,7 +204,7 @@ enum BuildRequirePathError {
     ArtifactDirectoryExpected { file_name: String },
 }
 
-impl<'a> Relay<'a> {
+impl Relay {
     fn path_for_artifact(
         &self,
         real_file_name: &Path,
@@ -206,6 +220,19 @@ impl<'a> Relay<'a> {
             },
         };
 
+        if !self.config.projects.is_empty() {
+            for project in &self.config.projects {
+                if real_file_name.starts_with(&project.root_dir) {
+                    return Ok(project
+                        .artifact_directory
+                        .as_deref()
+                        .unwrap_or_else(|| &self.root_dir)
+                        .join("__generated__")
+                        .join(filename));
+                }
+            }
+        }
+
         if let Some(artifact_directory) = &self.config.artifact_directory {
             Ok(self.root_dir.join(artifact_directory).join(filename))
         } else if self
@@ -303,12 +330,12 @@ impl<'a> Relay<'a> {
 }
 
 pub fn relay(
-    config: &Config,
+    config: Config,
     file_name: FileName,
     root_dir: PathBuf,
     pages_dir: Option<PathBuf>,
     unresolved_mark: Option<Mark>,
-) -> impl Fold + '_ {
+) -> impl Fold {
     Relay {
         root_dir,
         file_name,

packages/relay/transform/tests/fixture.rs

@@ -1,8 +1,8 @@
-use std::path::PathBuf;
+use std::path::{Path, PathBuf};
 
 use swc_common::FileName;
 use swc_ecma_transforms_testing::test_fixture;
-use swc_relay::{relay, Config, OutputFileExtension, RelayLanguageConfig};
+use swc_relay::{relay, Config, OutputFileExtension, ProjectConfig, RelayLanguageConfig};
 
 #[testing::fixture("tests/fixture/simple/**/input.js")]
 fn fixture(input: PathBuf) {
@@ -12,7 +12,8 @@ fn fixture(input: PathBuf) {
         Default::default(),
         &|_| {
             relay(
-                &Config {
+                Config {
+                    projects: Default::default(),
                     artifact_directory: None,
                     language: RelayLanguageConfig::TypeScript,
                     eager_es_modules: false,
@@ -38,7 +39,8 @@ fn fixture_es_modules(input: PathBuf) {
         Default::default(),
         &|_| {
             relay(
-                &Config {
+                Config {
+                    projects: Default::default(),
                     artifact_directory: None,
                     language: RelayLanguageConfig::TypeScript,
                     eager_es_modules: true,
@@ -64,7 +66,8 @@ fn fixture_output_file_extension_javascript(input: PathBuf) {
         Default::default(),
         &|_| {
             relay(
-                &Config {
+                Config {
+                    projects: Default::default(),
                     artifact_directory: None,
                     language: RelayLanguageConfig::TypeScript,
                     eager_es_modules: true,
@@ -90,7 +93,8 @@ fn fixture_output_file_extension_typescript(input: PathBuf) {
         Default::default(),
         &|_| {
             relay(
-                &Config {
+                Config {
+                    projects: Default::default(),
                     artifact_directory: None,
                     language: RelayLanguageConfig::JavaScript,
                     eager_es_modules: true,
@@ -107,3 +111,50 @@ fn fixture_output_file_extension_typescript(input: PathBuf) {
         Default::default(),
     );
 }
+
+#[testing::fixture("tests/fixture/multi-projects/**/input.js")]
+fn fixture_multi_projects(input: PathBuf) {
+    let output = input.parent().unwrap().join("output.js");
+
+    test_fixture(
+        Default::default(),
+        &|_| {
+            relay(
+                Config {
+                    projects: vec![
+                        ProjectConfig {
+                            root_dir: Path::new(".")
+                                .canonicalize()
+                                .unwrap()
+                                .join("tests/fixture/multi-projects/project1"),
+                            artifact_directory: Some(
+                                Path::new(".")
+                                    .canonicalize()
+                                    .unwrap()
+                                    .join("tests/projects1"),
+                            ),
+                        },
+                        ProjectConfig {
+                            root_dir: Path::new(".")
+                                .canonicalize()
+                                .unwrap()
+                                .join("tests/fixture/multi-projects/project2"),
+                            ..Default::default()
+                        },
+                    ],
+                    artifact_directory: None,
+                    language: RelayLanguageConfig::JavaScript,
+                    eager_es_modules: true,
+                    output_file_extension: OutputFileExtension::TypeScript,
+                },
+                FileName::Real(input.clone()),
+                Default::default(),
+                None,
+                None,
+            )
+        },
+        &input,
+        &output,
+        Default::default(),
+    );
+}

packages/relay/transform/tests/fixture/multi-projects/project1/should work/input.js

@@ -0,0 +1,5 @@
+graphql`
+  fragment Foo on Bar {
+    id
+  }
+`;

packages/relay/transform/tests/fixture/multi-projects/project1/should work/output.js

@@ -0,0 +1,2 @@
+import __Foo from "$DIR/tests/projects1/__generated__/Foo.graphql.ts";
+__Foo;

packages/relay/transform/tests/fixture/multi-projects/project2/should work/input.js

@@ -0,0 +1,5 @@
+graphql`
+  fragment Foo on Bar {
+    id
+  }
+`;

packages/relay/transform/tests/fixture/multi-projects/project2/should work/output.js

@@ -0,0 +1,2 @@
+import __Foo from "__generated__/Foo.graphql.ts";
+__Foo;