fix: print nice npm error message for npm: specifier as well (#271)

netlify · Dec 20, 2022 · 70071de · 70071de
1 parent a5dca3f
commit 70071de
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/node/bundler.test.ts b/node/bundler.test.ts
@@ -131,7 +131,31 @@ test('Prints a nice error message when user tries importing NPM module', async (
   } catch (error) {
     expect(error).toBeInstanceOf(BundleError)
     expect((error as BundleError).message).toEqual(
-      `It seems like you're trying to import an npm module. This is only supported in Deno via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/p-retry"'?`,
+      `It seems like you're trying to import an npm module. This is only supported via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/p-retry"'?`,
+    )
+  } finally {
+    await cleanup()
+  }
+})
+
+test('Prints a nice error message when user tries importing NPM module with npm: scheme', async () => {
+  expect.assertions(2)
+
+  const { basePath, cleanup, distPath } = await useFixture('imports_npm_module_scheme')
+  const sourceDirectory = join(basePath, 'functions')
+  const declarations = [
+    {
+      function: 'func1',
+      path: '/func1',
+    },
+  ]
+
+  try {
+    await bundle([sourceDirectory], distPath, declarations, { basePath })
+  } catch (error) {
+    expect(error).toBeInstanceOf(BundleError)
+    expect((error as BundleError).message).toEqual(
+      `It seems like you're trying to import an npm module. This is only supported via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/p-retry"'?`,
     )
   } finally {
     await cleanup()

diff --git a/node/npm_import_error.ts b/node/npm_import_error.ts
@@ -1,7 +1,7 @@
 class NPMImportError extends Error {
   constructor(originalError: Error, moduleName: string) {
     super(
-      `It seems like you're trying to import an npm module. This is only supported in Deno via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/${moduleName}"'?`,
+      `It seems like you're trying to import an npm module. This is only supported via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/${moduleName}"'?`,
     )
 
     this.name = 'NPMImportError'
@@ -19,6 +19,12 @@ const wrapNpmImportError = (input: unknown) => {
       const [, moduleName] = match
       return new NPMImportError(input, moduleName)
     }
+
+    const schemeMatch = input.message.match(/Error: Module not found "npm:(.*)"/)
+    if (schemeMatch !== null) {
+      const [, moduleName] = schemeMatch
+      return new NPMImportError(input, moduleName)
+    }
   }
 
   return input

diff --git a/test/fixtures/imports_npm_module_scheme/functions/func1.ts b/test/fixtures/imports_npm_module_scheme/functions/func1.ts
@@ -0,0 +1 @@
+import pRetry from "npm:p-retry"