feat: add parse error details

.changeset/silly-ladybugs-study.md

@@ -0,0 +1,5 @@
+---
+"sh-syntax": patch
+---
+
+feat: add parse error details

.prettierignore

@@ -1 +1,2 @@
+test/fixtures
 vendors

main.go

@@ -69,7 +69,22 @@ func main() {
 
 	file, err := parser.Parse(bytes.NewReader([]byte(*text)), "path")
 	if err != nil {
-		result["error"] = err.Error()
+		error, ok := err.(syntax.ParseError)
+		if ok {
+			result["error"] = map[string]interface{}{
+				"filename":   error.Filename,
+				"incomplete": error.Incomplete,
+				"text":       error.Text,
+				"pos": map[string]interface{}{
+					"col":    error.Col(),
+					"line":   error.Line(),
+					"offset": error.Offset(),
+				},
+				"message": error.Error(),
+			}
+		} else {
+			result["error"] = err.Error()
+		}
 	} else {
 		var buf bytes.Buffer
 		writer := io.Writer(&buf)

src/print.ts

@@ -3,6 +3,41 @@ import { ShOptions } from './types.js'
 
 let id = 0
 
+export class ParseError extends Error {
+  filename: string
+  incomplete: boolean
+  text: string
+  pos: {
+    col: number
+    line: number
+    offset: number
+  }
+
+  constructor({
+    filename,
+    incomplete,
+    text,
+    pos,
+    message,
+  }: {
+    filename: string
+    incomplete: boolean
+    text: string
+    pos: {
+      col: number
+      line: number
+      offset: number
+    }
+    message: string
+  }) {
+    super(message)
+    this.filename = filename
+    this.incomplete = incomplete
+    this.text = text
+    this.pos = pos
+  }
+}
+
 export const getPrinter = (
   getWasmFile: () => BufferSource | Promise<BufferSource>,
 ) => {
@@ -78,7 +113,10 @@ export const getPrinter = (
     delete Go.__shProcessing[uid]
 
     if ('error' in processed) {
-      throw new Error(processed.error)
+      /* istanbul ignore next */
+      throw typeof processed.error === 'string'
+        ? new Error(processed.error)
+        : new ParseError(processed.error)
     }
 
     return processed.text

test/__snapshots__/fixture.spec.ts.snap

@@ -38,6 +38,8 @@ EXPOSE 2015
 "
 `;
 
+exports[`parser and printer should format all fixtures: error.sh 1`] = `[Error: path:1:6: a command can only contain words and redirects; encountered )]`;
+
 exports[`parser and printer should format all fixtures: hosts 1`] = `
 "##
 # Host Database

test/fixture.spec.ts

@@ -15,11 +15,15 @@ describe('parser and printer', () => {
     for (const filepath of await fs.promises.readdir(fixtures)) {
       const input = fs.readFileSync(path.resolve(fixtures, filepath), 'utf8')
 
-      const output = await print(input, {
-        filepath,
-      })
-
-      expect(output).toMatchSnapshot(filepath)
+      try {
+        const output = await print(input, {
+          filepath,
+        })
+        expect(output).toMatchSnapshot(filepath)
+      } catch (err: unknown) {
+        // eslint-disable-next-line jest/no-conditional-expect
+        expect(err).toMatchSnapshot(filepath)
+      }
     }
   })
 })

test/fixtures/error.sh

@@ -0,0 +1 @@
+echo )

vendors/wasm_exec.d.ts

@@ -7,7 +7,22 @@ declare global {
     class Go {
       static __shProcessing: Record<
         number,
-        { error: string } | { text: string }
+        | {
+            error:
+              | string
+              | {
+                  filename: string
+                  incomplete: boolean
+                  text: string
+                  pos: {
+                    col: number
+                    line: number
+                    offset: number
+                  }
+                  message: string
+                }
+          }
+        | { text: string }
       >
 
       _pendingEvent: { id: number }
@@ -23,4 +38,4 @@ declare global {
       run(instance: WebAssembly.Instance): Promise<void>
     }
   }
-}
+}