astro-eslint-parser 0.0.0 → 0.0.1

package/README.md

@@ -135,7 +135,7 @@ Example **.vscode/settings.json**:
 
 ## Usage for Custom Rules / Plugins
 
-- TBD
+- TBA
 
 <!-- - [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/context/script.d.ts

@@ -1,11 +1,6 @@
-import type { ParseResult } from "@astrojs/compiler";
 import type { Context } from ".";
 import type { ESLintExtendedProgram } from "../parser";
 import type { TSESTree } from "@typescript-eslint/types";
-/**
- * Process the template to generate a ScriptContext.
- */
-export declare function processTemplate(ctx: Context, resultTemplate: ParseResult): ScriptContext;
 export declare class ScriptContext {
     private readonly ctx;
     script: string;

package/lib/context/script.js

@@ -1,214 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScriptContext = exports.processTemplate = void 0;
+exports.ScriptContext = void 0;
 const traverse_1 = require("../traverse");
-const types_1 = require("@typescript-eslint/types");
 const errors_1 = require("../errors");
-const astro_1 = require("../astro");
-/**
- * Process the template to generate a ScriptContext.
- */
-function processTemplate(ctx, resultTemplate) {
-    const script = new ScriptContext(ctx);
-    const frontmatter = resultTemplate.ast.children.find((n) => n.type === "frontmatter");
-    let fragmentOpened = false;
-    if (!frontmatter) {
-        script.appendScript("<>");
-        fragmentOpened = true;
-    }
-    (0, astro_1.walkElements)(resultTemplate.ast, (node, parent) => {
-        if (node.type === "frontmatter") {
-            const start = node.position.start.offset;
-            script.appendOriginal(start);
-            script.skipOriginalOffset(3);
-            const end = node.position.end.offset;
-            script.appendOriginal(end - 3);
-            script.appendScript(";<>");
-            fragmentOpened = true;
-            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) {
-                            result.ast.body.splice(index, 1);
-                            break;
-                        }
-                    }
-                }
-                return true;
-            });
-            script.addToken(types_1.AST_TOKEN_TYPES.Punctuator, [
-                node.position.start.offset,
-                node.position.start.offset + 3,
-            ]);
-            script.addToken(types_1.AST_TOKEN_TYPES.Punctuator, [end - 3, end]);
-        }
-        else if ((0, astro_1.isTag)(node)) {
-            for (const attr of node.attributes) {
-                if (attr.kind === "shorthand") {
-                    const start = attr.position.start.offset;
-                    script.appendOriginal(start);
-                    script.appendScript(`${attr.name}=`);
-                    script.addRestoreNodeProcess((scriptNode) => {
-                        if (scriptNode.type === types_1.AST_NODE_TYPES.JSXAttribute &&
-                            scriptNode.range[0] === start) {
-                            const attrNode = scriptNode;
-                            attrNode.type = "AstroShorthandAttribute";
-                            const locs = ctx.getLocations(...attrNode.value.expression.range);
-                            attrNode.name.range = locs.range;
-                            attrNode.name.loc = locs.loc;
-                            return true;
-                        }
-                        return false;
-                    });
-                }
-                else if (attr.kind === "template-literal") {
-                    const start = (0, astro_1.getAttributeValueStartOffset)(attr, ctx.code);
-                    const end = (0, astro_1.getAttributeEndOffset)(attr, ctx.code);
-                    script.appendOriginal(start);
-                    script.appendScript("{");
-                    script.appendOriginal(end);
-                    script.appendScript("}");
-                    script.addRestoreNodeProcess((scriptNode) => {
-                        if (scriptNode.type === types_1.AST_NODE_TYPES.JSXAttribute &&
-                            scriptNode.range[0] === start) {
-                            const attrNode = scriptNode;
-                            attrNode.type = "AstroTemplateLiteralAttribute";
-                            return true;
-                        }
-                        return false;
-                    });
-                }
-            }
-            const end = getVoidSelfClosingTag(node, parent, ctx);
-            if (end && end.end === ">") {
-                script.appendOriginal(end.offset - 1);
-                script.appendScript("/");
-            }
-            if (node.name === "script" || node.name === "style") {
-                const text = node.children[0];
-                if (text && text.type === "text") {
-                    const styleNodeStart = node.position.start.offset;
-                    const start = text.position.start.offset;
-                    script.appendOriginal(start);
-                    script.skipOriginalOffset(text.value.length);
-                    script.addRestoreNodeProcess((scriptNode) => {
-                        if (scriptNode.type === types_1.AST_NODE_TYPES.JSXElement &&
-                            scriptNode.range[0] === styleNodeStart) {
-                            const textNode = Object.assign({ type: types_1.AST_NODE_TYPES.JSXText, value: text.value, raw: text.value, parent: scriptNode }, ctx.getLocations(start, start + text.value.length));
-                            scriptNode.children = [textNode];
-                            return true;
-                        }
-                        return false;
-                    });
-                    script.addToken(types_1.AST_TOKEN_TYPES.JSXText, [
-                        start,
-                        start + text.value.length,
-                    ]);
-                }
-            }
-        }
-        else if (node.type === "comment") {
-            const start = node.position.start.offset;
-            const length = 4 + node.value.length + 3;
-            script.appendOriginal(start);
-            let targetType;
-            if (fragmentOpened) {
-                script.appendScript(`<></>`);
-                targetType = types_1.AST_NODE_TYPES.JSXFragment;
-            }
-            else {
-                script.appendScript(`0;`);
-                targetType = types_1.AST_NODE_TYPES.ExpressionStatement;
-            }
-            script.skipOriginalOffset(length);
-            script.addRestoreNodeProcess((scriptNode) => {
-                if (scriptNode.range[0] === start &&
-                    scriptNode.type === targetType) {
-                    delete scriptNode.children;
-                    delete scriptNode.openingFragment;
-                    delete scriptNode.closingFragment;
-                    delete scriptNode.expression;
-                    const commentNode = scriptNode;
-                    commentNode.type = "AstroHTMLComment";
-                    commentNode.value = node.value;
-                    return true;
-                }
-                return false;
-            });
-            script.addToken("HTMLComment", [
-                start,
-                start + length,
-            ]);
-        }
-        else if (node.type === "doctype") {
-            const start = node.position.start.offset;
-            const end = node.position.end.offset;
-            script.appendOriginal(start);
-            let targetType;
-            if (fragmentOpened) {
-                script.appendScript(`<></>`);
-                targetType = types_1.AST_NODE_TYPES.JSXFragment;
-            }
-            else {
-                script.appendScript(`0;`);
-                targetType = types_1.AST_NODE_TYPES.ExpressionStatement;
-            }
-            script.skipOriginalOffset(end - start);
-            script.addRestoreNodeProcess((scriptNode) => {
-                if (scriptNode.range[0] === start &&
-                    scriptNode.type === targetType) {
-                    delete scriptNode.children;
-                    delete scriptNode.openingFragment;
-                    delete scriptNode.closingFragment;
-                    delete scriptNode.expression;
-                    const doctypeNode = scriptNode;
-                    doctypeNode.type = "AstroDoctype";
-                    return true;
-                }
-                return false;
-            });
-            script.addToken("HTMLDocType", [start, end]);
-        }
-    });
-    script.appendOriginal(ctx.code.length);
-    script.appendScript("</>");
-    return script;
-}
-exports.processTemplate = processTemplate;
-/**
- * If the given tag is a void tag, get the self-closing tag.
- */
-function getVoidSelfClosingTag(node, parent, ctx) {
-    if (node.type === "fragment") {
-        return false;
-    }
-    if (node.children.length > 0) {
-        return false;
-    }
-    const code = ctx.code;
-    let nextElementIndex = code.length;
-    const childIndex = parent.children.indexOf(node);
-    if (childIndex === parent.children.length - 1) {
-        // last
-        nextElementIndex = parent.position.end.offset;
-        nextElementIndex = code.lastIndexOf("</", nextElementIndex);
-    }
-    else {
-        const next = parent.children[childIndex + 1];
-        nextElementIndex = next.position.start.offset;
-    }
-    const endOffset = (0, astro_1.getStartTagEndOffset)(node, code);
-    if (code.slice(endOffset, nextElementIndex).trim()) {
-        // has end tag
-        return null;
-    }
-    return {
-        offset: endOffset,
-        end: code.slice(endOffset - 2, endOffset) === "/>" ? "/>" : ">",
-    };
-}
 class ScriptContext {
     constructor(ctx) {
         this.script = "";

package/lib/parser/index.js

@@ -8,7 +8,7 @@ const script_1 = require("./script");
 const sort_1 = require("./sort");
 const errors_1 = require("../errors");
 const parse_1 = require("./astro-parser/parse");
-const script_2 = require("../context/script");
+const process_template_1 = require("./process-template");
 /**
  * Parse source code
  */
@@ -21,7 +21,7 @@ function parseForESLint(code, options) {
     }
     const ctx = new context_1.Context(code, parserOptions);
     const resultTemplate = parseTemplate(ctx.code, ctx);
-    const scriptContext = (0, script_2.processTemplate)(ctx, resultTemplate);
+    const scriptContext = (0, process_template_1.processTemplate)(ctx, resultTemplate);
     const resultScript = (0, script_1.parseScript)(scriptContext.script, ctx);
     scriptContext.restore(resultScript);
     (0, sort_1.sort)(resultScript.ast.comments);

package/lib/parser/process-template.d.ts

@@ -0,0 +1,7 @@
+import type { ParseResult } from "@astrojs/compiler";
+import type { Context } from "../context";
+import { ScriptContext } from "../context/script";
+/**
+ * Process the template to generate a ScriptContext.
+ */
+export declare function processTemplate(ctx: Context, resultTemplate: ParseResult): ScriptContext;

package/lib/parser/process-template.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processTemplate = void 0;
+const types_1 = require("@typescript-eslint/types");
+const astro_1 = require("../astro");
+const script_1 = require("../context/script");
+/**
+ * Process the template to generate a ScriptContext.
+ */
+function processTemplate(ctx, resultTemplate) {
+    const script = new script_1.ScriptContext(ctx);
+    const frontmatter = resultTemplate.ast.children.find((n) => n.type === "frontmatter");
+    let fragmentOpened = false;
+    if (!frontmatter) {
+        script.appendScript("<>");
+        fragmentOpened = true;
+    }
+    (0, astro_1.walkElements)(resultTemplate.ast, (node, parent) => {
+        if (node.type === "frontmatter") {
+            const start = node.position.start.offset;
+            script.appendOriginal(start);
+            script.skipOriginalOffset(3);
+            const end = node.position.end.offset;
+            script.appendOriginal(end - 3);
+            script.appendScript(";<>");
+            fragmentOpened = true;
+            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) {
+                            result.ast.body.splice(index, 1);
+                            break;
+                        }
+                    }
+                }
+                return true;
+            });
+            script.addToken(types_1.AST_TOKEN_TYPES.Punctuator, [
+                node.position.start.offset,
+                node.position.start.offset + 3,
+            ]);
+            script.addToken(types_1.AST_TOKEN_TYPES.Punctuator, [end - 3, end]);
+        }
+        else if ((0, astro_1.isTag)(node)) {
+            for (const attr of node.attributes) {
+                if (attr.kind === "shorthand") {
+                    const start = attr.position.start.offset;
+                    script.appendOriginal(start);
+                    script.appendScript(`${attr.name}=`);
+                    script.addRestoreNodeProcess((scriptNode) => {
+                        if (scriptNode.type === types_1.AST_NODE_TYPES.JSXAttribute &&
+                            scriptNode.range[0] === start) {
+                            const attrNode = scriptNode;
+                            attrNode.type = "AstroShorthandAttribute";
+                            const locs = ctx.getLocations(...attrNode.value.expression.range);
+                            attrNode.name.range = locs.range;
+                            attrNode.name.loc = locs.loc;
+                            return true;
+                        }
+                        return false;
+                    });
+                }
+                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);
+                    script.appendOriginal(start);
+                    script.appendScript("{");
+                    script.appendOriginal(end);
+                    script.appendScript("}");
+                    script.addRestoreNodeProcess((scriptNode) => {
+                        if (scriptNode.type === types_1.AST_NODE_TYPES.JSXAttribute &&
+                            scriptNode.range[0] === attrStart) {
+                            const attrNode = scriptNode;
+                            attrNode.type = "AstroTemplateLiteralAttribute";
+                            return true;
+                        }
+                        return false;
+                    });
+                }
+            }
+            const end = getVoidSelfClosingTag(node, parent, ctx);
+            if (end && end.end === ">") {
+                script.appendOriginal(end.offset - 1);
+                script.appendScript("/");
+            }
+            if (node.name === "script" || node.name === "style") {
+                const text = node.children[0];
+                if (text && text.type === "text") {
+                    const styleNodeStart = node.position.start.offset;
+                    const start = text.position.start.offset;
+                    script.appendOriginal(start);
+                    script.skipOriginalOffset(text.value.length);
+                    script.addRestoreNodeProcess((scriptNode) => {
+                        if (scriptNode.type === types_1.AST_NODE_TYPES.JSXElement &&
+                            scriptNode.range[0] === styleNodeStart) {
+                            const textNode = Object.assign({ type: types_1.AST_NODE_TYPES.JSXText, value: text.value, raw: text.value, parent: scriptNode }, ctx.getLocations(start, start + text.value.length));
+                            scriptNode.children = [textNode];
+                            return true;
+                        }
+                        return false;
+                    });
+                    script.addToken(types_1.AST_TOKEN_TYPES.JSXText, [
+                        start,
+                        start + text.value.length,
+                    ]);
+                }
+            }
+        }
+        else if (node.type === "comment") {
+            const start = node.position.start.offset;
+            const length = 4 + node.value.length + 3;
+            script.appendOriginal(start);
+            let targetType;
+            if (fragmentOpened) {
+                script.appendScript(`<></>`);
+                targetType = types_1.AST_NODE_TYPES.JSXFragment;
+            }
+            else {
+                script.appendScript(`0;`);
+                targetType = types_1.AST_NODE_TYPES.ExpressionStatement;
+            }
+            script.skipOriginalOffset(length);
+            script.addRestoreNodeProcess((scriptNode) => {
+                if (scriptNode.range[0] === start &&
+                    scriptNode.type === targetType) {
+                    delete scriptNode.children;
+                    delete scriptNode.openingFragment;
+                    delete scriptNode.closingFragment;
+                    delete scriptNode.expression;
+                    const commentNode = scriptNode;
+                    commentNode.type = "AstroHTMLComment";
+                    commentNode.value = node.value;
+                    return true;
+                }
+                return false;
+            });
+            script.addToken("HTMLComment", [
+                start,
+                start + length,
+            ]);
+        }
+        else if (node.type === "doctype") {
+            const start = node.position.start.offset;
+            const end = node.position.end.offset;
+            script.appendOriginal(start);
+            let targetType;
+            if (fragmentOpened) {
+                script.appendScript(`<></>`);
+                targetType = types_1.AST_NODE_TYPES.JSXFragment;
+            }
+            else {
+                script.appendScript(`0;`);
+                targetType = types_1.AST_NODE_TYPES.ExpressionStatement;
+            }
+            script.skipOriginalOffset(end - start);
+            script.addRestoreNodeProcess((scriptNode) => {
+                if (scriptNode.range[0] === start &&
+                    scriptNode.type === targetType) {
+                    delete scriptNode.children;
+                    delete scriptNode.openingFragment;
+                    delete scriptNode.closingFragment;
+                    delete scriptNode.expression;
+                    const doctypeNode = scriptNode;
+                    doctypeNode.type = "AstroDoctype";
+                    return true;
+                }
+                return false;
+            });
+            script.addToken("HTMLDocType", [start, end]);
+        }
+    });
+    script.appendOriginal(ctx.code.length);
+    script.appendScript("</>");
+    return script;
+}
+exports.processTemplate = processTemplate;
+/**
+ * If the given tag is a void tag, get the self-closing tag.
+ */
+function getVoidSelfClosingTag(node, parent, ctx) {
+    if (node.type === "fragment") {
+        return false;
+    }
+    if (node.children.length > 0) {
+        return false;
+    }
+    const code = ctx.code;
+    let nextElementIndex = code.length;
+    const childIndex = parent.children.indexOf(node);
+    if (childIndex === parent.children.length - 1) {
+        // last
+        nextElementIndex = parent.position.end.offset;
+        nextElementIndex = code.lastIndexOf("</", nextElementIndex);
+    }
+    else {
+        const next = parent.children[childIndex + 1];
+        nextElementIndex = next.position.start.offset;
+    }
+    const endOffset = (0, astro_1.getStartTagEndOffset)(node, code);
+    if (code.slice(endOffset, nextElementIndex).trim()) {
+        // has end tag
+        return null;
+    }
+    return {
+        offset: endOffset,
+        end: code.slice(endOffset - 2, endOffset) === "/>" ? "/>" : ">",
+    };
+}

package/package.json

@@ -1,13 +1,13 @@
 {
     "name": "astro-eslint-parser",
-    "version": "0.0.0",
+    "version": "0.0.1",
     "description": "Astro parser for ESLint",
     "main": "lib/index.js",
     "files": [
         "lib"
     ],
     "engines": {
-        "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+        "node": "^14.17.0 || >=16.0.0"
     },
     "scripts": {
         "prebuild": "npm run -s clean",
@@ -43,7 +43,6 @@
     "dependencies": {
         "@astrojs/compiler": "^0.14.2",
         "debug": "^4.3.4",
-        "eslint-scope": "^7.0.0",
         "eslint-visitor-keys": "^3.0.0",
         "espree": "^9.0.0"
     },