Be more tolerant of babel parse errors (#230)

Closes #219
Closes #222 

This change makes our babel parsing and node traversal more tolerant of
errors, matching the settings and behavior of Prettier itself. Now,
rather than this plugin causing an error and failing to format the file,
it will continue to attempt to sort imports. It may still fail on
invalid code, but in those cases prettier itself would as well, so we
shouldn't end up in a case where prettier runs but imports aren't
sorted, or where prettier would have run as long as this plugin wasn't
being used.

I chose not to emit a warning when invalid syntax is encountered, again
matching the behavior or prettier. I don't think it's the responsibility
of a import sorting plugin to alert the user to invalid syntax, since it
may be intentional and handled later-on in their build pipeline (for
instance, Astro files allow returning from the top-level).

Author: IanVS

src/preprocessors/preprocessor.ts

@@ -14,6 +14,11 @@ export function preprocessor(code: string, options: PrettierOptions): string {
     const parserOptions: ParserOptions = {
         sourceType: 'module',
         attachComment: true,
+        errorRecovery: true,
+        allowReturnOutsideFunction: true,
+        allowNewTargetOutsideFunction: true,
+        allowSuperOutsideMethod: true,
+        allowUndeclaredExports: true,
         plugins,
     };
 
@@ -22,11 +27,6 @@ export function preprocessor(code: string, options: PrettierOptions): string {
         return code;
     }
 
-    // Astro component scripts allow returning a response
-    if (options.parentParser === 'astro') {
-        parserOptions.allowReturnOutsideFunction = true;
-    }
-
     let ast: ReturnType<typeof babelParser>;
     try {
         ast = babelParser(code, parserOptions);
@@ -43,10 +43,12 @@ export function preprocessor(code: string, options: PrettierOptions): string {
 
     const allOriginalImportNodes: ImportDeclaration[] = [];
     traverse(ast, {
+        noScope: true, // This is required in order to avoid traverse errors if a variable is redefined (https://github.com/babel/babel/issues/12950#issuecomment-788974837)
         ImportDeclaration(path: NodePath<ImportDeclaration>) {
             const tsModuleParent = path.findParent((p) =>
                 isTSModuleDeclaration(p.node),
             );
+            // Do not sort imports inside of typescript module declarations.  See `import-inside-ts-declare.ts` test.
             if (!tsModuleParent) {
                 allOriginalImportNodes.push(path.node);
             }

tests/InvalidSyntax/__snapshots__/ppsi.spec.ts.snap

@@ -0,0 +1,61 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`invalidSet.ts - typescript-verify > invalidSet.ts 1`] = `
+import b from './b';
+import a from './a';
+
+const c = {set name(){}}
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+import a from "./a";
+import b from "./b";
+
+const c = { set name() {} };
+
+`;
+
+exports[`redeclare.js - typescript-verify > redeclare.js 1`] = `
+import b from './b';
+import a from './a';
+
+// Here's an invalid example of redeclaring a variable
+let   name    =     "error"   ;
+let name = "error";
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+import a from "./a";
+import b from "./b";
+
+// Here's an invalid example of redeclaring a variable
+let name = "error";
+let name = "error";
+
+`;
+
+exports[`returnOutsideFunction.ts - typescript-verify > returnOutsideFunction.ts 1`] = `
+import b from './b';
+import a from './a';
+
+// Can't return outside of a function
+return 123;
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+import a from "./a";
+import b from "./b";
+
+// Can't return outside of a function
+return 123;
+
+`;
+
+exports[`superOutsideMethod.ts - typescript-verify > superOutsideMethod.ts 1`] = `
+import b from './b';
+import a from './a';
+
+function F() { super(); }
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+import a from "./a";
+import b from "./b";
+
+function F() {
+    super();
+}
+
+`;

tests/InvalidSyntax/invalidSet.ts

@@ -0,0 +1,4 @@
+import b from './b';
+import a from './a';
+
+const c = {set name(){}}

tests/InvalidSyntax/ppsi.spec.ts

@@ -0,0 +1,6 @@
+import { run_spec } from '../../test-setup/run_spec';
+
+run_spec(__dirname, ['typescript'], {
+    importOrder: ['^@core/(.*)$', '^@server/(.*)', '^@ui/(.*)$', '^[./]'],
+    importOrderParserPlugins : ['typescript'],
+});

tests/InvalidSyntax/redeclare.js

@@ -0,0 +1,6 @@
+import b from './b';
+import a from './a';
+
+// Here's an invalid example of redeclaring a variable
+let   name    =     "error"   ;
+let name = "error";

tests/InvalidSyntax/returnOutsideFunction.ts

@@ -0,0 +1,5 @@
+import b from './b';
+import a from './a';
+
+// Can't return outside of a function
+return 123;

tests/InvalidSyntax/superOutsideMethod.ts

@@ -0,0 +1,4 @@
+import b from './b';
+import a from './a';
+
+function F() { super(); }