fix(rule): fix 略語・略称/アルファベット handling

azu · azu · commit 4a4dfd4d061b · 2019-11-24T21:34:34.000+09:00
DB &lt;-&gt; データベース is allowed by `allowAlphabet`
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ Install with [npm](https://www.npmjs.com/):
     npm install @textlint-ja/textlint-rule-no-synonyms sudachi-synonyms-dictionary
 
 辞書となる[sudachi-synonyms-dictionary](https://github.com/azu/sudachi-synonyms-dictionary)は[peerDependencies](https://npm.github.io/using-pkgs-docs/package-json/types/peerdependencies.html)なので、ルールとは別途インストールする必要があります。
-ルール間で[sudachi-synonyms-dictionary](https://github.com/azu/sudachi-synonyms-dictionary)を共有した際に、辞書を一意にするためです。
+ルール間で1つの辞書ファイルを共有するためです。
 
 > Cannot find module 'sudachi-synonyms-dictionary'
 
diff --git a/src/create-index.ts b/src/create-index.ts
@@ -21,7 +21,11 @@ export class ItemGroup {
     usedItems(usedItemSet: Set<SudachiSynonyms>, { allowAlphabet, allows }: { allowAlphabet: boolean, allows: string[] }): SudachiSynonyms[] {
         // sort by used
         return Array.from(usedItemSet.values()).filter(item => {
-            if (allowAlphabet && item.hyoukiYure === "アルファベット表記") {
+            if (allowAlphabet && (item.hyoukiYure === "アルファベット表記" || item.ryakusyou === "略語・略称/アルファベット")) {
+                // アルファベット表記
+                // blog <-> ブログ
+                // 略語・略称/アルファベット
+                // OS <-> オペレーションシステム
                 return false;
             }
             if (allows.includes(item.midashi)) {
@@ -32,12 +36,29 @@ export class ItemGroup {
     }
 }
 
+/**
+ * インストールのチェック
+ */
+const assertInstallationSudachiSynonymsDictionary = () => {
+    try {
+        require("sudachi-synonyms-dictionary");
+    } catch (error) {
+        throw new Error(`sudachi-synonyms-dictionaryがインストールされていません。
+ルールとは別にsudachi-synonyms-dictionaryをインストールしてください。
+      
+$ npm install sudachi-synonyms-dictionary
+
+
+`)
+    }
+};
 export type IndexType = { keyItemGroupMap: Map<Midashi, ItemGroup[]>; SudachiSynonymsItemGroup: Map<SudachiSynonyms, ItemGroup>; };
 let _ret: IndexType | null = null;
 export const createIndex = async (): Promise<IndexType> => {
     if (_ret) {
         return Promise.resolve(_ret);
     }
+    assertInstallationSudachiSynonymsDictionary();
     const keyItemGroupMap: Map<Midashi, ItemGroup[]> = new Map();
     const SudachiSynonymsItemGroup: Map<SudachiSynonyms, ItemGroup> = new Map();
     const SynonymsDictionary = await fetchDictionary();
diff --git a/test/textlint-rule-no-synonyms.test.ts b/test/textlint-rule-no-synonyms.test.ts
@@ -7,10 +7,14 @@ import rule from "../src/textlint-rule-no-synonyms";
 tester.run("textlint-rule-no-synonyms", rule, {
     valid: [
         "新参入、借り入れ、問題のパスポート、マネー、雇入 片方のペアだけならOKです",
+        "インターフェースとインターフェースは同じなのでOK",
         "This is アーカイブ",
         // allowAlphabet: true
+        // item.hyoukiYure === "アルファベット表記"
         "blogはブログです",
-        // allow links
+        // item.ryakusyou === "略語・略称/アルファベット"
+        "「データベース」「DB」",
+        // allow links by default
         `「[インターフェース](https://example.com)」と「[インタフェース](https://example.com)」`,
         // "allows
         {
