fix(error): fix PackageSpecError docs and help not printing

orogene · Apr 18, 2023 · f8e8e27 · f8e8e27
1 parent e66936c
commit f8e8e27
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/crates/nassun/src/error.rs b/crates/nassun/src/error.rs
@@ -19,6 +19,7 @@ pub enum NassunError {
 
     /// Something went wrong while trying to parse a PackageArg
     #[error(transparent)]
+    #[diagnostic(transparent)]
     PackageSpecError(#[from] oro_package_spec::PackageSpecError),
 
     #[error("{0}")]

diff --git a/crates/oro-package-spec/src/error.rs b/crates/oro-package-spec/src/error.rs
@@ -4,11 +4,16 @@ use nom::error::{ContextError, ErrorKind, FromExternalError, ParseError};
 use thiserror::Error;
 use url::ParseError as UrlParseError;
 
+/// An invalid package specifier was provided.
+///
+/// The syntax for package specifiers is documented here:
+/// https://orogene.dev/book/guide/node_modules.html#specifier-syntax
 #[derive(Debug, Error, Diagnostic)]
 #[error("Error parsing package spec. {kind}")]
 #[diagnostic(
     code(package_spec::no_parse),
-    help("Please fix your spec. Go look up wherever they're documented idk.")
+    url(docsrs),
+    help("The syntax for package specifiers is documented here: https://orogene.dev/book/guide/node_modules.html#specifier-syntax")
 )]
 pub struct PackageSpecError {
     pub input: String,