fix: Prevent parser indexer not letting other addon errors to throw (#…

…242)
storybookjs · Dec 13, 2024 · acd17d1 · acd17d1
1 parent 52910d0
commit acd17d1
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 15 deletions.
diff --git a/src/indexer/index.ts b/src/indexer/index.ts
@@ -9,12 +9,15 @@ import {
 } from '#utils/error/parser/extract/svelte';
 import { LegacyTemplateNotEnabledError } from '#utils/error/legacy-api/index';
 import { NoDestructuredDefineMetaCallError } from '#utils/error/parser/analyse/define-meta';
+import { isStorybookSvelteCSFError } from '#utils/error';
 
 export const createIndexer = (legacyTemplate: boolean): Indexer => ({
   test: /\.svelte$/,
   createIndex: async (filename, { makeTitle }) => {
     try {
-      const { meta, stories } = await parseForIndexer(filename, { legacyTemplate });
+      const { meta, stories } = await parseForIndexer(filename, {
+        legacyTemplate,
+      });
 
       return stories.map((story) => {
         return {
@@ -36,10 +39,15 @@ export const createIndexer = (legacyTemplate: boolean): Indexer => ({
         error instanceof GetDefineMetaFirstArgumentError
       ) {
         const { filename } = error;
-        throw new LegacyTemplateNotEnabledError(filename);
+        throw new LegacyTemplateNotEnabledError(filename, { cause: error });
+      }
+
+      // WARN: We can't use `instanceof StorybookSvelteCSFError`, because is an _abstract_ class
+      if (isStorybookSvelteCSFError(error)) {
+        throw error;
       }
 
-      throw new IndexerParseError();
+      throw new IndexerParseError({ cause: error });
     }
   },
 });
diff --git a/src/utils/error.ts b/src/utils/error.ts
@@ -10,6 +10,7 @@ import type { SvelteAST } from '#parser/ast';
  * and modified for this addon needs.
  */
 export abstract class StorybookSvelteCSFError extends Error {
+  public static isStorybookCSFSvelteError = true;
   public static packageName = pkg.name;
   public static packageVersion = pkg.version;
 
@@ -80,7 +81,7 @@ export abstract class StorybookSvelteCSFError extends Error {
    * Generates the error message along with additional documentation link (if applicable).
    */
   get message() {
-    if(this.customMessage) {
+    if (this.customMessage) {
       return this.customMessage;
     }
 
@@ -115,15 +116,18 @@ export abstract class StorybookSvelteCSFError extends Error {
    */
   readonly component?: SvelteAST.Component;
 
-  constructor({
-    filename,
-    component: component,
-  }: {
-    filename?: StorybookSvelteCSFError['filename'];
-    component?: StorybookSvelteCSFError['component'];
-  }) {
+  constructor(
+    {
+      filename,
+      component: component,
+    }: {
+      filename?: StorybookSvelteCSFError['filename'];
+      component?: StorybookSvelteCSFError['component'];
+    },
+    options?: ConstructorParameters<typeof Error>[1]
+  ) {
     super();
-
+    this.cause = options?.cause;
     this.filename = filename;
     this.component = component;
   }
@@ -178,3 +182,11 @@ export abstract class StorybookSvelteCSFError extends Error {
     return `<Story name="${this.storyNameFromAttribute}" />`;
   }
 }
+
+// WARN: We can't use `instanceof StorybookSvelteCSFError`, because is an _abstract_ class
+export function isStorybookSvelteCSFError(error: unknown): error is StorybookSvelteCSFError {
+  return Boolean(
+    (Object.getPrototypeOf(error)?.constructor as typeof StorybookSvelteCSFError)
+      ?.isStorybookCSFSvelteError
+  );
+}
diff --git a/src/utils/error/legacy-api/index.ts b/src/utils/error/legacy-api/index.ts
@@ -36,8 +36,9 @@ export class LegacyTemplateNotEnabledError extends StorybookSvelteCSFError {
   readonly code = 2;
   public documentation = true;
 
-  constructor(filename?: string) {
+  constructor(filename?: string, options?: ConstructorParameters<typeof Error>[1]) {
     super({ filename });
+    this.cause = options?.cause;
   }
 
   template(): string {

diff --git a/src/utils/error/parser/extract/svelte.ts b/src/utils/error/parser/extract/svelte.ts
@@ -218,8 +218,8 @@ export class IndexerParseError extends StorybookSvelteCSFError {
   readonly code = 9;
   public documentation = true;
 
-  constructor() {
-    super({});
+  constructor(options?: ConstructorParameters<typeof Error>[1]) {
+    super({}, options);
   }
 
   template() {