astro-eslint-parser 0.1.0 → 0.2.0

package/README.md

@@ -21,14 +21,19 @@ At least it works fine with a [fork of the `astro.build` repository](https://git
 
 [@astrojs/compiler]: https://github.com/withastro/compiler
 
-<!--
+## :checkered_flag: Motivation
+
+This parser allows us to lint the script of `.astro` files.
+
+> Note that this parser alone will not lint the scripts inside the `<script>` tag. Use [eslint-plugin-astro] to lint the script inside the `<script>` tag as well.
+
 ### ESLint Plugins Using astro-eslint-parser
 
-#### [@ota-meshi/eslint-plugin-astro](https://ota-meshi.github.io/eslint-plugin-astro/)
+#### [eslint-plugin-astro]
 
 ESLint plugin for Astro component.  
-It provides many unique check rules by using the template AST.
--->
+
+[eslint-plugin-astro]: https://ota-meshi.github.io/eslint-plugin-astro/
 
 ## 💿 Installation
 
@@ -60,7 +65,7 @@ npm install --save-dev eslint astro-eslint-parser
     $ eslint src --ext .js,.astro
     ```
 
-The commit diff [here](https://github.com/ota-meshi/astro.build/commit/7f291ac15e6d97cc20a64b8f97dcbd85379759b5) is an example of introducing this parser to the `astro.build` repository.
+The commit diff [here](https://github.com/withastro/astro.build/compare/main...ota-meshi:eslint) is an example of introducing this parser to the `astro.build` repository.
 
 ## 🔧 Options
 
@@ -152,6 +157,14 @@ For example, the [react/jsx-no-target-blank] rule works fine.
 [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
 
+## :ghost: Limitations
+
+If this parser is used with `@typescript-eslint/parser` and `parserOptions.project` is set, it will temporarily create a `.tsx` file to parse the `.astro` file.  
+This parser works by converting the `.astro` file to JSX and letting the JavaScript parser parse it.
+Since `@typescript-eslint/parser` can only parse files with the extension `.tsx` as JSX, it is necessary to temporarily create a `.tsx` file. Temporarily created files will try to be deleted after parses, but if the parsing takes a long time, the files may be visible to you.
+
+See also [`@typescript-eslint/parser` readme](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/parser#parseroptionsecmafeaturesjsx).
+
 ## :hammer_and_wrench: Usage for Custom Rules / Plugins
 
 - TBA

package/lib/context/resolve-parser/espree.js

@@ -4,23 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getEspree = void 0;
-const module_1 = __importDefault(require("module"));
+const module_1 = require("module");
 const path_1 = __importDefault(require("path"));
-const createRequire = 
-// Added in v12.2.0
-module_1.default.createRequire ||
-    // Added in v10.12.0, but deprecated in v12.2.0.
-    // @ts-expect-error -- old type
-    module_1.default.createRequireFromPath ||
-    // Polyfill - This is not executed on the tests on node@>=10.
-    /* istanbul ignore next */
-    ((modName) => {
-        const mod = new module_1.default(modName);
-        mod.filename = modName;
-        mod.paths = module_1.default._nodeModulePaths(path_1.default.dirname(modName));
-        mod._compile("module.exports = require;", modName);
-        return mod.exports;
-    });
 let espreeCache = null;
 /** Checks if given path is linter path */
 function isLinterPath(p) {
@@ -40,7 +25,7 @@ function getEspree() {
         const linterPath = Object.keys(require.cache || {}).find(isLinterPath);
         if (linterPath) {
             try {
-                espreeCache = createRequire(linterPath)("espree");
+                espreeCache = (0, module_1.createRequire)(linterPath)("espree");
             }
             catch {
                 // ignore

package/lib/parser/script.js

@@ -1,27 +1,26 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseScript = void 0;
-const fs_1 = __importDefault(require("fs"));
 const debug_1 = require("../debug");
+const ts_patch_1 = require("./ts-patch");
 /**
  * Parse for script
  */
 function parseScript(code, _ctx, parserOptions) {
     const parser = parserOptions.getParser();
-    let removeFile = null;
+    let patchResult;
     try {
-        const scriptParserOptions = { ...parserOptions.parserOptions };
+        const scriptParserOptions = {
+            ...parserOptions.parserOptions,
+        };
+        scriptParserOptions.ecmaFeatures = {
+            ...(scriptParserOptions.ecmaFeatures || {}),
+            jsx: true,
+        };
         if (parserOptions.isTypeScript() &&
             scriptParserOptions.filePath &&
             scriptParserOptions.project) {
-            scriptParserOptions.filePath += ".tsx";
-            if (!fs_1.default.existsSync(scriptParserOptions.filePath)) {
-                fs_1.default.writeFileSync(scriptParserOptions.filePath, "/* temp for astro-eslint-parser */");
-                removeFile = scriptParserOptions.filePath;
-            }
+            patchResult = (0, ts_patch_1.tsPatch)(scriptParserOptions);
         }
         const result = parser.parseForESLint?.(code, scriptParserOptions) ??
             parser.parse?.(code, scriptParserOptions);
@@ -37,8 +36,7 @@ ${code}`);
         throw e;
     }
     finally {
-        if (removeFile)
-            fs_1.default.unlinkSync(removeFile);
+        patchResult?.terminate();
     }
 }
 exports.parseScript = parseScript;

