CLI initial concept

.github/workflows/test.yml

@@ -14,12 +14,12 @@ jobs:
       - name: dependencies e2e test
         working-directory: e2e/dependencies/consumer
         run: |
-          cargo t 
+          cargo t --features ts-rs/export
           tsc bindings/* --noEmit --noUnusedLocals --strict
       - name: dependencies e2e test with default export env
         working-directory: e2e/dependencies/consumer
         run: |
-          TS_RS_EXPORT_DIR=custom-bindings cargo t 
+          TS_RS_EXPORT_DIR=custom-bindings cargo t --features ts-rs/export
           shopt -s globstar
           tsc custom-bindings/**/*.ts --noEmit --noUnusedLocals --strict
   e2e-workspace:
@@ -35,14 +35,14 @@ jobs:
       - name: workspace e2e test
         working-directory: e2e/workspace
         run: |
-          cargo t 
+          cargo t --features ts-rs/export
           shopt -s globstar
           tsc parent/bindings/**/*.ts --noEmit --noUnusedLocals --strict
           rm -rf parent/bindings
       - name: workspace e2e with default export env
         working-directory: e2e/workspace
         run: |
-          TS_RS_EXPORT_DIR=custom-bindings cargo t 
+          TS_RS_EXPORT_DIR=custom-bindings cargo t --features ts-rs/export
           shopt -s globstar
           tsc parent/custom-bindings/**/*.ts --noEmit --noUnusedLocals --strict
           rm -rf parent/custom-bindings
@@ -59,12 +59,12 @@ jobs:
       - name: example e2e test
         working-directory: example
         run: |
-          cargo t 
+          cargo t --features ts-rs/export
           tsc bindings/* --noEmit
       - name: example e2e with default export env
         working-directory: example
         run: |
-          TS_RS_EXPORT_DIR=custom-bindings cargo t 
+          TS_RS_EXPORT_DIR=custom-bindings cargo t --features ts-rs/export
           shopt -s globstar
           tsc custom-bindings/**/*.ts --noEmit --noUnusedLocals --strict
 
@@ -113,7 +113,7 @@ jobs:
       - uses: Swatinem/rust-cache@v2
       - name: Test
         run: |
-          TS_RS_EXPORT_DIR=output cargo test --no-default-features
+          TS_RS_EXPORT_DIR=output cargo test --no-default-features --features ts-rs/export
           shopt -s globstar
           tsc ts-rs/output/**/*.ts --noEmit --noUnusedLocals --strict
           rm -rf ts-rs/output
@@ -130,7 +130,7 @@ jobs:
       - uses: Swatinem/rust-cache@v2
       - name: Test
         run: |
-          cargo test --no-default-features
+          cargo test --no-default-features --features ts-rs/export
           shopt -s globstar
           tsc ts-rs/bindings/**/*.ts --noEmit --noUnusedLocals
           rm -rf ts-rs/bindings

Cargo.toml

@@ -1,3 +1,3 @@
 [workspace]
-members = ["macros", "ts-rs", "example"]
+members = ["macros", "ts-rs", "example", "cli"]
 resolver = "2"

cli/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "cargo-ts"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+clap = { version = "4", features = ["derive"]}
+color-eyre = "0.6"

cli/src/main.rs

