Merge branch 'main' into improve-types

Author: ota-meshi

Diff for: CHANGELOG.md

@@ -1,5 +1,17 @@
 # svelte-eslint-parser
 
+## 0.24.0
+
+### Minor Changes
+
+- [#292](https://github.com/ota-meshi/svelte-eslint-parser/pull/292) [`ec061f5`](https://github.com/ota-meshi/svelte-eslint-parser/commit/ec061f574d73aa25c13a631bb3be6fa2f861e8e8) Thanks [@ota-meshi](https://github.com/ota-meshi)! - BREAKING: fix resolve to module scope for top level statements
+
+  This change corrects the result of `context.getScope()`, but it is a breaking change.
+
+- [#294](https://github.com/ota-meshi/svelte-eslint-parser/pull/294) [`14d6e95`](https://github.com/ota-meshi/svelte-eslint-parser/commit/14d6e95773ea638855c25927c11f7a2df1632801) Thanks [@ota-meshi](https://github.com/ota-meshi)! - feat: add peerDependenciesMeta to package.json
+
+- [#295](https://github.com/ota-meshi/svelte-eslint-parser/pull/295) [`924cd3e`](https://github.com/ota-meshi/svelte-eslint-parser/commit/924cd3e72db0d9d09aed1da5ec3f2e5995c9ca77) Thanks [@ota-meshi](https://github.com/ota-meshi)! - feat: export name property
+
 ## 0.23.0
 
 ### Minor Changes

Diff for: package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-eslint-parser",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Svelte parser for ESLint",
   "repository": "git+https://github.com/ota-meshi/svelte-eslint-parser.git",
   "homepage": "https://github.com/ota-meshi/svelte-eslint-parser#readme",
@@ -45,6 +45,11 @@
   "peerDependencies": {
     "svelte": "^3.37.0"
   },
+  "peerDependenciesMeta": {
+    "svelte": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "eslint-scope": "^7.0.0",
     "eslint-visitor-keys": "^3.0.0",
@@ -63,7 +68,7 @@
     "@types/node": "^18.11.0",
     "@types/semver": "^7.3.9",
     "@typescript-eslint/eslint-plugin": "^5.4.0",
-    "@typescript-eslint/parser": "~5.54.0",
+    "@typescript-eslint/parser": "~5.55.0",
     "benchmark": "^2.1.4",
     "chai": "^4.3.4",
     "esbuild": "^0.17.0",

Diff for: src/context/script-let.ts

@@ -59,6 +59,7 @@ type ScriptLetRestoreCallbackOption = {
   registerNodeToScope: (node: any, scope: Scope) => void;
   scopeManager: ScopeManager;
   visitorKeys?: { [type: string]: string[] };
+  addPostProcess: (callback: () => void) => void;
 };
 
 /**
@@ -131,6 +132,8 @@ export class ScriptLetContext {
 
   private readonly restoreCallbacks: RestoreCallback[] = [];
 
+  private readonly programRestoreCallbacks: ScriptLetRestoreCallback[] = [];
+
   private readonly closeScopeCallbacks: (() => void)[] = [];
 
   private readonly unique = new UniqueIdGenerator();
@@ -593,6 +596,10 @@ export class ScriptLetContext {
     this.closeScopeCallbacks.pop()!();
   }
 
+  public addProgramRestore(callback: ScriptLetRestoreCallback): void {
+    this.programRestoreCallbacks.push(callback);
+  }
+
   private appendScript(
     text: string,
     offset: number,
@@ -650,6 +657,57 @@ export class ScriptLetContext {
    * Restore AST nodes
    */
   public restore(result: ESLintExtendedProgram): void {
+    const nodeToScope = getNodeToScope(result.scopeManager!);
+    const postprocessList: (() => void)[] = [];
+
+    const callbackOption: ScriptLetRestoreCallbackOption = {
+      getScope,
+      getInnermostScope,
+      registerNodeToScope,
+      scopeManager: result.scopeManager!,
+      visitorKeys: result.visitorKeys,
+      addPostProcess: (cb) => postprocessList.push(cb),
+    };
+
+    this.restoreNodes(result, callbackOption);
+    this.restoreProgram(result, callbackOption);
+    postprocessList.forEach((p) => p());
+
+    // Helpers
+    /** Get scope */
+    function getScope(node: ESTree.Node) {
+      return getScopeFromNode(result.scopeManager!, node);
+    }
+
+    /** Get innermost scope */
+    function getInnermostScope(node: ESTree.Node) {
+      return getInnermostScopeFromNode(result.scopeManager!, node);
+    }
+
+    /** Register node to scope */
+    function registerNodeToScope(node: any, scope: Scope): void {
+      // If we replace the `scope.block` at this time,
+      // the scope restore calculation will not work, so we will replace the `scope.block` later.
+      postprocessList.push(() => {
+        scope.block = node;
+      });
+
+      const scopes = nodeToScope.get(node);
+      if (scopes) {
+        scopes.push(scope);
+      } else {
+        nodeToScope.set(node, [scope]);
+      }
+    }
+  }
+
+  /**
+   * Restore AST nodes
+   */
+  private restoreNodes(
+    result: ESLintExtendedProgram,
+    callbackOption: ScriptLetRestoreCallbackOption
+  ): void {
     let orderedRestoreCallback = this.restoreCallbacks.shift();
     if (!orderedRestoreCallback) {
       return;
@@ -659,8 +717,6 @@ export class ScriptLetContext {
     const processedTokens = [];
     const comments = result.ast.comments;
     const processedComments = [];
-    const nodeToScope = getNodeToScope(result.scopeManager!);
-    const postprocessList: (() => void)[] = [];
 
     let tok;
     while ((tok = tokens.shift())) {
@@ -750,13 +806,12 @@ export class ScriptLetContext {
           startIndex.comment,
           endIndex.comment - startIndex.comment
         );
-        restoreCallback.callback(node, targetTokens, targetComments, {
-          getScope,
-          getInnermostScope,
-          registerNodeToScope,
-          scopeManager: result.scopeManager!,
-          visitorKeys: result.visitorKeys,
-        });
+        restoreCallback.callback(
+          node,
+          targetTokens,
+          targetComments,
+          callbackOption
+        );
 
         processedTokens.push(...targetTokens);
         processedComments.push(...targetComments);
@@ -769,33 +824,22 @@ export class ScriptLetContext {
 
     result.ast.tokens = processedTokens;
     result.ast.comments = processedComments;
-    postprocessList.forEach((p) => p());
-
-    // Helpers
-    /** Get scope */
-    function getScope(node: ESTree.Node) {
-      return getScopeFromNode(result.scopeManager!, node);
-    }
-
-    /** Get innermost scope */
-    function getInnermostScope(node: ESTree.Node) {
-      return getInnermostScopeFromNode(result.scopeManager!, node);
-    }
-
-    /** Register node to scope */
-    function registerNodeToScope(node: any, scope: Scope): void {
-      // If we replace the `scope.block` at this time,
-      // the scope restore calculation will not work, so we will replace the `scope.block` later.
-      postprocessList.push(() => {
-        scope.block = node;
-      });
+  }
 
-      const scopes = nodeToScope.get(node);
-      if (scopes) {
-        scopes.push(scope);
-      } else {
-        nodeToScope.set(node, [scope]);
-      }
+  /**
+   * Restore program node
+   */
+  private restoreProgram(
+    result: ESLintExtendedProgram,
+    callbackOption: ScriptLetRestoreCallbackOption
+  ): void {
+    for (const callback of this.programRestoreCallbacks) {
+      callback(
+        result.ast,
+        result.ast.tokens,
+        result.ast.comments,
+        callbackOption
+      );
     }
   }
 

Diff for: src/index.ts

@@ -6,6 +6,8 @@ import { ParseError } from "./errors";
 
 export { AST, ParseError };
 
+export const name = "svelte-eslint-parser";
+
 // parser
 export { parseForESLint };
 // Keys

Diff for: src/parser/converts/root.ts

@@ -9,6 +9,7 @@ import {} from "./common";
 import type { Context } from "../../context";
 import { convertChildren, extractElementTags } from "./element";
 import { convertAttributeTokens } from "./attr";
+import type { Scope } from "eslint-scope";
 
 /**
  * Convert root
@@ -127,6 +128,30 @@ export function convertSvelteRoot(
     body.push(style);
   }
 
+  // Set the scope of the Program node.
+  ctx.scriptLet.addProgramRestore(
+    (
+      node,
+      _tokens,
+      _comments,
+      { scopeManager, registerNodeToScope, addPostProcess }
+    ) => {
+      const scopes: Scope[] = [];
+      for (const scope of scopeManager.scopes) {
+        if (scope.block === node) {
+          registerNodeToScope(ast, scope);
+          scopes.push(scope);
+        }
+      }
+      addPostProcess(() => {
+        // Reverts the node indicated by `block` to the original Program node.
+        // This state is incorrect, but `eslint-utils`'s `referenceTracker.iterateEsmReferences()` tracks import statements
+        // from Program nodes set to `block` in global scope. This can only be handled by the original Program node.
+        scopeManager.globalScope.block = node;
+      });
+    }
+  );
+
   return ast;
 }