package/lib/parser/ts-patch.d.ts

@@ -0,0 +1,8 @@
+import type { ParserOptions } from "@typescript-eslint/types";
+export declare type PatchTerminate = {
+    terminate: () => void;
+};
+/**
+ * Apply a patch to parse .astro files as TSX.
+ */
+export declare function tsPatch(scriptParserOptions: ParserOptions): PatchTerminate | null;

package/lib/parser/ts-patch.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tsPatch = void 0;
+const module_1 = require("module");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+/**
+ * Apply a patch to parse .astro files as TSX.
+ */
+function tsPatch(scriptParserOptions) {
+    try {
+        // Apply a patch to parse .astro files as TSX.
+        const cwd = process.cwd();
+        const relativeTo = path_1.default.join(cwd, "__placeholder__.js");
+        const ts = (0, module_1.createRequire)(relativeTo)("typescript");
+        const { ensureScriptKind, getScriptKindFromFileName } = ts;
+        if (typeof ensureScriptKind === "function" &&
+            typeof getScriptKindFromFileName === "function") {
+            ts.ensureScriptKind = function (fileName, ...args) {
+                if (fileName.endsWith(".astro")) {
+                    return ts.ScriptKind.TSX;
+                }
+                return ensureScriptKind.call(this, fileName, ...args);
+            };
+            ts.getScriptKindFromFileName = function (fileName, ...args) {
+                if (fileName.endsWith(".astro")) {
+                    return ts.ScriptKind.TSX;
+                }
+                return getScriptKindFromFileName.call(this, fileName, ...args);
+            };
+            return {
+                terminate() {
+                    ts.ensureScriptKind = ensureScriptKind;
+                    ts.getScriptKindFromFileName = getScriptKindFromFileName;
+                },
+            };
+        }
+    }
+    catch {
+        // ignore
+    }
+    // If the patch cannot be applied, create a tsx file and parse it.
+    const tsxFilePath = `${scriptParserOptions.filePath}.tsx`;
+    scriptParserOptions.filePath = tsxFilePath;
+    if (!fs_1.default.existsSync(tsxFilePath)) {
+        fs_1.default.writeFileSync(tsxFilePath, "/* temp for astro-eslint-parser */");
+        return {
+            terminate() {
+                fs_1.default.unlinkSync(tsxFilePath);
+            },
+        };
+    }
+    return null;
+}
+exports.tsPatch = tsPatch;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "astro-eslint-parser",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "description": "Astro component parser for ESLint",
     "main": "lib/index.js",
     "files": [
@@ -42,7 +42,7 @@
     },
     "homepage": "https://github.com/ota-meshi/astro-eslint-parser#readme",
     "dependencies": {
-        "@astrojs/compiler": "^0.14.3",
+        "@astrojs/compiler": "^0.15.0",
         "@typescript-eslint/types": "^5.25.0",
         "debug": "^4.3.4",
         "eslint-visitor-keys": "^3.0.0",
@@ -63,13 +63,14 @@
         "@types/semver": "^7.3.9",
         "@typescript-eslint/eslint-plugin": "^5.4.0",
         "@typescript-eslint/parser": "^5.4.0",
-        "astro-eslint-parser": ">=0.0.15",
+        "astro-eslint-parser": ">=0.1.0",
         "benchmark": "^2.1.4",
         "chai": "^4.3.4",
         "code-red": "^0.2.3",
         "eslint": "^8.15.0",
         "eslint-config-prettier": "^8.3.0",
         "eslint-formatter-codeframe": "^7.32.1",
+        "eslint-plugin-astro": "^0.2.0",
         "eslint-plugin-eslint-comments": "^3.2.0",
         "eslint-plugin-json-schema-validator": "^3.0.0",
         "eslint-plugin-jsonc": "^2.0.0",
@@ -91,6 +92,6 @@
         "string-replace-loader": "^3.0.3",
         "svelte": "^3.48.0",
         "ts-node": "^10.4.0",
-        "typescript": "~4.6.0"
+        "typescript": "~4.7.0"
     }
 }