refactor: use kuromojin@2

Author: azu

package.json

@@ -33,14 +33,14 @@
     "textlintrule"
   ],
   "devDependencies": {
-    "@types/node": "^12.0.12",
     "@textlint/types": "^1.1.5",
+    "@types/node": "^12.0.12",
     "textlint-scripts": "^3.0.0-beta.1",
     "ts-node": "^8.3.0",
     "typescript": "^3.5.2"
   },
   "dependencies": {
-    "kuromojin": "^1.2.1",
+    "kuromojin": "^2.0.0",
     "sentence-splitter": "^3.0.11",
     "textlint-rule-helper": "^2.1.1",
     "textlint-util-to-string": "^2.1.1"

src/no-doubled-joshi.ts

@@ -2,17 +2,18 @@
 "use strict";
 import {RuleHelper} from "textlint-rule-helper";
 import {splitAST as splitSentences, Syntax as SentenceSyntax, SentenceNode} from "sentence-splitter";
-const StringSource = require("textlint-util-to-string");
-const {getTokenizer} = require("kuromojin");
+import {getTokenizer, KuromojiToken} from "kuromojin";
 import {
     is助詞Token, is読点Token,
     concatJoishiTokens,
     createKeyFromKey,
-    restoreToSurfaceFromKey, Token
+    restoreToSurfaceFromKey
 } from "./token-utils";
 import {TextlintRuleModule} from "@textlint/types";
 import {TxtNode} from "@textlint/types/lib/ast-node-types/src";
 
+const StringSource = require("textlint-util-to-string");
+
 /**
  * Create token map object
  * {
@@ -21,7 +22,7 @@ import {TxtNode} from "@textlint/types/lib/ast-node-types/src";
  * @param tokens
  * @returns {*}
  */
-function createSurfaceKeyMap(tokens: Token[]) {
+function createSurfaceKeyMap(tokens: KuromojiToken[]): { [index: string]: KuromojiToken[] } {
     // 助詞のみを対象とする
     return tokens.filter(is助詞Token).reduce((keyMap, token) => {
         // "は:助詞.係助詞" : [token]
@@ -31,10 +32,10 @@ function createSurfaceKeyMap(tokens: Token[]) {
         }
         keyMap[tokenKey].push(token);
         return keyMap;
-    }, {});
+    }, {} as { [index: string]: KuromojiToken[] });
 }
 
