astro-eslint-parser 0.0.3 → 0.0.4

package/README.md

@@ -15,6 +15,10 @@ 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].
+
+[@astrojs/compiler]: https://github.com/withastro/compiler
+
 <!--
 ### ESLint Plugins Using astro-eslint-parser
 
@@ -75,7 +79,7 @@ For example:
 
 ### parserOptions.parser
 
-You can use `parserOptions.parser` property to specify a custom parser to parse `<script>` tags.
+You can use `parserOptions.parser` property to specify a custom parser to parse scripts.
 Other properties than parser would be given to the specified parser.
 For example:
 
@@ -88,7 +92,7 @@ For example:
 }
 ```
 
-For example, if you are using the `"@typescript-eslint/parser"`, and if you want to use TypeScript in `<script>` of `.astro`, you need to add more `parserOptions` configuration.
+For example, if you are using the `"@typescript-eslint/parser"`, and if you want to use TypeScript in `.astro`, you need to add more `parserOptions` configuration.
 
 ```js
 module.exports = {
@@ -97,13 +101,13 @@ module.exports = {
   parserOptions: {
     // ...
     project: "path/to/your/tsconfig.json",
-    extraFileExtensions: [".astro"], // This is a required setting in `@typescript-eslint/parser` v4.24.0.
+    extraFileExtensions: [".astro"], // This is a required setting in `@typescript-eslint/parser` v5.
   },
   overrides: [
     {
       files: ["*.astro"],
       parser: "astro-eslint-parser",
-      // Parse the `<script>` in `.astro` as TypeScript by adding the following configuration.
+      // Parse the script in `.astro` as TypeScript by adding the following configuration.
       parserOptions: {
         parser: "@typescript-eslint/parser",
       },
@@ -136,8 +140,7 @@ Example **.vscode/settings.json**:
 
 ## Compatibility With Existing ESLint Rules
 
-Most of the rules in the ESLint core work for the script part, but some rules are incompatible.
-For example, the [semi] rule doesn't work.  
+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.  
 
@@ -148,6 +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.
 
 <!-- - [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/ast.d.ts

@@ -1,5 +1,5 @@
 import type { TSESTree } from "@typescript-eslint/types";
-export declare type AstroNode = AstroProgram | AstroRootFragment | AstroHTMLComment | AstroDoctype | AstroShorthandAttribute | AstroTemplateLiteralAttribute;
+export declare type AstroNode = AstroProgram | AstroRootFragment | AstroHTMLComment | AstroDoctype | AstroShorthandAttribute | AstroTemplateLiteralAttribute | AstroRawText;
 /** Node of Astro program root */
 export interface AstroProgram extends Omit<TSESTree.Program, "type" | "body"> {
     type: "Program";
@@ -40,3 +40,8 @@ export interface AstroTemplateLiteralAttribute extends Omit<TSESTree.JSXAttribut
     };
     parent: TSESTree.JSXElement | TSESTree.JSXFragment;
 }
+/** Node of Astro raw text */
+export interface AstroRawText extends Omit<TSESTree.JSXText, "type" | "parent"> {
+    type: "AstroRawText";
+    parent: AstroRootFragment | TSESTree.JSXElement | TSESTree.JSXFragment;
+}

package/lib/parser/process-template.js

@@ -147,8 +147,10 @@ function processTemplate(ctx, resultTemplate) {
                     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];
+                            const textNode = Object.assign({ type: "AstroRawText", value: text.value, raw: text.value, parent: scriptNode }, ctx.getLocations(start, start + text.value.length));
+                            scriptNode.children = [
+                                textNode,
+                            ];
                             return true;
                         }
                         return false;

package/lib/visitor-keys.js

@@ -9,5 +9,6 @@ const astroKeys = {
     AstroDoctype: [],
     AstroShorthandAttribute: ["name", "value"],
     AstroTemplateLiteralAttribute: ["name", "value"],
+    AstroRawText: [],
 };
 exports.KEYS = (0, eslint_visitor_keys_1.unionWith)(astroKeys);

package/package.json

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