feat(textlint-script): support import() (#1284)

* feat(textlint-script): support `import()`

textlint-script should not transpile `import()` to `require()`.
It will be required for ESM support.

* remove unused test

* test: normalize path

package.json

@@ -61,6 +61,7 @@
     "packages/@textlint/*",
     "packages/textlint-scripts/example",
     "packages/textlint-scripts/example-ts",
+    "packages/textlint-scripts/example-dynamic-import",
     "test/*",
     "website"
   ],

packages/@textlint/kernel/test/textlint-kernel-snapshots-test.ts

@@ -5,10 +5,14 @@ import { TextlintKernelOptions } from "../src/textlint-kernel-interface";
 import { TextlintKernel } from "../src";
 
 const SNAPSHOTS_DIRECTORY = path.join(__dirname, "snapshots");
+// normalize based on the OS
+const normalizePath = (value: string) => {
+    return path.sep === "\\" ? value.replace(/\\/g, "/") : value;
+};
 const pathReplacer = (dirPath: string) => {
     return function replacer(key: string, value: any) {
         if (key === "filePath") {
-            return value.replace(dirPath, "<root>");
+            return normalizePath(value.replace(dirPath, "<root>"));
         }
         return value;
     };

packages/textlint-scripts/configs/babel.config.js

@@ -11,7 +11,11 @@ module.exports = {
                 // https://babeljs.io/docs/en/babel-preset-env#targetsesmodules
                 targets: {
                     esmodules: true
-                }
+                },
+                // Allow to use native `import()` for loading ESM modules
+                // https://github.com/babel/babel/issues/10194
+                // TODO: It will not required in Babel 8
+                exclude: ["proposal-dynamic-import"]
             }
         ]
     ].concat(useTypeScript ? [["@babel/preset-typescript"]] : []),

packages/textlint-scripts/example-dynamic-import/.gitignore

@@ -0,0 +1,85 @@
+### https://raw.github.com/github/gitignore/608690d6b9a78c2a003affc792e49a84905b3118/Node.gitignore
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
+node_modules
+
+# Debug log from npm
+npm-debug.log
+
+
+### https://raw.github.com/github/gitignore/608690d6b9a78c2a003affc792e49a84905b3118/Global/JetBrains.gitignore
+
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+
+/lib

packages/textlint-scripts/example-dynamic-import/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "textlint-scripts-example-dynamic-import",
+  "version": "13.3.2",
+  "private": true,
+  "scripts": {
+    "build": "textlint-scripts build",
+    "test": "textlint-scripts test"
+  },
+  "dependencies": {
+  },
+  "devDependencies": {
+    "textlint-scripts": "^13.3.2"
+  }
+}

packages/textlint-scripts/example-dynamic-import/src/esm-worker.mjs

@@ -0,0 +1,3 @@
+export async function esmWorker() {
+    return "from esm";
+}

packages/textlint-scripts/example-dynamic-import/src/index.js

@@ -0,0 +1,14 @@
+export default function (context, options = {}) {
+    const { Syntax, RuleError, report, getSource } = context;
+    return {
+        async [Syntax.Document](node) {
+            const { esmWorker } = await import("./esm-worker.mjs");
+            const result = await esmWorker();
+            const text = getSource(node);
+            if (/valid/.test(text)) {
+                return;
+            }
+            report(node, new RuleError(`esmWorker result: ${result}`));
+        }
+    };
+}

packages/textlint-scripts/example-dynamic-import/test/index-test.js

@@ -0,0 +1,22 @@
+"use strict";
+// See https://github.com/textlint/textlint/tree/master/packages/textlint-tester
+import TextLintTester from "textlint-tester";
+// rule
+import rule from "../src/index";
+
+const tester = new TextLintTester();
+// ruleName, rule, { valid, invalid }
+tester.run("rule", rule, {
+    valid: ["valid"],
+    invalid: [
+        {
+            text: "error",
+            errors: [
+                {
+                    message: "esmWorker result: from esm",
+                    index: 0
+                }
+            ]
+        }
+    ]
+});