-function matchExceptionRule(tokens: Token[]) {
+function matchExceptionRule(tokens: KuromojiToken[]) {
     let token = tokens[0];
     // "の" の重なりは例外
     if (token.pos_detail_1 === "連体化") {
@@ -69,7 +70,7 @@ const defaultOptions = {
 
  TODO: need abstraction
  */
-module.exports = function (context, options = {}) {
+const report: TextlintRuleModule = function (context, options = {}) {
     const helper = new RuleHelper(context);
     // 最低間隔値
     const minInterval = options.min_interval || defaultOptions.min_interval;
@@ -116,7 +117,7 @@ module.exports = function (context, options = {}) {
                      }
                      */
                     Object.keys(joshiTokenSurfaceKeyMap).forEach(key => {
-                        const tokens: Token[] = joshiTokenSurfaceKeyMap[key];
+                        const tokens: KuromojiToken[] = joshiTokenSurfaceKeyMap[key];
                         const joshiName = restoreToSurfaceFromKey(key);
                         // check allow
                         if (allow.indexOf(joshiName) >= 0) {
@@ -153,4 +154,5 @@ module.exports = function (context, options = {}) {
             });
         }
     }
-} as TextlintRuleModule;
+};
+export default report;

src/token-utils.ts

@@ -1,15 +1,15 @@
 // LICENSE : MIT
 "use strict";
-export type Token = {
-    [index: string]: any;
-}
+
+import { KuromojiToken } from "kuromojin";
+
 // 助詞どうか
-export const is助詞Token = (token: Token) => {
+export const is助詞Token = (token: KuromojiToken) => {
     // 結合しているtokenは助詞助詞のようになってるため先頭一致で見る
     return token && /^助詞/.test(token.pos);
 };
 
-export const is読点Token = (token: Token) => {
+export const is読点Token = (token: KuromojiToken) => {
     return token.surface_form === "、" && token.pos === "名詞";
 };
 /**
@@ -18,7 +18,7 @@ export const is読点Token = (token: Token) => {
  * @param {Object} bToken
  * @returns {Object}
  */
-const concatToken = (aToken: Token, bToken: Token) => {
+const concatToken = (aToken: KuromojiToken, bToken: KuromojiToken) => {
     aToken.surface_form += bToken.surface_form;
     aToken.pos += bToken.pos;
     aToken.pos_detail_1 += bToken.surface_form;
@@ -29,8 +29,8 @@ const concatToken = (aToken: Token, bToken: Token) => {
  * @param {Array} tokens
  * @returns {Array}
  */
-export const concatJoishiTokens = (tokens: Token[]) => {
-    const newTokens: Token[] = [];
+export const concatJoishiTokens = (tokens: KuromojiToken[]) => {
+    const newTokens: KuromojiToken[] = [];
     tokens.forEach((token) => {
         const prevToken = newTokens[newTokens.length - 1];
         if (is助詞Token(token) && is助詞Token(prevToken)) {
@@ -44,7 +44,7 @@ export const concatJoishiTokens = (tokens: Token[]) => {
 // 助詞tokenから品詞細分類1までを元にしたkeyを作る
 // http://www.unixuser.org/~euske/doc/postag/index.html#chasen
 // http://chasen.naist.jp/snapshot/ipadic/ipadic/doc/ipadic-ja.pdf
-export const createKeyFromKey = (token: Token) => {
+export const createKeyFromKey = (token: KuromojiToken) => {
     // e.g.) "は:助詞.係助詞"
     return `${token.surface_form}:${token.pos}.${token.pos_detail_1}`;
 };

test/mocha.opts

@@ -1,12 +1,8 @@
 import TextLintTester from "textlint-tester";
-const rule = require("../src/no-doubled-joshi");
+import rule from "../src/no-doubled-joshi";
+
 const tester = new TextLintTester();
-/*
-    `**`のような装飾は取り除かれてから評価されているので、
-    テストでの強調という意味合いのみで利用する。
- */
 tester.run("no-double-joshi", rule, {
-
     valid: [
         "私は彼が好きだ",
         "既存のコードの利用", // "の" の例外

test/no-doubled-joshi-test.ts

@@ -5,6 +5,7 @@
     "moduleResolution": "node",
     "esModuleInterop": true,
     "noEmit": true,
+    "skipLibCheck": true,
     "target": "es2015",
     /* Strict Type-Checking Options */
     "strict": true,

tsconfig.json

@@ -2311,10 +2311,10 @@ kuromoji@0.1.1:
     doublearray "0.0.2"
     zlibjs "^0.2.0"
 
-kuromojin@^1.2.1:
-  version "1.4.0"
-  resolved "https://registry.yarnpkg.com/kuromojin/-/kuromojin-1.4.0.tgz#2d955746736981e73d02dbfd20eeee8110cddab2"
-  integrity sha512-ZoG3NAW6ATKgo2jBgjVWwE66GeaT2jHgdf0v1dL8+WffuSfvTvX7l6ePgYusSAhHW+dwtneYcbav8N0NhsA0uw==
+kuromojin@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/kuromojin/-/kuromojin-2.0.0.tgz#23e74a5ed2578432c9703ae75a69ba0a09ccb12d"
+  integrity sha512-60j/yLkFSc4t4roj8tI8ZNNSiAFnrkgXw8SqXz/9nakfs6mkCvPbrd7S8LDr4YNwEt1IyLys5JQTR9EnYyGHhA==
   dependencies:
     kuromoji "0.1.1"