refactor: migrateion to TypeScrtipt

Author: azu

package.json

@@ -33,7 +33,11 @@
     "textlintrule"
   ],
   "devDependencies": {
-    "textlint-scripts": "^2.1.0"
+    "@types/node": "^12.0.12",
+    "@textlint/types": "^1.1.5",
+    "textlint-scripts": "^3.0.0-beta.1",
+    "ts-node": "^8.3.0",
+    "typescript": "^3.5.2"
   },
   "dependencies": {
     "kuromojin": "^1.2.1",

src/no-doubled-joshi.js renamed to src/no-doubled-joshi.ts

@@ -1,15 +1,17 @@
 // LICENSE : MIT
 "use strict";
 import {RuleHelper} from "textlint-rule-helper";
-import {getTokenizer} from "kuromojin";
-import {splitAST as splitSentences, Syntax as SentenceSyntax} from "sentence-splitter";
-import StringSource from "textlint-util-to-string";
+import {splitAST as splitSentences, Syntax as SentenceSyntax, SentenceNode} from "sentence-splitter";
+const StringSource = require("textlint-util-to-string");
+const {getTokenizer} = require("kuromojin");
 import {
     is助詞Token, is読点Token,
     concatJoishiTokens,
     createKeyFromKey,
-    restoreToSurfaceFromKey
+    restoreToSurfaceFromKey, Token
 } from "./token-utils";
+import {TextlintRuleModule} from "@textlint/types";
+import {TxtNode} from "@textlint/types/lib/ast-node-types/src";
 
 /**
  * Create token map object
@@ -19,7 +21,7 @@ import {
  * @param tokens
  * @returns {*}
  */
-function createSurfaceKeyMap(tokens) {
+function createSurfaceKeyMap(tokens: Token[]) {
     // 助詞のみを対象とする
     return tokens.filter(is助詞Token).reduce((keyMap, token) => {
         // "は:助詞.係助詞" : [token]
@@ -32,7 +34,7 @@ function createSurfaceKeyMap(tokens) {
     }, {});
 }
 
-function matchExceptionRule(tokens) {
+function matchExceptionRule(tokens: Token[]) {
     let token = tokens[0];
     // "の" の重なりは例外
     if (token.pos_detail_1 === "連体化") {
@@ -73,20 +75,19 @@ module.exports = function (context, options = {}) {
     const minInterval = options.min_interval || defaultOptions.min_interval;
     const isStrict = options.strict || defaultOptions.strict;
     const allow = options.allow || defaultOptions.allow;
-    const separatorChars = options.separatorChars || defaultOptions.separatorChars;
     const {Syntax, report, RuleError} = context;
     return {
         [Syntax.Paragraph](node) {
             if (helper.isChildNode(node, [Syntax.Link, Syntax.Image, Syntax.BlockQuote, Syntax.Emphasis])) {
                 return;
             }
-            const isSentenceNode = node => {
+            const isSentenceNode = (node: TxtNode): node is SentenceNode => {
                 return node.type === SentenceSyntax.Sentence;
             };
             const txtParentNode = splitSentences(node);
             const sentences = txtParentNode.children.filter(isSentenceNode);
-            return getTokenizer().then(tokenizer => {
-                const checkSentence = (sentence) => {
+            return getTokenizer().then((tokenizer: any) => {
+                const checkSentence = (sentence: SentenceNode) => {
                     const sentenceSource = new StringSource(sentence);
                     const text = sentenceSource.toString();
                     const tokens = tokenizer.tokenizeForSentence(text);
@@ -115,7 +116,7 @@ module.exports = function (context, options = {}) {
                      }
                      */
                     Object.keys(joshiTokenSurfaceKeyMap).forEach(key => {
-                        const tokens = joshiTokenSurfaceKeyMap[key];
+                        const tokens: Token[] = joshiTokenSurfaceKeyMap[key];
                         const joshiName = restoreToSurfaceFromKey(key);
                         // check allow
                         if (allow.indexOf(joshiName) >= 0) {
@@ -148,8 +149,8 @@ module.exports = function (context, options = {}) {
                         });
                     });
                 };
-                sentences.forEach(checkSentence);
+                sentences.forEach(node => checkSentence(node))
             });
         }
     }
-};
+} as TextlintRuleModule;

src/token-utils.js renamed to src/token-utils.ts

@@ -1,12 +1,15 @@
 // LICENSE : MIT
 "use strict";
+export type Token = {
+    [index: string]: any;
+}
 // 助詞どうか
-export const is助詞Token = (token) => {
+export const is助詞Token = (token: Token) => {
     // 結合しているtokenは助詞助詞のようになってるため先頭一致で見る
     return token && /^助詞/.test(token.pos);
 };
 
-export const is読点Token = (token) => {
+export const is読点Token = (token: Token) => {
     return token.surface_form === "、" && token.pos === "名詞";
 };
 /**
@@ -15,7 +18,7 @@ export const is読点Token = (token) => {
  * @param {Object} bToken
  * @returns {Object}
  */
-const concatToken = (aToken, bToken) => {
+const concatToken = (aToken: Token, bToken: Token) => {
     aToken.surface_form += bToken.surface_form;
     aToken.pos += bToken.pos;
     aToken.pos_detail_1 += bToken.surface_form;
@@ -26,8 +29,8 @@ const concatToken = (aToken, bToken) => {
  * @param {Array} tokens
  * @returns {Array}
  */
-export const concatJoishiTokens = (tokens) => {
-    const newTokens = [];
+export const concatJoishiTokens = (tokens: Token[]) => {
+    const newTokens: Token[] = [];
     tokens.forEach((token) => {
         const prevToken = newTokens[newTokens.length - 1];
         if (is助詞Token(token) && is助詞Token(prevToken)) {
@@ -41,11 +44,11 @@ export const concatJoishiTokens = (tokens) => {
 // 助詞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) => {
+export const createKeyFromKey = (token: Token) => {
     // e.g.) "は:助詞.係助詞"
     return `${token.surface_form}:${token.pos}.${token.pos_detail_1}`;
 };
 // keyからsurfaceを取り出す
-export const restoreToSurfaceFromKey = (key) => {
+export const restoreToSurfaceFromKey = (key: string) => {
     return key.split(":")[0];
-};
+};

test/mocha.opts

@@ -1 +1 @@
---require textlint-scripts/register
+--require textlint-scripts/register-ts

test/no-doubled-joshi-test.js renamed to test/no-doubled-joshi-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
+  }
+}