update README (#3)

* update README

* Create tricky-plums-sit.md

* fix

Author: ota-meshi

Diff for: .changeset/tricky-plums-sit.md

@@ -0,0 +1,5 @@
+---
+"typescript-eslint-parser-for-extra-files": patch
+---
+
+update README

Diff for: README.md

@@ -75,16 +75,26 @@ npm install --save-dev astrojs-compiler-sync@latest @astrojs/compiler
 {
     // ....
     "overrides": [
+        {
+            "files": ["*.ts", "*.tsx"],
+            "parser": "typescript-eslint-parser-for-extra-files",
+            "parserOptions": {
+                "project": "./your/tsconfig.json"
+                // ....
+            },
+            // ....
+        },
         {
             "files": ["*.vue"],
             "parser": "vue-eslint-parser",
             "parserOptions": {
-                "parser": require('typescript-eslint-parser-for-extra-files'),
+                "parser": require("typescript-eslint-parser-for-extra-files"),
                 // Or
                 // "parser": {
-                //     "ts": require('typescript-eslint-parser-for-extra-files')
+                //     "ts": require("typescript-eslint-parser-for-extra-files")
                 // }
                 "project": "./your/tsconfig.json"
+                // ....
             },
             // ....
         }
@@ -100,16 +110,26 @@ npm install --save-dev astrojs-compiler-sync@latest @astrojs/compiler
 {
     // ....
     "overrides": [
+        {
+            "files": ["*.ts", "*.tsx"],
+            "parser": "typescript-eslint-parser-for-extra-files",
+            "parserOptions": {
+                "project": "./your/tsconfig.json"
+                // ....
+            },
+            // ....
+        },
         {
             "files": ["*.svelte"],
             "parser": "svelte-eslint-parser",
             "parserOptions": {
-                "parser": require('typescript-eslint-parser-for-extra-files'),
+                "parser": require("typescript-eslint-parser-for-extra-files"),
                 // Or
                 // "parser": {
-                //     "ts": require('typescript-eslint-parser-for-extra-files')
+                //     "ts": require("typescript-eslint-parser-for-extra-files")
                 // }
                 "project": "./your/tsconfig.json"
+                // ....
             },
             // ....
         }
@@ -125,12 +145,22 @@ npm install --save-dev astrojs-compiler-sync@latest @astrojs/compiler
 {
     // ....
     "overrides": [
+        {
+            "files": ["*.ts", "*.tsx"],
+            "parser": "typescript-eslint-parser-for-extra-files",
+            "parserOptions": {
+                "project": "./your/tsconfig.json"
+                // ....
+            },
+            // ....
+        },
         {
             "files": ["*.astro"],
             "parser": "astro-eslint-parser",
             "parserOptions": {
-                "parser": require('typescript-eslint-parser-for-extra-files'),
+                "parser": require("typescript-eslint-parser-for-extra-files"),
                 "project": "./your/tsconfig.json"
+                // ....
             },
             // ....
         }
@@ -140,6 +170,15 @@ npm install --save-dev astrojs-compiler-sync@latest @astrojs/compiler
 }
 ```
 
+## 👻 Limitations
+
+- Angle bracket type assertions cannot be used.
+
+This parser parses as JSX enabled.  
+Therefore, angle bracket type assertions cannot be used. Use the `as` operator instead.
+
+[The TypeScript Handbook - JSX > The `as` operator](https://www.typescriptlang.org/docs/handbook/jsx.html#the-as-operator)
+
 ## 🍻 Contributing
 
 Welcome contributing!

Diff for: tests/src/types.ts

@@ -153,7 +153,10 @@ describe("Template Types", () => {
         try {
           assert.strictEqual(actual, expected);
         } catch (e) {
-          fs.writeFileSync(path.join(ROOT, `${name}/actual-types.vue`), actual);
+          fs.writeFileSync(
+            sourcePath.replace(/source\.([a-z]+)$/u, "actual-types.$1"),
+            actual
+          );
           throw e;
         }
       });