astro-eslint-parser 0.0.16 → 0.0.17

package/README.md

@@ -1,8 +1,10 @@
 # astro-eslint-parser
 
-[Astro] parser for [ESLint].  
+[Astro] component parser for [ESLint].  
 You can check it on [Online DEMO](https://ota-meshi.github.io/astro-eslint-parser/playground).
 
+[![sponsors](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/ota-meshi)
+
 [![NPM license](https://img.shields.io/npm/l/astro-eslint-parser.svg)](https://www.npmjs.com/package/astro-eslint-parser)
 [![NPM version](https://img.shields.io/npm/v/astro-eslint-parser.svg)](https://www.npmjs.com/package/astro-eslint-parser)
 [![NPM downloads](https://img.shields.io/badge/dynamic/json.svg?label=downloads&colorB=green&suffix=/day&query=$.downloads&uri=https://api.npmjs.org//downloads/point/last-day/astro-eslint-parser&maxAge=3600)](http://www.npmtrends.com/astro-eslint-parser)
@@ -143,17 +145,16 @@ Example **.vscode/settings.json**:
 }
 ```
 
-## Compatibility With Existing ESLint Rules
+## :two_hearts: Compatibility With Existing ESLint Rules
 
 Most of the rules in the ESLint core work for the script part, but some rules are incompatible.  
 This parser will generate a JSX compatible AST for most of the HTML part of the Astro component. Therefore, some rules of [eslint-plugin-react] may work.
 For example, the [react/jsx-no-target-blank] rule works fine.  
 
-[semi]: https://eslint.org/docs/rules/semi
 [eslint-plugin-react]: https://github.com/jsx-eslint/eslint-plugin-react/
 [react/jsx-no-target-blank]: https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-no-target-blank.md
 
-## Usage for Custom Rules / Plugins
+## :hammer: Usage for Custom Rules / Plugins
 
 - TBA
 - You can check the AST in the [Online DEMO](https://ota-meshi.github.io/astro-eslint-parser/). However, AST is subject to major changes in the future.
@@ -167,6 +168,12 @@ Welcome contributing!
 
 Please use GitHub's Issues/PRs.
 
+## :heart: Supporting
+
+If you are willing to see that this package continues to be maintained, please consider sponsoring me.
+
+[![sponsors](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/ota-meshi)
+
 ## :lock: License
 
 See the [LICENSE](LICENSE) file for license rights and limitations (MIT).

package/lib/ast.d.ts

@@ -1,30 +1,31 @@
 import type { TSESTree } from "@typescript-eslint/types";
-export declare type AstroNode = AstroProgram | AstroRootFragment | AstroHTMLComment | AstroDoctype | AstroShorthandAttribute | AstroTemplateLiteralAttribute | AstroRawText | AstroFragment;
+export declare type AstroNode = AstroProgram | AstroFragment | AstroHTMLComment | AstroDoctype | AstroShorthandAttribute | AstroTemplateLiteralAttribute | AstroRawText;
+export declare type AstroChild = TSESTree.JSXFragment["children"][number] | AstroHTMLComment;
 /** Node of Astro program root */
 export interface AstroProgram extends Omit<TSESTree.Program, "type" | "body"> {
     type: "Program";
-    body: (TSESTree.Program["body"][number] | AstroRootFragment | AstroHTMLComment)[];
+    body: (TSESTree.Program["body"][number] | AstroFragment)[];
     sourceType: "script" | "module";
     comments: TSESTree.Comment[];
     tokens: TSESTree.Token[];
     parent: undefined;
 }
-/** Node of Astro fragment root */
-export interface AstroRootFragment extends Omit<TSESTree.BaseNode, "type" | "parent"> {
-    type: "AstroRootFragment";
-    children: TSESTree.JSXFragment["children"];
-    parent: AstroProgram;
+/** Node of Astro fragment */
+export interface AstroFragment extends Omit<TSESTree.BaseNode, "type" | "parent"> {
+    type: "AstroFragment";
+    children: AstroChild[];
+    parent: TSESTree.JSXFragment["parent"];
 }
 /** Node of Astro html comment */
 export interface AstroHTMLComment extends Omit<TSESTree.BaseNode, "type" | "parent"> {
     type: "AstroHTMLComment";
     value: string;
-    parent: AstroRootFragment | TSESTree.JSXElement | TSESTree.JSXFragment;
+    parent: AstroFragment | AstroFragment | TSESTree.JSXElement | TSESTree.JSXFragment;
 }
 /** Node of Astro doctype */
 export interface AstroDoctype extends Omit<TSESTree.BaseNode, "type" | "parent"> {
     type: "AstroDoctype";
-    parent: AstroRootFragment;
+    parent: AstroFragment | AstroFragment;
 }
 /** Node of Astro shorthand attribute */
 export interface AstroShorthandAttribute extends Omit<TSESTree.JSXAttribute, "type" | "parent"> {
@@ -43,11 +44,5 @@ export interface AstroTemplateLiteralAttribute extends Omit<TSESTree.JSXAttribut
 /** Node of Astro raw text */
 export interface AstroRawText extends Omit<TSESTree.JSXText, "type" | "parent"> {
     type: "AstroRawText";
-    parent: AstroRootFragment | TSESTree.JSXElement | TSESTree.JSXFragment;
-}
-/** Node of Astro fragment expression */
-export interface AstroFragment extends Omit<TSESTree.BaseNode, "type" | "parent"> {
-    type: "AstroFragment";
-    children: TSESTree.JSXFragment["children"];
-    parent: TSESTree.JSXFragment["parent"];
+    parent: AstroFragment | TSESTree.JSXElement | TSESTree.JSXFragment;
 }

package/lib/context/script.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScriptContext = void 0;
 const traverse_1 = require("../traverse");
-const errors_1 = require("../errors");
 class RestoreNodeProcessContext {
     constructor(result) {
         this.removeTokens = new Set();
@@ -26,6 +25,9 @@ class ScriptContext {
         this.consumedIndex += offset;
     }
     appendOriginal(index) {
+        if (this.consumedIndex >= index) {
+            return;
+        }
         this.offsets.push({
             original: this.consumedIndex,
             script: this.script.length,
@@ -47,20 +49,8 @@ class ScriptContext {
     /**
      * Restore AST nodes
      */
-    // eslint-disable-next-line complexity -- X(
     restore(result) {
-        const last = result.ast.body[result.ast.body.length - 1];
-        if (last.type !== "ExpressionStatement") {
-            throw new errors_1.ParseError("Unknown state error: Expected ExpressionStatement", last.range[0], this.ctx);
-        }
-        if (last.expression.type !== "JSXFragment") {
-            throw new errors_1.ParseError("Unknown state error: Expected JSXFragment", last.expression.range[0], this.ctx);
-        }
-        // Process for Astro
-        const rootFragment = (result.ast.body[result.ast.body.length - 1] = last.expression);
-        delete rootFragment.closingFragment;
-        delete rootFragment.openingFragment;
-        rootFragment.type = "AstroRootFragment";
+        var _a, _b;
         // remap locations
         const traversed = new Map();
         (0, traverse_1.traverseNodes)(result.ast, {
@@ -110,10 +100,16 @@ class ScriptContext {
             }
         }
         // Adjust program node location
-        const first = result.ast.body[0];
-        if (first.range[0] < result.ast.range[0]) {
-            result.ast.range[0] = first.range[0];
-            result.ast.loc.start = this.ctx.getLocFromIndex(result.ast.range[0]);
+        const firstOffset = Math.min(...[
+            result.ast.body[0],
+            (_a = result.ast.tokens) === null || _a === void 0 ? void 0 : _a[0],
+            (_b = result.ast.comments) === null || _b === void 0 ? void 0 : _b[0],
+        ]
+            .filter(Boolean)
+            .map((t) => t.range[0]));
+        if (firstOffset < result.ast.range[0]) {
+            result.ast.range[0] = firstOffset;
+            result.ast.loc.start = this.ctx.getLocFromIndex(firstOffset);
         }
     }
     remapLocation(node) {
@@ -142,6 +138,9 @@ class ScriptContext {
         }
     }
     getRemapRange(start, end) {
+        if (!this.offsets.length) {
+            return [start, end];
+        }
         let lastStart = this.offsets[0];
         let lastEnd = this.offsets[0];
         for (const offset of this.offsets) {

package/lib/parser/astro-parser/parse.js

@@ -32,6 +32,10 @@ const errors_1 = require("../../errors");
  */
 function parse(code, ctx) {
     const ast = parseByService(code, ctx).ast;
+    if (!ast.children) {
+        // If the source code is empty, the children property may not be available.
+        ast.children = [];
+    }
     const htmlElement = ast.children.find((n) => n.type === "element" && n.name === "html");
     if (htmlElement) {
         adjustHTML(ast, htmlElement, ctx);

package/lib/parser/process-template.js

@@ -11,30 +11,47 @@ function processTemplate(ctx, resultTemplate) {
     let uniqueIdSeq = 0;
     const usedUniqueIds = new Set();
     const script = new script_1.ScriptContext(ctx);
-    const frontmatter = resultTemplate.ast.children.find((n) => n.type === "frontmatter");
     let fragmentOpened = false;
-    if (!frontmatter) {
+    /** Open astro root fragment */
+    function openRootFragment(startOffset) {
         script.appendScript("<>");
         fragmentOpened = true;
+        script.addRestoreNodeProcess((scriptNode, { result }) => {
+            if (scriptNode.type === types_1.AST_NODE_TYPES.ExpressionStatement &&
+                scriptNode.expression.type === types_1.AST_NODE_TYPES.JSXFragment &&
+                scriptNode.range[0] === startOffset &&
+                result.ast.body.includes(scriptNode)) {
+                const index = result.ast.body.indexOf(scriptNode);
+                const rootFragment = (result.ast.body[index] =
+                    scriptNode.expression);
+                delete rootFragment.closingFragment;
+                delete rootFragment.openingFragment;
+                rootFragment.type = "AstroFragment";
+                return true;
+            }
+            return false;
+        });
     }
     (0, astro_1.walkElements)(resultTemplate.ast, ctx.code, 
     // eslint-disable-next-line complexity -- X(
     (node, [parent]) => {
         if (node.type === "frontmatter") {
             const start = node.position.start.offset;
+            if (fragmentOpened) {
+                script.appendScript("</>;");
+                fragmentOpened = false;
+            }
             script.appendOriginal(start);
             script.skipOriginalOffset(3);
             const end = (0, astro_1.getEndOffset)(node, ctx);
             script.appendOriginal(end - 3);
-            script.appendScript(";<>");
-            fragmentOpened = true;
+            script.appendScript(";");
             script.skipOriginalOffset(3);
             script.addRestoreNodeProcess((_scriptNode, { result }) => {
                 for (let index = 0; index < result.ast.body.length; index++) {
                     const st = result.ast.body[index];
                     if (st.type === types_1.AST_NODE_TYPES.EmptyStatement) {
-                        if (st.range[0] === end - 3 &&
-                            st.range[1] === end) {
+                        if (st.range[0] === end - 3 && st.range[1] <= end) {
                             result.ast.body.splice(index, 1);
                             break;
                         }
@@ -81,6 +98,11 @@ function processTemplate(ctx, resultTemplate) {
                     }
                 }
             }
+            const start = node.position.start.offset;
+            script.appendOriginal(start);
+            if (!fragmentOpened) {
+                openRootFragment(start);
+            }
             // Process for attributes
             for (const attr of node.attributes) {
                 if ((node.type === "component" ||
@@ -210,21 +232,16 @@ function processTemplate(ctx, resultTemplate) {
             const end = (0, astro_1.getEndOffset)(node, ctx);
             const length = end - start;
             script.appendOriginal(start);
-            let targetType;
-            if (fragmentOpened) {
-                script.appendOriginal(start + 1);
-                script.appendScript(`></`);
-                script.skipOriginalOffset(length - 2);
-                targetType = types_1.AST_NODE_TYPES.JSXFragment;
-            }
-            else {
-                script.appendScript(`0;`);
-                targetType = types_1.AST_NODE_TYPES.ExpressionStatement;
-                script.skipOriginalOffset(length);
+            if (!fragmentOpened) {
+                openRootFragment(start);
             }
+            script.appendOriginal(start + 1);
+            script.appendScript(`></`);
+            script.skipOriginalOffset(length - 2);
+            script.appendOriginal(end);
             script.addRestoreNodeProcess((scriptNode, context) => {
                 if (scriptNode.range[0] === start &&
-                    scriptNode.type === targetType) {
+                    scriptNode.type === types_1.AST_NODE_TYPES.JSXFragment) {
                     delete scriptNode.children;
                     delete scriptNode.openingFragment;
                     delete scriptNode.closingFragment;
@@ -232,12 +249,10 @@ function processTemplate(ctx, resultTemplate) {
                     const commentNode = scriptNode;
                     commentNode.type = "AstroHTMLComment";
                     commentNode.value = node.value;
-                    if (targetType === types_1.AST_NODE_TYPES.JSXFragment) {
-                        context.addRemoveToken((token) => token.value === "<" &&
-                            token.range[0] === scriptNode.range[0]);
-                        context.addRemoveToken((token) => token.value === ">" &&
-                            token.range[1] === scriptNode.range[1]);
-                    }
+                    context.addRemoveToken((token) => token.value === "<" &&
+                        token.range[0] === scriptNode.range[0]);
+                    context.addRemoveToken((token) => token.value === ">" &&
+                        token.range[1] === scriptNode.range[1]);
                     return true;
                 }
                 return false;
@@ -252,39 +267,39 @@ function processTemplate(ctx, resultTemplate) {
             const end = (0, astro_1.getEndOffset)(node, ctx);
             const length = end - start;
             script.appendOriginal(start);
-            let targetType;
-            if (fragmentOpened) {
-                script.appendOriginal(start + 1);
-                script.appendScript(`></`);
-                script.skipOriginalOffset(length - 2);
-                targetType = types_1.AST_NODE_TYPES.JSXFragment;
-            }
-            else {
-                script.appendScript(`0;`);
-                targetType = types_1.AST_NODE_TYPES.ExpressionStatement;
-                script.skipOriginalOffset(length);
+            if (!fragmentOpened) {
+                openRootFragment(start);
             }
+            script.appendOriginal(start + 1);
+            script.appendScript(`></`);
+            script.skipOriginalOffset(length - 2);
+            script.appendOriginal(end);
             script.addRestoreNodeProcess((scriptNode, context) => {
                 if (scriptNode.range[0] === start &&
-                    scriptNode.type === targetType) {
+                    scriptNode.type === types_1.AST_NODE_TYPES.JSXFragment) {
                     delete scriptNode.children;
                     delete scriptNode.openingFragment;
                     delete scriptNode.closingFragment;
                     delete scriptNode.expression;
                     const doctypeNode = scriptNode;
                     doctypeNode.type = "AstroDoctype";
-                    if (targetType === types_1.AST_NODE_TYPES.JSXFragment) {
-                        context.addRemoveToken((token) => token.value === "<" &&
-                            token.range[0] === scriptNode.range[0]);
-                        context.addRemoveToken((token) => token.value === ">" &&
-                            token.range[1] === scriptNode.range[1]);
-                    }
+                    context.addRemoveToken((token) => token.value === "<" &&
+                        token.range[0] === scriptNode.range[0]);
+                    context.addRemoveToken((token) => token.value === ">" &&
+                        token.range[1] === scriptNode.range[1]);
                     return true;
                 }
                 return false;
             });
             script.addToken("HTMLDocType", [start, end]);
         }
+        else {
+            const start = node.position.start.offset;
+            script.appendOriginal(start);
+            if (!fragmentOpened) {
+                openRootFragment(start);
+            }
+        }
     }, (node, [parent]) => {
         if ((0, astro_1.isTag)(node)) {
             const closing = (0, astro_1.getSelfClosingTag)(node, ctx);
@@ -323,8 +338,13 @@ function processTemplate(ctx, resultTemplate) {
             }
         }
     });
+    if (fragmentOpened) {
+        const last = resultTemplate.ast.children[resultTemplate.ast.children.length - 1];
+        const end = (0, astro_1.getEndOffset)(last, ctx);
+        script.appendOriginal(end);
+        script.appendScript("</>");
+    }
     script.appendOriginal(ctx.code.length);
-    script.appendScript("</>");
     return script;
     /**
      * Generate unique id

package/lib/visitor-keys.js

@@ -4,12 +4,11 @@ exports.KEYS = void 0;
 const eslint_visitor_keys_1 = require("eslint-visitor-keys");
 const astroKeys = {
     Program: ["body"],
-    AstroRootFragment: ["children"],
+    AstroFragment: ["children"],
     AstroHTMLComment: [],
     AstroDoctype: [],
     AstroShorthandAttribute: ["name", "value"],
     AstroTemplateLiteralAttribute: ["name", "value"],
     AstroRawText: [],
-    AstroFragment: ["children"],
 };
 exports.KEYS = (0, eslint_visitor_keys_1.unionWith)(astroKeys);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "astro-eslint-parser",
-    "version": "0.0.16",
-    "description": "Astro parser for ESLint",
+    "version": "0.0.17",
+    "description": "Astro component parser for ESLint",
     "main": "lib/index.js",
     "files": [
         "lib"
@@ -88,6 +88,6 @@
         "string-replace-loader": "^3.0.3",
         "ts-node": "^10.4.0",
         "typescript": "~4.6.0",
-        "vue-eslint-parser": "^8.0.1"
+        "vue-eslint-parser": "^9.0.0"
     }
 }