@@ -0,0 +1,94 @@
+use std::{io::Write, path::PathBuf};
+
+use clap::Parser;
+use color_eyre::Result;
+
+mod path;
+
+#[derive(Parser, Debug)]
+struct Args {
+    /// Defines where your TS bindings will be saved by setting TS_RS_EXPORT_DIR
+    #[arg(long, short, default_value = "./bindings")]
+    output_directory: PathBuf,
+
+    /// Disables warnings caused by using serde attributes that ts-rs cannot process
+    #[arg(long)]
+    no_warnings: bool,
+
+    /// Adds the ".js" extension to import paths
+    #[arg(long)]
+    esm_imports: bool,
+
+    /// Formats the generated TypeScript files
+    #[arg(long)]
+    format: bool,
+
+    #[arg(long = "index")]
+    generate_index_ts: bool,
+}
+
+macro_rules! feature {
+    ($cargo_invocation: expr, $args: expr, { $($field: ident => $feature: literal),* $(,)? }) => {
+        $(
+            if $args.$field {
+                $cargo_invocation
+                    .arg("--features")
+                    .arg(format!("ts-rs/{}", $feature));
+            }
+        )*
+    };
+}
+
+fn main() -> Result<()> {
+    color_eyre::install()?;
+
+    let args = Args::parse();
+
+    let mut cargo_invocation = std::process::Command::new("cargo");
+
+    let metadata_path = args.output_directory.join("ts_rs.meta");
+    if metadata_path.exists() {
+        std::fs::remove_file(&metadata_path)?;
+    }
+
+    cargo_invocation
+        .arg("test")
+        .arg("export_bindings_")
+        .arg("--features")
+        .arg("ts-rs/export")
+        .env("TS_RS_EXPORT_DIR", path::absolute(&args.output_directory)?);
+
+    feature!(cargo_invocation, args, {
+        no_warnings => "no-serde-warnings",
+        esm_imports => "import-esm",
+        format => "format",
+    });
+
+    cargo_invocation.spawn()?.wait()?;
+
+    if args.generate_index_ts {
+        let metadata = std::fs::read_to_string(&metadata_path)?
+            .lines()
+            .map(ToOwned::to_owned)
+            .collect::<std::collections::HashSet<_>>();
+
+        let index_path = args.output_directory.join("index.ts");
+
+        if index_path.exists() {
+            std::fs::remove_file(&index_path)?;
+        }
+
+        let mut index = std::fs::OpenOptions::new()
+            .create(true)
+            .append(true)
+            .open(index_path)?;
+
+        for file in metadata.iter() {
+            index.write_fmt(format_args!("export * from {file:?};\n"))?;
+        }
+    }
+
+    std::fs::remove_file(&metadata_path)?;
+
+    Ok(())
+}

macros/Cargo.toml

@@ -11,6 +11,7 @@ repository = "https://github.com/Aleph-Alpha/ts-rs"
 [features]
 serde-compat = ["termcolor"]
 no-serde-warnings = []
+export = []
 
 [lib]
 proc-macro = true

macros/src/lib.rs

@@ -35,9 +35,8 @@ struct DerivedTS {
 
 impl DerivedTS {
     fn into_impl(mut self, rust_ty: Ident, generics: Generics) -> TokenStream {
-        let export = self
-            .export
-            .then(|| self.generate_export_test(&rust_ty, &generics));
+        let allow_export = cfg!(feature = "export") && self.export;
+        let export = allow_export.then(|| self.generate_export_test(&rust_ty, &generics));
 
         let output_path_fn = {
             let path = match self.export_to.as_deref() {

ts-rs/Cargo.toml

@@ -34,6 +34,7 @@ semver-impl = ["semver"]
 serde-json-impl = ["serde_json"]
 no-serde-warnings = ["ts-rs-macros/no-serde-warnings"]
 import-esm = []
+export = ["ts-rs-macros/export"]
 
 [dev-dependencies]
 serde = { version = "1.0", features = ["derive"] }

ts-rs/src/export.rs

@@ -135,14 +135,27 @@ pub(crate) fn export_to<T: TS + ?Sized + 'static, P: AsRef<Path>>(
     if let Some(parent) = path.as_ref().parent() {
         std::fs::create_dir_all(parent)?;
     }
+
     let lock = FILE_LOCK.lock().unwrap();
     {
         // Manually write to file & call `sync_data`. Otherwise, calling `fs::read(path)`
         // immediately after `T::export()` might result in an empty file.
         use std::io::Write;
-        let mut file = File::create(path)?;
+        let mut file = File::create(&path)?;
         file.write_all(buffer.as_bytes())?;
         file.sync_data()?;
+
+        let bytes = path::absolute(path.as_ref())?
+            .to_string_lossy()
+            .bytes()
+            .chain([b'\n'])
+            .collect::<Box<[_]>>();
+        std::fs::OpenOptions::new()
+            .read(true)
+            .append(true)
+            .create(true)
+            .open(default_out_dir().join("ts_rs.meta"))?
+            .write_all(&bytes)?;
     }
 
     drop(lock);

ts-rs/tests/path_bug.rs

@@ -2,7 +2,7 @@
 use ts_rs::TS;
 
 #[derive(TS)]
-#[ts(export, export_to = "path_bug/aaa/")]
+#[ts(export_to = "path_bug/aaa/")]
 struct Foo {
     bar: Bar,
 }
@@ -15,7 +15,7 @@ struct Bar {
 
 #[test]
 fn path_bug() {
-    export_bindings_foo();
+    Foo::export_all().unwrap();
 
     assert!(Foo::default_output_path().unwrap().is_file());
     assert!(Bar::default_output_path().unwrap().is_file());