fixes #15

oscartbeaumont · Apr 24, 2023 · e7bbbbf · e7bbbbf
1 parent 3663b46
commit e7bbbbf
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 16 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -22,7 +22,7 @@ javascript = []
 typescript = ["specta/typescript"]
 
 [dependencies]
-specta = { version = "1.0.0", features = ["functions", "tauri"] }
+specta = { version = "1.0.3", features = ["functions", "tauri"] }
 serde = "1.0.152"
 serde_json = "1.0.93"
 tauri = "1.2.4"

diff --git a/example/src-tauri/Cargo.toml b/example/src-tauri/Cargo.toml
@@ -14,7 +14,7 @@ tauri-build = { version = "1.2.1", features = [] }
 
 [dependencies]
 serde_json = "1.0"
-specta = "1.0.0"
+specta = "1.0.3"
 serde = { version = "1.0", features = ["derive"] }
 tauri = { version = "1.2.4", features = ["api-all"] }
 tauri-specta = { path = "../../", features = ["typescript", "javascript"] }

diff --git a/example/src-tauri/src/main.rs b/example/src-tauri/src/main.rs
@@ -61,6 +61,15 @@ fn main() {
  )
  .unwrap();
 
+ // This is useful for custom eslint, prettier overrides at the top of the file.
+ // ts::export_with_cfg_with_header(
+ // collect_types![hello_world, goodbye_world, nested::some_struct].unwrap(),
+ // Default::default(),
+ // "../src/bindings2.ts",
+ // "// My custom header\n".into(),
+ // )
+ // .unwrap();
+
  tauri::Builder::default()
  .invoke_handler(tauri::generate_handler![
  hello_world,

diff --git a/src/js.rs b/src/js.rs
@@ -1,10 +1,13 @@
 use specta::{functions::FunctionDataType, ts::TsExportError, ExportError, TypeDefs};
 use std::{
+ borrow::Cow,
  fs::{self, File},
  io::Write,
  path::{Path, PathBuf},
 };
 
+use crate::CRINGE_ESLINT_DISABLE;
+
 /// Building blocks for [`export`] and [`export_with_cfg`].
 ///
 /// These are made available for advanced use cases where you may combine Tauri Specta with another
@@ -13,14 +16,12 @@ pub mod internal {
  use heck::ToLowerCamelCase;
  use indoc::formatdoc;
 
+ use crate::DO_NOT_EDIT;
  use specta::{
  functions::FunctionDataType,
  ts::{self, TsExportError},
  };
 
- const DO_NOT_EDIT: &str = "/* eslint-disable */
-// This file was generated by [tauri-specta](https://github.com/oscartbeaumont/tauri-specta). Do not edit this file manually.";
-
  /// Constants that the generated functions rely on
  pub fn globals() -> String {
  formatdoc! {
@@ -113,9 +114,26 @@ pub mod internal {
 /// Exports the output of [`internal::render`] for a collection of [`FunctionDataType`] into a JavaScript file.
 /// Allows for specifying a custom [`ExportConfiguration`](specta::ts::ExportConfiguration).
 pub fn export_with_cfg(
+ result: (Vec<FunctionDataType>, TypeDefs),
+ export_path: impl AsRef<Path>,
+ cfg: specta::ts::ExportConfiguration,
+) -> Result<(), TsExportError> {
+ export_with_cfg_with_header(
+ result,
+ export_path,
+ cfg,
+ Cow::Borrowed(CRINGE_ESLINT_DISABLE), // TODO: Remove this as a default. SemVer moment.
+ )
+}
+
+// TODO: On next major release merge this with `export_with_cfg`
+/// Exports the output of [`internal::render`] for a collection of [`FunctionDataType`] into a JavaScript file.
+/// Allows for specifying a custom [`ExportConfiguration`](specta::ts::ExportConfiguration).
+pub fn export_with_cfg_with_header(
  (function_types, _): (Vec<FunctionDataType>, TypeDefs),
  export_path: impl AsRef<Path>,
  cfg: specta::ts::ExportConfiguration,
+ header: Cow<'static, str>,
 ) -> Result<(), TsExportError> {
  let export_path = PathBuf::from(export_path.as_ref());
 
@@ -125,7 +143,7 @@ pub fn export_with_cfg(
 
  let mut file = File::create(export_path)?;
 
- write!(file, "{}", internal::render(function_types, &cfg)?)?;
+ write!(file, "{header}{}", internal::render(function_types, &cfg)?)?;
 
  Ok(())
 }
@@ -135,5 +153,10 @@ pub fn export(
  macro_data: Result<(Vec<FunctionDataType>, TypeDefs), ExportError>,
  export_path: impl AsRef<Path>,
 ) -> Result<(), TsExportError> {
- export_with_cfg(macro_data?, export_path, Default::default())
+ export_with_cfg_with_header(
+ macro_data?,
+ export_path,
+ Default::default(),
+ Cow::Borrowed(CRINGE_ESLINT_DISABLE), // TODO: Remove this as a default. SemVer moment.
+ )
 }
diff --git a/src/lib.rs b/src/lib.rs
@@ -116,6 +116,11 @@ macro_rules! collate_types {
  }};
 }
 
+pub(crate) const DO_NOT_EDIT: &str = "// This file was generated by [tauri-specta](https://github.com/oscartbeaumont/tauri-specta). Do not edit this file manually.";
+
+pub(crate) const CRINGE_ESLINT_DISABLE: &str = "/* eslint-disable */
+";
+
 // TODO
 // #[cfg(doctest)]
 // doc_comment::doctest!("../README.md");
diff --git a/src/ts.rs b/src/ts.rs
@@ -1,11 +1,14 @@
 use std::{
+ borrow::Cow,
  fs::{self, File},
  io::Write,
  path::{Path, PathBuf},
 };
 
 use specta::{functions::FunctionDataType, ts::TsExportError, ExportError, TypeDefs};
 
+use crate::CRINGE_ESLINT_DISABLE;
+
 /// Building blocks for [`export`] and [`export_with_cfg`].
 ///
 /// These are made available for advanced use cases where you may combine Tauri Specta with another
@@ -14,15 +17,13 @@ pub mod internal {
  use heck::ToLowerCamelCase;
  use indoc::formatdoc;
 
+ use crate::DO_NOT_EDIT;
  use specta::{
  functions::FunctionDataType,
  ts::{self, TsExportError},
  TypeDefs,
  };
 
- const DO_NOT_EDIT: &str = "/* eslint-disable */
-// This file was generated by [tauri-specta](https://github.com/oscartbeaumont/tauri-specta). Do not edit this file manually.";
-
  /// Type definitions and constants that the generated functions rely on
  pub fn globals() -> String {
  formatdoc! {
@@ -118,9 +119,25 @@ pub mod internal {
 /// Exports the output of [`internal::render`] for a collection of [`FunctionDataType`] into a TypeScript file.
 /// Allows for specifying a custom [`ExportConfiguration`](specta::ts::ExportConfiguration).
 pub fn export_with_cfg(
+ result: (Vec<FunctionDataType>, TypeDefs),
+ cfg: specta::ts::ExportConfiguration,
+ export_path: impl AsRef<Path>,
+) -> Result<(), TsExportError> {
+ export_with_cfg_with_header(
+ result,
+ cfg,
+ export_path,
+ Cow::Borrowed(CRINGE_ESLINT_DISABLE), // TODO: Remove this as a default. SemVer moment.
+ )
+}
+
+/// Exports the output of [`internal::render`] for a collection of [`FunctionDataType`] into a TypeScript file.
+/// Allows for specifying a custom [`ExportConfiguration`](specta::ts::ExportConfiguration).
+pub fn export_with_cfg_with_header(
  (function_types, type_map): (Vec<FunctionDataType>, TypeDefs),
  cfg: specta::ts::ExportConfiguration,
  export_path: impl AsRef<Path>,
+ header: Cow<'static, str>,
 ) -> Result<(), TsExportError> {
  let export_path = PathBuf::from(export_path.as_ref());
 
@@ -132,7 +149,7 @@ pub fn export_with_cfg(
 
  write!(
  file,
- "{}",
+ "{header}{}",
  internal::render(function_types, type_map, &cfg)?
  )?;
 
@@ -144,5 +161,10 @@ pub fn export(
  macro_data: Result<(Vec<FunctionDataType>, TypeDefs), ExportError>,
  export_path: impl AsRef<Path>,
 ) -> Result<(), TsExportError> {
- export_with_cfg(macro_data?, Default::default(), export_path)
+ export_with_cfg_with_header(
+ macro_data?,
+ Default::default(),
+ export_path,
+ Cow::Borrowed(CRINGE_ESLINT_DISABLE), // TODO: Remove this as a default. SemVer moment.
+ )
 }