feat: more elegant error

crates/binding/src/lib.rs

@@ -21,7 +21,7 @@ pub async fn transform_node(
   match transform(code, config, state) {
     Ok(result) => napi::bindgen_prelude::Result::Ok(result),
     Err(reason) => {
-      napi::bindgen_prelude::Result::Err(napi::bindgen_prelude::Error::from_reason(reason))
+      napi::bindgen_prelude::Result::Err(napi::bindgen_prelude::Error::from_reason(reason.to_string()))
     }
   }
 }

crates/core/Cargo.toml

@@ -30,6 +30,7 @@ swc_core = { version = "0.74.2", features = [
   "ecma_codegen",
   "__parser",
 ] }
+thiserror = "1.0.56"
 linked-hash-map = { version = "0.5.6", features = ["serde_impl"] }
 linked_hash_set = "0.1.4"
 

crates/core/src/error.rs

@@ -0,0 +1,11 @@
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum SvgrError {
+  #[error("failed to parse SVG: {0}")]
+  Parse(String),
+  #[error("this is invalid SVG")]
+  InvalidSvg,
+  #[error("invalid configuration option: {0}")]
+  Configuration(String),
+}

crates/core/src/lib.rs

@@ -17,6 +17,7 @@ use swc_core::{
 use swc_xml::parser::parse_file_as_document;
 
 mod add_jsx_attribute;
+mod error;
 mod core;
 mod hast_to_swc_ast;
 mod remove_jsx_attribute;
@@ -28,6 +29,7 @@ mod transform_svg_component;
 
 pub use self::core::config::{Config, ExpandProps, ExportType, Icon, JSXRuntime, JSXRuntimeImport};
 pub use self::core::state::{Caller, Config as State};
+pub use error::SvgrError;
 
 /// Transform SVG into React components.
 ///
@@ -50,18 +52,19 @@ pub use self::core::state::{Caller, Config as State};
 ///   Default::default(),
 /// );
 /// ```
-pub fn transform(code: String, config: Config, state: State) -> Result<String, String> {
+pub fn transform(code: String, config: Config, state: State) -> Result<String, SvgrError> {
   let state = core::state::expand_state(&state);
 
   let cm = Arc::<SourceMap>::default();
   let fm = cm.new_source_file(FileName::Anon, code);
 
   let mut errors = vec![];
-  let document = parse_file_as_document(fm.borrow(), Default::default(), &mut errors).unwrap();
+  let document = parse_file_as_document(fm.borrow(), Default::default(), &mut errors)
+    .map_err(|e| SvgrError::Parse(e.message().to_string()))?;
 
   let jsx_element = hast_to_swc_ast::to_swc_ast(document);
   if jsx_element.is_none() {
-    return Err("This is invalid SVG".to_string());
+    return Err(SvgrError::InvalidSvg);
   }
   let jsx_element = jsx_element.unwrap();
 

crates/core/src/transform_svg_component/mod.rs

@@ -1,6 +1,6 @@
 use swc_core::{common::DUMMY_SP, ecma::ast::*};
 
-use crate::core;
+use crate::{core, SvgrError};
 
 mod variables;
 
@@ -71,7 +71,7 @@ pub fn transform(
   jsx_element: JSXElement,
   config: &core::config::Config,
   state: &core::state::InternalConfig,
-) -> Result<Module, String> {
+) -> Result<Module, SvgrError> {
   let variables_options = get_variables_options(config);
 
   let variables = variables::get_variables(variables_options, state, jsx_element)?;

crates/core/src/transform_svg_component/variables.rs

@@ -6,6 +6,8 @@ use swc_core::{
   ecma::{ast::*, parser},
 };
 
+use crate::SvgrError;
+
 use super::core;
 
 pub struct TemplateVariables {
@@ -58,7 +60,7 @@ pub fn get_variables(
   opts: Options,
   state: &core::state::InternalConfig,
   jsx: JSXElement,
-) -> Result<TemplateVariables, String> {
+) -> Result<TemplateVariables, SvgrError> {
   let mut interfaces = vec![];
   let mut props = vec![];
   let mut imports = vec![];
@@ -313,7 +315,7 @@ pub fn get_variables(
         }
       }
     } else {
-      return Err(r#""namedExport" not specified"#.to_string());
+      return Err(SvgrError::Configuration(r#""namedExport" not specified"#.to_string()));
     }
   }
 
@@ -336,7 +338,7 @@ pub fn get_variables(
   })
 }
 
-fn get_jsx_runtime_import(cfg: &core::config::JSXRuntimeImport) -> Result<ModuleItem, String> {
+fn get_jsx_runtime_import(cfg: &core::config::JSXRuntimeImport) -> Result<ModuleItem, SvgrError> {
   let specifiers = get_jsx_runtime_import_specifiers(cfg)?;
 
   Ok(ModuleItem::ModuleDecl(ModuleDecl::Import(ImportDecl {
@@ -354,7 +356,7 @@ fn get_jsx_runtime_import(cfg: &core::config::JSXRuntimeImport) -> Result<Module
 
 fn get_jsx_runtime_import_specifiers(
   cfg: &core::config::JSXRuntimeImport,
-) -> Result<Vec<ImportSpecifier>, String> {
+) -> Result<Vec<ImportSpecifier>, SvgrError> {
   if let Some(namespace) = cfg.namespace.clone() {
     let specifier = ImportSpecifier::Namespace(ImportStarAsSpecifier {
       span: DUMMY_SP,
@@ -397,8 +399,8 @@ fn get_jsx_runtime_import_specifiers(
   }
 
   Err(
-    r#"Specify "namespace", "defaultSpecifier", or "specifiers" in "jsxRuntimeImport" option"#
-      .to_string(),
+    SvgrError::Configuration(r#"Specify "namespace", "defaultSpecifier", or "specifiers" in "jsxRuntimeImport" option"#
+    .to_string())
   )
 }