style: improve spdx license error (#750)

prefix-dev · Apr 2, 2024 · 31f3a8d · 31f3a8d
1 parent 5dda526
commit 31f3a8d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/src/recipe/error.rs b/src/recipe/error.rs
@@ -240,7 +240,15 @@ impl fmt::Display for ErrorKind {
             ErrorKind::UrlParsing(err) => write!(f, "failed to parse URL: {}", err),
             ErrorKind::IntegerParsing(err) => write!(f, "failed to parse integer: {}", err),
             ErrorKind::SpdxParsing(err) => {
-                write!(f, "failed to parse SPDX license: {}", err.reason)
+                writeln!(f, "failed to parse SPDX license: {}", err.reason)?;
+                writeln!(
+                    f,
+                    "See <https://spdx.org/licenses> for the list of valid licenses."
+                )?;
+                write!(
+                    f,
+                    "Use 'LicenseRef-<MyLicense>' if you are using a custom license."
+                )
             }
             ErrorKind::MatchSpecParsing(err) => {
                 write!(f, "failed to parse match spec: {}", err)

diff --git a/src/recipe/parser/snapshots/rattler_build__recipe__parser__about__test__invalid_license.snap b/src/recipe/parser/snapshots/rattler_build__recipe__parser__about__test__invalid_license.snap
@@ -5,11 +5,12 @@ expression: err
   × Failed to parse recipe
 
 Error:   × Parsing: failed to parse SPDX license: invalid character(s)
+  │ See <https://spdx.org/licenses> for the list of valid licenses.
+  │ Use 'LicenseRef-<MyLicense>' if you are using a custom license.
    ╭─[7:22]
  6 │         about:
  7 │             license: MIT/X derivate
    ·                      ───────┬──────
    ·                             ╰── here
  8 │         
    ╰────
-