refactor(rule): Convert to TypeScript (#2)

* refactor(rule): Convert to TypeScript

* chore(deps): update untildify

* CI: move to GitHub Actions

Author: azu

.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: test
+on: [push, pull_request]
+jobs:
+  test:
+    name: "Test on Node.js ${{ matrix.node-version }}"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12, 14]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install
+        run: yarn install
+      - name: Test
+        run: yarn test

.travis.yml

@@ -1,4 +1,4 @@
-# @textlint-ja/textlint-rule-morpheme-match [![Build Status](https://travis-ci.org/textlint-ja/textlint-rule-morpheme-match.svg?branch=master)](https://travis-ci.org/textlint-ja/textlint-rule-morpheme-match)
+# @textlint-ja/textlint-rule-morpheme-match [![Actions Status: test](https://github.com/textlint-ja/textlint-rule-morpheme-match/workflows/test/badge.svg)](https://github.com/textlint-ja/textlint-rule-morpheme-match/actions?query=workflow%3A"test")
 
 形態素解析結果のTokenベースの辞書でマッチするtextlintルール。
 

README.md

@@ -38,10 +38,14 @@
     "tabWidth": 4
   },
   "devDependencies": {
+    "@textlint/types": "^1.5.4",
+    "@types/node": "^14.14.41",
     "husky": "^1.2.0",
-    "lint-staged": "^8.1.0",
-    "prettier": "^1.15.3",
-    "textlint-scripts": "^2.1.0"
+    "lint-staged": "^10.5.4",
+    "prettier": "^2.2.1",
+    "textlint-scripts": "^3.0.0",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.2.4"
   },
   "publishConfig": {
     "access": "public"
@@ -58,8 +62,8 @@
     ]
   },
   "dependencies": {
-    "kuromojin": "^1.4.0",
-    "morpheme-match-textlint": "^2.0.0",
-    "untildify": "^3.0.3"
+    "kuromojin": "^2.0.0",
+    "morpheme-match-textlint": "^2.0.3",
+    "untildify": "^4.0.0"
   }
 }

package.json

@@ -1,39 +1,19 @@
 "use strict";
+import { TextlintRuleModule, TextlintRuleReporter } from "@textlint/types";
 import { createTextlintMatcher } from "morpheme-match-textlint";
+import { tokenize } from "kuromojin";
+import path from "path";
+import untildify from "untildify";
 
-const tokenize = require("kuromojin").tokenize;
-const path = require("path");
-const untildify = require("untildify");
-
-/**
- * Replace text with tokens
- * @param text
- * @param tokens
- * @param actualTokens
- * @returns {*}
- */
-const replaceWithCaptureTokens = (text, tokens, actualTokens) => {
-    let resultText = text;
-    tokens.forEach((token, index) => {
-        // when the node has not `_capture_`, does not replace it
-        if (!token._capture) {
-            return;
-        }
-        const actualToken = actualTokens[index];
-        resultText = resultText.replace(token._capture, actualToken.surface_form);
-    });
-    return resultText;
-};
-
-const flat = (array) => {
-    return array.reduce((total, item) => total.concat(item), []);
+const flat = <T>(array: T[]): T[] => {
+    return array.reduce((total, item) => total.concat(item), [] as T[]);
 };
 /**
  * load dictionary file(.js or .json) and return it
  * @param {string} baseDirectory base directory
  * @param {string} dictionaryFilePath .js or .json path list
  */
-const loadDictionary = (baseDirectory, dictionaryFilePath) => {
+const loadDictionary = (baseDirectory: string, dictionaryFilePath: string) => {
     const untildifiedFilePath = untildify(dictionaryFilePath);
     try {
         const absoluteFilePath = path.resolve(baseDirectory, untildifiedFilePath);
@@ -48,7 +28,7 @@ const loadDictionary = (baseDirectory, dictionaryFilePath) => {
  * @param {string} baseDirectory base directory
  * @param {string[]} dictionaryFilePathList dictionary file list
  */
-const loadDictionaries = (baseDirectory, dictionaryFilePathList) => {
+const loadDictionaries = (baseDirectory: string, dictionaryFilePathList: string[]) => {
     const contents = dictionaryFilePathList.map(filePath => loadDictionary(baseDirectory, filePath));
     return flat(contents);
 };
@@ -58,7 +38,7 @@ const loadDictionaries = (baseDirectory, dictionaryFilePathList) => {
  * @param {{dictionaryPathList:string[]}} options
  * @returns {*}
  */
-const reporter = (context, options) => {
+const reporter: TextlintRuleReporter = (context, options = {}) => {
     const { Syntax, RuleError, report, fixer, getSource } = context;
     if (!options.dictionaryPathList) {
         throw new Error(`You should set "dictionaryPathList" options.
@@ -103,7 +83,8 @@ const reporter = (context, options) => {
         }
     };
 };
-module.exports = {
+
+export default {
     linter: reporter,
     fixer: reporter
-};
+} as TextlintRuleModule;

src/textlint-rule-morpheme-match.js src/textlint-rule-morpheme-match.tssrc/textlint-rule-morpheme-match.js renamed to src/textlint-rule-morpheme-match.ts

@@ -1,7 +1,7 @@
-const path = require("path");
-const TextLintTester = require("textlint-tester");
+import TextLintTester from "textlint-tester";
+import path from "path";
 const tester = new TextLintTester();
-const rule = require("../src/textlint-rule-morpheme-match.js");
+import rule from "../src/textlint-rule-morpheme-match";
 const options = {
     dictionaryPathList: [path.join(__dirname, "fixtures/dictionary.js")]
 };
@@ -14,7 +14,7 @@ tester.run("textlint-rule-ja-no-redundant-expression", rule, {
     valid: [
         { text: "text", options },
         { text: "長さは可変だ", options: multipleDictOptions },
-        { text: "人は1人では育つことができない", options },
+        { text: "人は1人では育つことができない", options }
     ],
     invalid: [
         {

test/textlint-rule-morpheme-match-test.js test/textlint-rule-morpheme-match-test.tstest/textlint-rule-morpheme-match-test.js renamed to test/textlint-rule-morpheme-match-test.ts

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "noEmit": true,
+    "target": "es2015",
+    /* Strict Type-Checking Options */
+    "strict": true,
+    /* Additional Checks */
+    /* Report errors on unused locals. */
+    "noUnusedLocals": true,
+    /* Report errors on unused parameters. */
+    "noUnusedParameters": true,
+    /* Report error when not all code paths in function return a value. */
+    "noImplicitReturns": true,
+    /* Report errors for fallthrough cases in switch statement. */
+    "noFallthroughCasesInSwitch": true
+  }
+}