add remedation instructions to the error message

clerk · Dec 16, 2024 · 8790167 · 8790167
1 parent 9de3e49
commit 8790167
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/packages/shared/src/__tests__/keys.test.ts b/packages/shared/src/__tests__/keys.test.ts
@@ -59,7 +59,9 @@ describe('parsePublishableKey(key)', () => {
   });
 
   it('throws an error if the publishable key is missing, when fatal: true', () => {
-    expect(() => parsePublishableKey(undefined, { fatal: true })).toThrowError('Publishable key is missing.');
+    expect(() => parsePublishableKey(undefined, { fatal: true })).toThrowError(
+      'Publishable key is missing. Ensure that your publishable key is correctly configured. Make sure to double-check your environment configuration (.env file).',
+    );
   });
 
   it('applies the proxyUrl if provided', () => {

diff --git a/packages/shared/src/keys.ts b/packages/shared/src/keys.ts
@@ -40,7 +40,9 @@ export function parsePublishableKey(
 
   if (!key || !isPublishableKey(key)) {
     if (options.fatal && !key) {
-      throw new Error('Publishable key is missing.');
+      throw new Error(
+        'Publishable key is missing. Ensure that your publishable key is correctly configured. Make sure to double-check your environment configuration (.env file).',
+      );
     }
     if (options.fatal && !isPublishableKey(key)) {
       throw new Error('Publishable key not valid.');