feat: support TypeScript test case

Author: azu

bin/cmd.js

@@ -3,6 +3,7 @@ import meow from "meow";
 import concat from "concat-stream";
 import create from "../src/create-textlint-rule-example.js";
 import fs from "fs";
+
 const cli = meow(
     `
     Usage
@@ -15,14 +16,18 @@ const cli = meow(
         importMeta: import.meta
     }
 );
-const file = process.argv[2];
-const input = file && file !== "-" ? fs.createReadStream(process.argv[2]) : process.stdin;
+const filePath = process.argv[2];
+const input = filePath && filePath !== "-" ? fs.createReadStream(process.argv[2]) : process.stdin;
 input.pipe(
     concat(function (buf) {
+        const content = buf.toString("utf8");
         console.log(
-            create(buf.toString("utf8"), {
-                exampleSeparator: cli.flags.separator
-            })
+            create(
+                { content, filePath },
+                {
+                    exampleSeparator: cli.flags.separator
+                }
+            )
         );
     })
 );

package.json

@@ -39,6 +39,7 @@
   "dependencies": {
     "@babel/core": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
+    "@babel/preset-typescript": "^7.13.0",
     "clone": "^2.1.1",
     "concat-stream": "^2.0.0",
     "lodash.uniq": "^4.5.0",

src/create-textlint-rule-example.js

@@ -11,15 +11,18 @@ const defaultOptions = {
 };
 /**
  * Create example text from `content`
- * @param {string} content
+ * @param {{content:string, filePath:string}}
  * @param {Object} options
  * @returns {string}
  */
-export default function (content, options = {}) {
+export default function ({ content, filePath }, options = {}) {
     const prependValidExample = options.prependValidExample || defaultOptions.prependValidExample;
     const prependInValidExample = options.prependInValidExample || defaultOptions.prependInValidExample;
     const exampleSeparator = (options.exampleSeparator || defaultOptions.exampleSeparator).replace(/\\n/g, "\n");
-    const { ruleName, valid, invalid } = getRuleTest(content);
+    const { ruleName, valid, invalid } = getRuleTest({
+        content,
+        filePath
+    });
     const plainValid = valid.filter((text) => typeof text === "string");
     const plainInvalid = invalid.filter((test) => {
         return test.options === undefined && test.ext === undefined;

src/get-rule-test.js

@@ -5,15 +5,17 @@ import babel from "@babel/core";
 import { calls } from "./mock-textlint-tester.js";
 import MockTextlintRuleTester from "./mock-textlint-tester.js";
 import { createRequire } from "module";
+import path from "path";
+
 /**
  * Helper for unit testing:
  * - load module with mocked dependencies
  * - allow accessing private state of the module
  *
- * @param {string} content
+ * @param {{content:string, filePath:string}}
  * @param {Object=} mocks Hash of mocked dependencies
  */
-export default function loadModule(content, mocks = {}) {
+export default function loadModule({ content, filePath }, mocks = {}) {
     const exports = {};
     const context = {
         require: function (name) {
@@ -34,7 +36,8 @@ export default function loadModule(content, mocks = {}) {
     };
     const require = createRequire(import.meta.url);
     const result = babel.transform(content, {
-        presets: [require.resolve("@babel/preset-env")]
+        filename: path.basename(filePath),
+        presets: [require.resolve("@babel/preset-env"), require.resolve("@babel/preset-typescript")]
     });
     vm.runInNewContext(result.code, context);
     return calls;

test/create-textlint-rule-example-test.js

@@ -4,13 +4,15 @@ import assert from "assert";
 import fs from "fs";
 import createExample from "../src/create-textlint-rule-example.js";
 import url from "url";
+
 describe("create-textlint-rule-example", () => {
     it("should return output", () => {
-        const content = fs.readFileSync(
-            url.fileURLToPath(new URL("fixtures/no-todo/test/no-todo-test.js", import.meta.url)),
-            "utf-8"
-        );
-        const output = createExample(content);
+        const filePath = url.fileURLToPath(new URL("fixtures/no-todo/test/no-todo-test.js", import.meta.url));
+        const content = fs.readFileSync(filePath, "utf-8");
+        const output = createExample({
+            content,
+            filePath
+        });
         assert(typeof output === "string");
         assert(output.length > 0);
     });

test/get-rule-test-test.js

@@ -7,11 +7,9 @@ import fs from "fs";
 
 describe("get-rule-data", () => {
     it("should return {valid,invalid,ruleName}", () => {
-        const content = fs.readFileSync(
-            url.fileURLToPath(new URL("fixtures/no-todo/test/no-todo-test.js", import.meta.url)),
-            "utf-8"
-        );
-        const calls = getRuleTest(content);
+        const filePath = url.fileURLToPath(new URL("fixtures/no-todo/test/no-todo-test.js", import.meta.url));
+        const content = fs.readFileSync(filePath, "utf-8");
+        const calls = getRuleTest({ content, filePath });
         assert(typeof calls.ruleName === "string");
         assert(Array.isArray(calls.valid));
         assert(Array.isArray(calls.invalid));

yarn.lock

@@ -491,6 +491,13 @@
   dependencies:
     "@babel/helper-plugin-utils" "^7.12.13"
 
+"@babel/plugin-syntax-typescript@^7.12.13":
+  version "7.12.13"
+  resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.12.13.tgz#9dff111ca64154cef0f4dc52cf843d9f12ce4474"
+  integrity sha512-cHP3u1JiUiG2LFDKbXnwVad81GvfyIOmCD6HIEId6ojrY0Drfy2q1jw7BwN7dE84+kTnBjLkXoL3IEy/3JPu2w==
+  dependencies:
+    "@babel/helper-plugin-utils" "^7.12.13"
+
 "@babel/plugin-transform-arrow-functions@^7.13.0":
   version "7.13.0"
   resolved "https://registry.yarnpkg.com/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.13.0.tgz#10a59bebad52d637a027afa692e8d5ceff5e3dae"
@@ -724,6 +731,15 @@
   dependencies:
     "@babel/helper-plugin-utils" "^7.12.13"
 
+"@babel/plugin-transform-typescript@^7.13.0":
+  version "7.13.0"
+  resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.13.0.tgz#4a498e1f3600342d2a9e61f60131018f55774853"
+  integrity sha512-elQEwluzaU8R8dbVuW2Q2Y8Nznf7hnjM7+DSCd14Lo5fF63C9qNLbwZYbmZrtV9/ySpSUpkRpQXvJb6xyu4hCQ==
+  dependencies:
+    "@babel/helper-create-class-features-plugin" "^7.13.0"
+    "@babel/helper-plugin-utils" "^7.13.0"
+    "@babel/plugin-syntax-typescript" "^7.12.13"
+
 "@babel/plugin-transform-unicode-escapes@^7.12.13":
   version "7.12.13"
   resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.12.13.tgz#840ced3b816d3b5127dd1d12dcedc5dead1a5e74"
@@ -829,6 +845,15 @@
     "@babel/types" "^7.4.4"
     esutils "^2.0.2"
 
+"@babel/preset-typescript@^7.13.0":
+  version "7.13.0"
+  resolved "https://registry.yarnpkg.com/@babel/preset-typescript/-/preset-typescript-7.13.0.tgz#ab107e5f050609d806fbb039bec553b33462c60a"
+  integrity sha512-LXJwxrHy0N3f6gIJlYbLta1D9BDtHpQeqwzM0LIfjDlr6UE/D5Mc7W4iDiQzaE+ks0sTjT26ArcHWnJVt0QiHw==
+  dependencies:
+    "@babel/helper-plugin-utils" "^7.13.0"
+    "@babel/helper-validator-option" "^7.12.17"
+    "@babel/plugin-transform-typescript" "^7.13.0"
+
 "@babel/runtime@^7.8.4":
   version "7.14.0"
   resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.14.0.tgz#46794bc20b612c5f75e62dd071e24dfd95f1cbe6"