fix(deps): update modules and make Pure ESM (#31)

azu · web-flow · commit 3c3f2100d81a · 2022-11-20T17:32:30.000+09:00
BREAKING CHANGE: Require Node.js &gt;=14.16
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ This command line tools generate textlint rule project files by one command.
 
 Install with [npm](https://www.npmjs.com/):
 
-    npm install create-textlint-rule -g
+    npm install --global create-textlint-rule
     # Or
     npx create-textlint-rule
 
diff --git a/bin/cmd.js b/bin/cmd.js
@@ -1,10 +1,13 @@
 #!/usr/bin/env node
-"use strict";
-const meow = require("meow");
-const chalk = require("chalk");
-const updateNotifier = require("update-notifier");
-const pkg = require("../package.json");
-const cliHandler = require("../lib/cli-handler");
+import meow from "meow";
+import chalk from "chalk";
+import updateNotifier from "update-notifier";
+import cliHandler from "../lib/cli-handler.js";
+import { readFile } from "node:fs/promises";
+export const getPackageInfo = async () => {
+    const pkg = await readFile(new URL("../package.json", import.meta.url));
+    return JSON.parse(pkg);
+};
 const cli = meow(
     `
     Usage
@@ -25,9 +28,9 @@ const cli = meow(
       $ create-textlint-rule example --typescript
 `,
     {
-        alias: {
-            h: "help"
-        }
+        importMeta: import.meta,
+        autoHelp: true,
+        autoVersion: true
     }
 );
 /*
@@ -38,7 +41,7 @@ const cli = meow(
  }
  */
 updateNotifier({
-    pkg: pkg,
+    pkg: await getPackageInfo(),
     updateCheckInterval: 1000 * 60 * 60 * 24 * 7
 }).notify();
 
diff --git a/lib/cli-handler.js b/lib/cli-handler.js
@@ -1,19 +1,17 @@
-// MIT © 2016 azu
-"use strict";
-const path = require("path");
-const chalk = require("chalk");
-const createTextlintRule = require("./scripts/create-textlint-rule");
+import chalk from "chalk";
+import createTextlintRule from "./scripts/create-textlint-rule.js";
+
 /**
  * @param {string} projectName
  * @param {{
- *      yes: boolean
- *      yarn: boolean
+ *      yes: boolean,
+ *      yarn: boolean,
  *      cwd: string
  *  }} options
  * @returns {Promise<any | never>}
  */
-module.exports = function (projectName, options = {}) {
+export default function (projectName, options = {}) {
     return createTextlintRule(projectName, options).then(() => {
         console.log(chalk.green(`✔ Complete: Let's write textlint rule`));
     });
-};
+}
diff --git a/lib/scripts/create-textlint-rule.js b/lib/scripts/create-textlint-rule.js
@@ -1,22 +1,20 @@
-// MIT © 2016 azu
-"use strict";
-const spawn = require("cross-spawn-promise");
-const path = require("path");
-const rimraf = require("rimraf");
-const chalk = require("chalk");
+import rimraf from "rimraf";
+import chalk from "chalk";
+import spawn from "cross-spawn-promise";
+import path from "node:path";
 
 /**
  * @see https://github.com/textlint/textlint-rule-template
  * @param {string} projectName
  * @param {{
- *      yes: boolean
- *      yarn: boolean
- *      typescript: boolean
+ *      yes: boolean,
+ *      yarn: boolean,
+ *      typescript: boolean,
  *      cwd: string
  * }} [options]
  * @returns {Promise}
  */
-module.exports = function (projectName, options = {}) {
+export default function (projectName, options = {}) {
     const useYarn = options.yarn !== undefined;
     const useYes = options.yes !== undefined;
     const useTypeScript = options.typescript !== undefined;
@@ -71,4 +69,4 @@ module.exports = function (projectName, options = {}) {
             console.log(chalk.green(`Initialize your README!`));
             return spawn(`./node_modules/.bin/textlint-scripts`, ["init"], { stdio: "inherit" });
         });
-};
+}
diff --git a/package.json b/package.json
@@ -1,65 +1,64 @@
 {
-  "directories": {
-    "test": "test"
-  },
-  "author": "azu",
-  "license": "MIT",
-  "files": [
-    "bin/",
-    "lib/"
-  ],
   "name": "create-textlint-rule",
   "version": "1.5.0",
   "description": "Create textlint rule project with no configuration.",
-  "main": "lib/create-textlint-rule.js",
-  "bin": {
-    "create-textlint-rule": "bin/cmd.js"
-  },
-  "scripts": {
-    "test": "./test/test.sh",
-    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,css}\"",
-    "prepare": "git config --local core.hooksPath .githooks"
-  },
   "keywords": [
     "textlint",
     "tools",
     "development",
     "rule"
   ],
+  "homepage": "https://github.com/textlint/create-textlint-rule",
+  "bugs": {
+    "url": "https://github.com/textlint/create-textlint-rule/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/textlint/create-textlint-rule.git"
   },
-  "bugs": {
-    "url": "https://github.com/textlint/create-textlint-rule/issues"
+  "license": "MIT",
+  "author": "azu",
+  "type": "module",
+  "main": "lib/create-textlint-rule.js",
+  "bin": {
+    "create-textlint-rule": "bin/cmd.js"
   },
-  "homepage": "https://github.com/textlint/create-textlint-rule",
-  "dependencies": {
-    "chalk": "^4.1.2",
-    "cross-spawn": "^7.0.3",
-    "cross-spawn-promise": "^0.10.2",
-    "meow": "^7.1.1",
-    "rimraf": "^3.0.2",
-    "update-notifier": "^5.1.0"
+  "directories": {
+    "test": "test"
   },
-  "devDependencies": {
-    "lint-staged": "^13.0.3",
-    "prettier": "^2.7.1"
+  "files": [
+    "bin/",
+    "lib/"
+  ],
+  "engines": {
+    "node": ">=14.16"
+  },
+  "scripts": {
+    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,css}\"",
+    "prepare": "git config --local core.hooksPath .githooks",
+    "test": "./test/test.sh"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,css}": [
+      "prettier --write"
+    ]
   },
   "prettier": {
-    "singleQuote": false,
     "printWidth": 120,
+    "singleQuote": false,
     "tabWidth": 4,
     "trailingComma": "none"
   },
-  "husky": {
-    "hooks": {
-      "precommit": "lint-staged"
-    }
+  "dependencies": {
+    "chalk": "^5.1.2",
+    "cross-spawn": "^7.0.3",
+    "cross-spawn-promise": "^0.10.2",
+    "meow": "^11.0.0",
+    "rimraf": "^3.0.2",
+    "update-notifier": "^6.0.2"
   },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx,css}": [
-      "prettier --write"
-    ]
+  "devDependencies": {
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1"
   }
 }
diff --git a/test/test.sh b/test/test.sh
@@ -5,9 +5,17 @@ declare currentDir=$(cd $(dirname $0);pwd)
 declare dirName=$(basename "${currentDir}")
 declare parentDir=$(dirname "${currentDir}")
 declare testRuleName="test-rule-name";
+# test for js
 echo "Run: create-textlint-rule ${test-rule-name}"
 cd ${currentDir}
 node ${parentDir}/bin/cmd.js "${testRuleName}" --yes
+ls "${currentDir}/textlint-rule-${testRuleName}/package.json" # check file
+rm -rf "${currentDir}/textlint-rule-${testRuleName}"
+# test for ts
+echo "Run: create-textlint-rule ${test-rule-name} --typescript"
+cd ${currentDir}
+node ${parentDir}/bin/cmd.js "${testRuleName}" --yes --typescript
+ls "${currentDir}/textlint-rule-${testRuleName}/package.json" # check file
 rm -rf "${currentDir}/textlint-rule-${testRuleName}"
 # test .
 echo "Run: create-textlint-rule ."
diff --git a/yarn.lock b/yarn.lock
