astro-eslint-parser 0.0.4 → 0.0.7

package/README.md

@@ -15,7 +15,7 @@ You can check it on [Online DEMO](https://ota-meshi.github.io/astro-eslint-parse
 
 This parser is in the ***experimental stages*** of development.
 
-Currently this parser relies heavily on the internal API of [@astrojs/compiler]. It may stop working in a future update of [@astrojs/compiler].
+⚠ Currently this parser relies heavily on the internal API of [@astrojs/compiler]. It may stop working in a future update of [@astrojs/compiler]. ⚠
 
 [@astrojs/compiler]: https://github.com/withastro/compiler
 
@@ -151,7 +151,7 @@ For example, the [react/jsx-no-target-blank] rule works fine.
 ## Usage for Custom Rules / Plugins
 
 - TBA
-- You can check it on the [Online DEMO](https://ota-meshi.github.io/astro-eslint-parser/). However, AST is subject to major changes in the future.
+- 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.
 
 <!-- - [AST.md](./docs/AST.md) is AST specification. You can check it on the [Online DEMO](https://ota-meshi.github.io/astro-eslint-parser/). -->
 <!-- - I have already [implemented some rules] in the [`@ota-meshi/eslint-plugin-astro`]. The source code for these rules will be helpful to you. -->

package/lib/astro/index.d.ts

@@ -1,4 +1,5 @@
 import type { AttributeNode, CommentNode, Node, ParentNode, TagLikeNode } from "@astrojs/compiler/types";
+import type { Context } from "../context";
 /**
  * Checks if the given node is TagLikeNode
  */
@@ -8,25 +9,25 @@ export declare function isTag(node: Node): node is Node & TagLikeNode;
  */
 export declare function isParent(node: Node): node is ParentNode;
 /** walk element nodes */
-export declare function walkElements(parent: ParentNode, cb: (n: Node, parent: ParentNode) => void): void;
+export declare function walkElements(parent: ParentNode, code: string, cb: (n: Node, parent: ParentNode) => void): void;
 /** walk nodes */
-export declare function walk(parent: ParentNode, enter: (n: Node | AttributeNode, parent: ParentNode) => void, leave?: (n: Node | AttributeNode, parent: ParentNode) => void): void;
+export declare function walk(parent: ParentNode, code: string, enter: (n: Node | AttributeNode, parent: ParentNode) => void, leave?: (n: Node | AttributeNode, parent: ParentNode) => void): void;
 /**
  * Get end offset of start tag
  */
-export declare function getStartTagEndOffset(node: TagLikeNode, code: string): number;
+export declare function getStartTagEndOffset(node: TagLikeNode, ctx: Context): number;
 /**
  * Get end offset of attribute
  */
-export declare function getAttributeEndOffset(node: AttributeNode, code: string): number;
+export declare function getAttributeEndOffset(node: AttributeNode, ctx: Context): number;
 /**
  * Get start offset of attribute value
  */
-export declare function getAttributeValueStartOffset(node: AttributeNode, code: string): number;
+export declare function getAttributeValueStartOffset(node: AttributeNode, ctx: Context): number;
 /**
  * Get end offset of comment
  */
-export declare function getCommentEndOffset(node: CommentNode, code: string): number;
+export declare function getCommentEndOffset(node: CommentNode, ctx: Context): number;
 /**
  * Skip spaces
  */

package/lib/astro/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.skipSpaces = exports.getCommentEndOffset = exports.getAttributeValueStartOffset = exports.getAttributeEndOffset = exports.getStartTagEndOffset = exports.walk = exports.walkElements = exports.isParent = exports.isTag = void 0;
+const errors_1 = require("../errors");
 /**
  * Checks if the given node is TagLikeNode
  */
@@ -19,27 +20,19 @@ function isParent(node) {
 }
 exports.isParent = isParent;
 /** walk element nodes */
-function walkElements(parent, cb) {
-    let children = parent.children;
-    if (parent.type === "root" && children.every((n) => n.position)) {
-        // The order of comments and frontmatter may be changed.
-        children = [...children].sort((a, b) => a.position.start.offset - b.position.start.offset);
-    }
+function walkElements(parent, code, cb) {
+    const children = getSortedChildren(parent, code);
     for (const node of children) {
         cb(node, parent);
         if (isParent(node)) {
-            walkElements(node, cb);
+            walkElements(node, code, cb);
         }
     }
 }
 exports.walkElements = walkElements;
 /** walk nodes */
-function walk(parent, enter, leave) {
-    let children = parent.children;
-    if (parent.type === "root" && children.every((n) => n.position)) {
-        // The order of comments and frontmatter may be changed.
-        children = [...children].sort((a, b) => a.position.start.offset - b.position.start.offset);
-    }
+function walk(parent, code, enter, leave) {
+    const children = getSortedChildren(parent, code);
     for (const node of children) {
         enter(node, parent);
         if (isTag(node)) {
@@ -49,7 +42,7 @@ function walk(parent, enter, leave) {
             }
         }
         if (isParent(node)) {
-            walk(node, enter, leave);
+            walk(node, code, enter, leave);
         }
         leave === null || leave === void 0 ? void 0 : leave(node, parent);
     }
@@ -58,45 +51,45 @@ exports.walk = walk;
 /**
  * Get end offset of start tag
  */
-function getStartTagEndOffset(node, code) {
+function getStartTagEndOffset(node, ctx) {
     const lastAttr = node.attributes[node.attributes.length - 1];
     let beforeCloseIndex;
     if (lastAttr) {
-        beforeCloseIndex = getAttributeEndOffset(lastAttr, code);
+        beforeCloseIndex = getAttributeEndOffset(lastAttr, ctx);
     }
     else {
-        const info = getTokenInfo(code, [`<${node.name}`], node.position.start.offset);
+        const info = getTokenInfo(ctx, [`<${node.name}`], node.position.start.offset);
         beforeCloseIndex = info.index + info.match.length;
     }
-    const info = getTokenInfo(code, [[">", "/>"]], beforeCloseIndex);
+    const info = getTokenInfo(ctx, [[">", "/>"]], beforeCloseIndex);
     return info.index + info.match.length;
 }
 exports.getStartTagEndOffset = getStartTagEndOffset;
 /**
  * Get end offset of attribute
  */
-function getAttributeEndOffset(node, code) {
+function getAttributeEndOffset(node, ctx) {
     let info;
     if (node.kind === "empty") {
-        info = getTokenInfo(code, [node.name], node.position.start.offset);
+        info = getTokenInfo(ctx, [node.name], node.position.start.offset);
     }
     else if (node.kind === "quoted") {
-        info = getTokenInfo(code, [[`"${node.value}"`, `'${node.value}'`, node.value]], getAttributeValueStartOffset(node, code));
+        info = getTokenInfo(ctx, [[`"${node.value}"`, `'${node.value}'`, node.value]], getAttributeValueStartOffset(node, ctx));
     }
     else if (node.kind === "expression") {
-        info = getTokenInfo(code, ["{", node.value, "}"], getAttributeValueStartOffset(node, code));
+        info = getTokenInfo(ctx, ["{", node.value, "}"], getAttributeValueStartOffset(node, ctx));
     }
     else if (node.kind === "shorthand") {
-        info = getTokenInfo(code, ["{", node.name, "}"], node.position.start.offset);
+        info = getTokenInfo(ctx, ["{", node.name, "}"], node.position.start.offset);
     }
     else if (node.kind === "spread") {
-        info = getTokenInfo(code, ["{", "...", node.name, "}"], node.position.start.offset);
+        info = getTokenInfo(ctx, ["{", "...", node.name, "}"], node.position.start.offset);
     }
     else if (node.kind === "template-literal") {
-        info = getTokenInfo(code, [`\`${node.value}\``], getAttributeValueStartOffset(node, code));
+        info = getTokenInfo(ctx, [`\`${node.value}\``], getAttributeValueStartOffset(node, ctx));
     }
     else {
-        throw new Error(`Unknown attr kind: ${node.kind}`);
+        throw new errors_1.ParseError(`Unknown attr kind: ${node.kind}`, node.position.start.offset, ctx);
     }
     return info.index + info.match.length;
 }
@@ -104,19 +97,19 @@ exports.getAttributeEndOffset = getAttributeEndOffset;
 /**
  * Get start offset of attribute value
  */
-function getAttributeValueStartOffset(node, code) {
+function getAttributeValueStartOffset(node, ctx) {
     let info;
     if (node.kind === "quoted") {
-        info = getTokenInfo(code, [node.name, "=", [`"`, `'`, node.value]], node.position.start.offset);
+        info = getTokenInfo(ctx, [node.name, "=", [`"`, `'`, node.value]], node.position.start.offset);
     }
     else if (node.kind === "expression") {
-        info = getTokenInfo(code, [node.name, "=", "{"], node.position.start.offset);
+        info = getTokenInfo(ctx, [node.name, "=", "{"], node.position.start.offset);
     }
     else if (node.kind === "template-literal") {
-        info = getTokenInfo(code, [node.name, "=", "`"], node.position.start.offset);
+        info = getTokenInfo(ctx, [node.name, "=", "`"], node.position.start.offset);
     }
     else {
-        throw new Error(`Unknown attr kind: ${node.kind}`);
+        throw new errors_1.ParseError(`Unknown attr kind: ${node.kind}`, node.position.start.offset, ctx);
     }
     return info.index;
 }
@@ -124,15 +117,15 @@ exports.getAttributeValueStartOffset = getAttributeValueStartOffset;
 /**
  * Get end offset of comment
  */
-function getCommentEndOffset(node, code) {
-    const info = getTokenInfo(code, ["<!--", node.value, "-->"], node.position.start.offset);
+function getCommentEndOffset(node, ctx) {
+    const info = getTokenInfo(ctx, ["<!--", node.value, "-->"], node.position.start.offset);
     return info.index + info.match.length;
 }
 exports.getCommentEndOffset = getCommentEndOffset;
 /**
  * Get token info
  */
-function getTokenInfo(string, tokens, position) {
+function getTokenInfo(ctx, tokens, position) {
     let lastMatch;
     for (const t of tokens) {
         const index = lastMatch
@@ -142,7 +135,7 @@ function getTokenInfo(string, tokens, position) {
             ? matchOfStr(t, index)
             : matchOfForMulti(t, index);
         if (m == null) {
-            throw new Error(`Unknown token at ${index}, expected: ${JSON.stringify(t)}, actual: ${JSON.stringify(string.slice(index, index + 10))}`);
+            throw new errors_1.ParseError(`Unknown token at ${index}, expected: ${JSON.stringify(t)}, actual: ${JSON.stringify(ctx.code.slice(index, index + 10))}`, index, ctx);
         }
         lastMatch = m;
     }
@@ -151,8 +144,8 @@ function getTokenInfo(string, tokens, position) {
      * For string
      */
     function matchOfStr(search, position) {
-        const index = search.trim() === search ? skipSpaces(string, position) : position;
-        if (string.startsWith(search, index)) {
+        const index = search.trim() === search ? skipSpaces(ctx.code, position) : position;
+        if (ctx.code.startsWith(search, index)) {
             return {
                 match: search,
                 index,
@@ -186,3 +179,41 @@ function skipSpaces(string, position) {
     return position;
 }
 exports.skipSpaces = skipSpaces;
+/**
+ * Get children
+ */
+function getSortedChildren(parent, code) {
+    var _a;
+    if (parent.type === "root" && ((_a = parent.children[0]) === null || _a === void 0 ? void 0 : _a.type) === "frontmatter") {
+        // The order of comments and frontmatter may be changed.
+        const children = [...parent.children];
+        if (children.every((n) => n.position)) {
+            return children.sort((a, b) => a.position.start.offset - b.position.start.offset);
+        }
+        let start = skipSpaces(code, 0);
+        if (code.startsWith("<!", start)) {
+            const frontmatter = children.shift();
+            const before = [];
+            let first;
+            while ((first = children.shift())) {
+                start = skipSpaces(code, start);
+                if (first.type === "comment" &&
+                    code.startsWith("<!--", start)) {
+                    start = code.indexOf("-->", start + 4) + 3;
+                    before.push(first);
+                }
+                else if (first.type === "doctype" &&
+                    code.startsWith("<!", start)) {
+                    start = code.indexOf(">", start + 2) + 1;
+                    before.push(first);
+                }
+                else {
+                    children.unshift(first);
+                    break;
+                }
+            }
+            return [...before, frontmatter, ...children];
+        }
+    }
+    return parent.children;
+}

package/lib/parser/astro-parser/parse.d.ts

@@ -1,5 +1,6 @@
 import type { ParseResult } from "@astrojs/compiler";
+import type { Context } from "../../context";
 /**
  * Parse code by `@astrojs/compiler`
  */
-export declare function parse(code: string): ParseResult;
+export declare function parse(code: string, ctx: Context): ParseResult;

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

@@ -26,26 +26,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parse = void 0;
 const service = __importStar(require("./astrojs-compiler-service"));
 const astro_1 = require("../../astro");
+const errors_1 = require("../../errors");
 /**
  * Parse code by `@astrojs/compiler`
  */
-function parse(code) {
+function parse(code, ctx) {
     const ast = service.parse(code, { position: true }).ast;
-    fixLocations(ast, code);
+    fixLocations(ast, ctx);
     return { ast };
 }
 exports.parse = parse;
 /**
  * Fix locations
  */
-function fixLocations(node, code) {
+function fixLocations(node, ctx) {
     // FIXME: Adjust because the parser does not return the correct location.
     let start = 0;
-    (0, astro_1.walk)(node, (node) => {
+    (0, astro_1.walk)(node, ctx.code, (node) => {
         if (node.type === "frontmatter") {
-            start = node.position.start.offset = tokenIndex(code, "---", start);
+            start = node.position.start.offset = tokenIndex(ctx, "---", start);
             start = node.position.end.offset =
-                tokenIndex(code, "---", start + 3 + node.value.length) + 3;
+                tokenIndex(ctx, "---", start + 3 + node.value.length) + 3;
         }
         else if (node.type === "fragment" ||
             node.type === "element" ||
@@ -54,37 +55,40 @@ function fixLocations(node, code) {
             if (!node.position) {
                 node.position = { start: {}, end: {} };
             }
-            start = node.position.start.offset = tokenIndex(code, "<", start);
+            start = node.position.start.offset = tokenIndex(ctx, "<", start);
             start += 1;
             start += node.name.length;
             if (!node.attributes.length) {
-                start = (0, astro_1.getStartTagEndOffset)(node, code);
+                start = (0, astro_1.getStartTagEndOffset)(node, ctx);
             }
         }
         else if (node.type === "attribute") {
-            fixLocationForAttr(node, code, start);
-            start = (0, astro_1.getAttributeEndOffset)(node, code);
+            fixLocationForAttr(node, ctx, start);
+            start = (0, astro_1.getAttributeEndOffset)(node, ctx);
         }
         else if (node.type === "comment") {
-            node.position.start.offset = tokenIndex(code, "<!--", start);
-            start = (0, astro_1.getCommentEndOffset)(node, code);
+            node.position.start.offset = tokenIndex(ctx, "<!--", start);
+            start = (0, astro_1.getCommentEndOffset)(node, ctx);
         }
         else if (node.type === "text") {
-            start = node.position.start.offset = tokenIndex(code, node.value, start);
+            start = node.position.start.offset = tokenIndex(ctx, node.value, start);
             start += node.value.length;
         }
         else if (node.type === "expression") {
-            start = node.position.start.offset = tokenIndex(code, "{", start);
+            start = node.position.start.offset = tokenIndex(ctx, "{", start);
             start += 1;
         }
         else if (node.type === "doctype") {
             if (!node.position) {
                 node.position = { start: {}, end: {} };
             }
-            start = node.position.start.offset = tokenIndex(code, "<!", start);
+            if (!node.position.end) {
+                node.position.end = {};
+            }
+            start = node.position.start.offset = tokenIndex(ctx, "<!", start);
             start += 2;
             start = node.position.end.offset =
-                code.indexOf(">", start) + 1;
+                ctx.code.indexOf(">", start) + 1;
         }
         else if (node.type === "root") {
             // noop
@@ -93,24 +97,21 @@ function fixLocations(node, code) {
         if (node.type === "attribute") {
             const attributes = parent.attributes;
             if (attributes[attributes.length - 1] === node) {
-                start = (0, astro_1.getStartTagEndOffset)(parent, code);
+                start = (0, astro_1.getStartTagEndOffset)(parent, ctx);
             }
             return;
         }
         if (node.type === "expression") {
-            start = tokenIndex(code, "}", start) + 1;
+            start = tokenIndex(ctx, "}", start) + 1;
         }
         else if (node.type === "fragment" ||
             node.type === "element" ||
             node.type === "component" ||
             node.type === "custom-element") {
-            if (!node.position.end) {
-                return;
-            }
-            const closeTagStart = tokenIndexSafe(code, `</${node.name}`, start);
+            const closeTagStart = tokenIndexSafe(ctx.code, `</${node.name}`, start);
             if (closeTagStart != null) {
                 start = closeTagStart + 2 + node.name.length;
-                start = tokenIndex(code, ">", start) + 1;
+                start = tokenIndex(ctx, ">", start) + 1;
             }
         }
         else {
@@ -124,37 +125,37 @@ function fixLocations(node, code) {
 /**
  * Fix locations
  */
-function fixLocationForAttr(node, code, start) {
+function fixLocationForAttr(node, ctx, start) {
     if (node.kind === "empty") {
-        node.position.start.offset = tokenIndex(code, node.name, start);
+        node.position.start.offset = tokenIndex(ctx, node.name, start);
     }
     else if (node.kind === "quoted") {
-        node.position.start.offset = tokenIndex(code, node.name, start);
+        node.position.start.offset = tokenIndex(ctx, node.name, start);
     }
     else if (node.kind === "expression") {
-        node.position.start.offset = tokenIndex(code, node.name, start);
+        node.position.start.offset = tokenIndex(ctx, node.name, start);
     }
     else if (node.kind === "shorthand") {
-        node.position.start.offset = tokenIndex(code, "{", start);
+        node.position.start.offset = tokenIndex(ctx, "{", start);
     }
     else if (node.kind === "spread") {
-        node.position.start.offset = tokenIndex(code, "{", start);
+        node.position.start.offset = tokenIndex(ctx, "{", start);
     }
     else if (node.kind === "template-literal") {
-        node.position.start.offset = tokenIndex(code, node.name, start);
+        node.position.start.offset = tokenIndex(ctx, node.name, start);
     }
     else {
-        throw new Error(`Unknown attr kind: ${node.kind}`);
+        throw new errors_1.ParseError(`Unknown attr kind: ${node.kind}`, node.position.start.offset, ctx);
     }
 }
 /**
  * Get token index
  */
-function tokenIndex(string, token, position) {
-    const index = tokenIndexSafe(string, token, position);
+function tokenIndex(ctx, token, position) {
+    const index = tokenIndexSafe(ctx.code, token, position);
     if (index == null) {
-        const start = token.trim() === token ? (0, astro_1.skipSpaces)(string, position) : position;
-        throw new Error(`Unknown token at ${start}, expected: ${JSON.stringify(token)}, actual: ${JSON.stringify(string.slice(start, start + 10))}`);
+        const start = token.trim() === token ? (0, astro_1.skipSpaces)(ctx.code, position) : position;
+        throw new errors_1.ParseError(`Unknown token at ${start}, expected: ${JSON.stringify(token)}, actual: ${JSON.stringify(ctx.code.slice(start, start + 10))}`, start, ctx);
     }
     return index;
 }

package/lib/parser/index.js

@@ -82,7 +82,7 @@ function extractTokens(ast, ctx) {
  */
 function parseTemplate(code, ctx) {
     try {
-        return (0, parse_1.parse)(code);
+        return (0, parse_1.parse)(code, ctx);
     }
     catch (e) {
         if (typeof e.pos === "number") {

package/lib/parser/process-template.js

@@ -16,7 +16,7 @@ function processTemplate(ctx, resultTemplate) {
         fragmentOpened = true;
     }
     // eslint-disable-next-line complexity -- X(
-    (0, astro_1.walkElements)(resultTemplate.ast, (node, parent) => {
+    (0, astro_1.walkElements)(resultTemplate.ast, ctx.code, (node, parent) => {
         if (node.type === "frontmatter") {
             const start = node.position.start.offset;
             script.appendOriginal(start);
@@ -115,8 +115,8 @@ function processTemplate(ctx, resultTemplate) {
                 }
                 else if (attr.kind === "template-literal") {
                     const attrStart = attr.position.start.offset;
-                    const start = (0, astro_1.getAttributeValueStartOffset)(attr, ctx.code);
-                    const end = (0, astro_1.getAttributeEndOffset)(attr, ctx.code);
+                    const start = (0, astro_1.getAttributeValueStartOffset)(attr, ctx);
+                    const end = (0, astro_1.getAttributeEndOffset)(attr, ctx);
                     script.appendOriginal(start);
                     script.appendScript("{");
                     script.appendOriginal(end);
@@ -253,7 +253,7 @@ function getVoidSelfClosingTag(node, parent, ctx) {
         const next = parent.children[childIndex + 1];
         nextElementIndex = next.position.start.offset;
     }
-    const endOffset = (0, astro_1.getStartTagEndOffset)(node, code);
+    const endOffset = (0, astro_1.getStartTagEndOffset)(node, ctx);
     if (code.slice(endOffset, nextElementIndex).trim()) {
         // has end tag
         return null;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "astro-eslint-parser",
-    "version": "0.0.4",
+    "version": "0.0.7",
     "description": "Astro parser for ESLint",
     "main": "lib/index.js",
     "files": [