@doujinreviewers/textlint-rule-for-creation 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 レヴューちゃん
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+# textlint-rule-for-creation
+日本語の明確な誤りのみを検出するtextlintルール
+
+創作での使用を想定し、クリエイターの邪魔をしないことを目指す
+
+## 誤りとするもの
+- 誤字脱字
+- 助詞の連続
+- サ抜き言葉、サ入れ言葉、れ足す言葉
+
+## 表現の範疇として許容するもの
+- 誤りとするもの以外の全て
+
+  例えば、文章の形式、スタイル、文体、文の冗長さ、二重否定、二重助詞、表記ゆれ、送り仮名のゆれ、記号や三点リーダーの使い方など
+
+- ら抜き言葉
+
+  これで喋るキャラがいるかもしれないし、作品の雰囲気に必要かもしれない
+
+## インストール
+
+    npm install textlint-rule-for-creation
+
+## 使い方
+
+`.textlintrc`に設定して使う
+
+```json
+{
+    "rules": {
+        "for-creation": true
+    }
+}
+```
+
+コマンドラインで使う
+
+```
+textlint --rule for-creation README.md
+```
+
+### Build
+
+`src/` 以下がソースコード
+
+ビルド後のコードは `lib` フォルダーに入る
+
+    npm run build
+
+### Test
+
+[textlint-tester](https://github.com/textlint/textlint-tester)で `test` フォルダのコードを実行
+
+    npm test
+
+## License
+
+MIT
+
+## 特記
+[script-compiler](https://github.com/textlint/editor/tree/master/packages/%40textlint/script-compiler)でworkerにコンパイルして使いたいが、
+
+2022年1月の時点では外部ファイルのロードに問題がある（nodeのfsモジュールがブラウザで動作しないため）
+
+そのため、本ルールではfsモジュールを使用しなくても良いようにしている
+
+問題が修正されるまではこの設計を維持する
+
+## 参考
+### worker
+
+  [textlint 12リリース、ブラウザで動くtextlint editorをベータリリース](https://efcl.info/2021/05/27/textlint-12-editor/)
+
+### ルール
+  []()
+  []()

package/lib/dict/dict.js

@@ -0,0 +1,54 @@
+"use strict";
+
+module.exports = [{
+  message: "\"\u3059\u308B\u3053\u3068\u304C\u53EF\u80FD$1\"\u306F\u5197\u9577\u306A\u8868\u73FE\u3067\u3059\u3002\"\u3059\u308B\u3053\u3068\u304C\u53EF\u80FD\"\u3092\u7701\u304D\u7C21\u6F54\u306A\u8868\u73FE\u306B\u3059\u308B\u3068\u6587\u7AE0\u304C\u660E\u77AD\u306B\u306A\u308A\u307E\u3059\u3002",
+  tokens: [{
+    "surface_form": "する",
+    "pos": "動詞",
+    "pos_detail_1": "自立",
+    "pos_detail_2": "*",
+    "pos_detail_3": "*",
+    "conjugated_type": "サ変・スル",
+    "conjugated_form": "基本形",
+    "basic_form": "する",
+    "reading": "スル",
+    "pronunciation": "スル"
+  }, {
+    "surface_form": "こと",
+    "pos": "名詞",
+    "pos_detail_1": "非自立",
+    "pos_detail_2": "一般",
+    "pos_detail_3": "*",
+    "conjugated_type": "*",
+    "conjugated_form": "*",
+    "basic_form": "こと",
+    "reading": "コト",
+    "pronunciation": "コト"
+  }, {
+    "surface_form": "が",
+    "pos": "助詞",
+    "pos_detail_1": "格助詞",
+    "pos_detail_2": "一般",
+    "pos_detail_3": "*",
+    "conjugated_type": "*",
+    "conjugated_form": "*",
+    "basic_form": "が",
+    "reading": "ガ",
+    "pronunciation": "ガ"
+  }, {
+    "surface_form": "可能",
+    "pos": "名詞",
+    "pos_detail_1": "形容動詞語幹",
+    "pos_detail_2": "*",
+    "pos_detail_3": "*",
+    "conjugated_type": "*",
+    "conjugated_form": "*",
+    "basic_form": "可能",
+    "reading": "カノウ",
+    "pronunciation": "カノー"
+  }, {
+    "pos": "助動詞",
+    "_capture": "$1"
+  }]
+}];
+//# sourceMappingURL=dict.js.map

package/lib/dict/dict.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/dict/dict.js"],"names":["module","exports","message","tokens"],"mappings":";;AAAAA,MAAM,CAACC,OAAP,GAAiB,CACf;AACIC,EAAAA,OAAO,kSADX;AAEIC,EAAAA,MAAM,EAAE,CACJ;AACI,oBAAgB,IADpB;AAEI,WAAO,IAFX;AAGI,oBAAgB,IAHpB;AAII,oBAAgB,GAJpB;AAKI,oBAAgB,GALpB;AAMI,uBAAmB,OANvB;AAOI,uBAAmB,KAPvB;AAQI,kBAAc,IARlB;AASI,eAAW,IATf;AAUI,qBAAiB;AAVrB,GADI,EAYD;AACC,oBAAgB,IADjB;AAEC,WAAO,IAFR;AAGC,oBAAgB,KAHjB;AAIC,oBAAgB,IAJjB;AAKC,oBAAgB,GALjB;AAMC,uBAAmB,GANpB;AAOC,uBAAmB,GAPpB;AAQC,kBAAc,IARf;AASC,eAAW,IATZ;AAUC,qBAAiB;AAVlB,GAZC,EAuBD;AACC,oBAAgB,GADjB;AAEC,WAAO,IAFR;AAGC,oBAAgB,KAHjB;AAIC,oBAAgB,IAJjB;AAKC,oBAAgB,GALjB;AAMC,uBAAmB,GANpB;AAOC,uBAAmB,GAPpB;AAQC,kBAAc,GARf;AASC,eAAW,GATZ;AAUC,qBAAiB;AAVlB,GAvBC,EAkCD;AACC,oBAAgB,IADjB;AAEC,WAAO,IAFR;AAGC,oBAAgB,QAHjB;AAIC,oBAAgB,GAJjB;AAKC,oBAAgB,GALjB;AAMC,uBAAmB,GANpB;AAOC,uBAAmB,GAPpB;AAQC,kBAAc,IARf;AASC,eAAW,KATZ;AAUC,qBAAiB;AAVlB,GAlCC,EA6CD;AACC,WAAO,KADR;AAEC,gBAAY;AAFb,GA7CC;AAFZ,CADe,CAAjB","sourcesContent":["module.exports = [\n  {\n      message: `\"することが可能$1\"は冗長な表現です。\"することが可能\"を省き簡潔な表現にすると文章が明瞭になります。`,\n      tokens: [\n          {\n              \"surface_form\": \"する\",\n              \"pos\": \"動詞\",\n              \"pos_detail_1\": \"自立\",\n              \"pos_detail_2\": \"*\",\n              \"pos_detail_3\": \"*\",\n              \"conjugated_type\": \"サ変・スル\",\n              \"conjugated_form\": \"基本形\",\n              \"basic_form\": \"する\",\n              \"reading\": \"スル\",\n              \"pronunciation\": \"スル\"\n          }, {\n              \"surface_form\": \"こと\",\n              \"pos\": \"名詞\",\n              \"pos_detail_1\": \"非自立\",\n              \"pos_detail_2\": \"一般\",\n              \"pos_detail_3\": \"*\",\n              \"conjugated_type\": \"*\",\n              \"conjugated_form\": \"*\",\n              \"basic_form\": \"こと\",\n              \"reading\": \"コト\",\n              \"pronunciation\": \"コト\"\n          }, {\n              \"surface_form\": \"が\",\n              \"pos\": \"助詞\",\n              \"pos_detail_1\": \"格助詞\",\n              \"pos_detail_2\": \"一般\",\n              \"pos_detail_3\": \"*\",\n              \"conjugated_type\": \"*\",\n              \"conjugated_form\": \"*\",\n              \"basic_form\": \"が\",\n              \"reading\": \"ガ\",\n              \"pronunciation\": \"ガ\"\n          }, {\n              \"surface_form\": \"可能\",\n              \"pos\": \"名詞\",\n              \"pos_detail_1\": \"形容動詞語幹\",\n              \"pos_detail_2\": \"*\",\n              \"pos_detail_3\": \"*\",\n              \"conjugated_type\": \"*\",\n              \"conjugated_form\": \"*\",\n              \"basic_form\": \"可能\",\n              \"reading\": \"カノウ\",\n              \"pronunciation\": \"カノー\"\n          }, {\n              \"pos\": \"助動詞\",\n              \"_capture\": \"$1\"\n          }\n      ]\n  },\n];"],"file":"dict.js"}

package/lib/dict/dict2.js

@@ -0,0 +1,30 @@
+"use strict";
+
+module.exports = [{
+  "message": "\"適用\"の誤用である可能性があります。適応 => 適用",
+  "expected": "を適用",
+  "tokens": [{
+    "surface_form": "を",
+    "pos": "助詞",
+    "pos_detail_1": "格助詞",
+    "pos_detail_2": "一般",
+    "pos_detail_3": "*",
+    "conjugated_type": "*",
+    "conjugated_form": "*",
+    "basic_form": "を",
+    "reading": "ヲ",
+    "pronunciation": "ヲ"
+  }, {
+    "surface_form": "適応",
+    "pos": "名詞",
+    "pos_detail_1": "サ変接続",
+    "pos_detail_2": "*",
+    "pos_detail_3": "*",
+    "conjugated_type": "*",
+    "conjugated_form": "*",
+    "basic_form": "適応",
+    "reading": "テキオウ",
+    "pronunciation": "テキオー"
+  }]
+}];
+//# sourceMappingURL=dict2.js.map

package/lib/dict/dict2.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/dict/dict2.js"],"names":["module","exports"],"mappings":";;AAAAA,MAAM,CAACC,OAAP,GAAiB,CACf;AACI,aAAW,+BADf;AAEI,cAAY,KAFhB;AAGI,YAAU,CACR;AACE,oBAAgB,GADlB;AAEE,WAAO,IAFT;AAGE,oBAAgB,KAHlB;AAIE,oBAAgB,IAJlB;AAKE,oBAAgB,GALlB;AAME,uBAAmB,GANrB;AAOE,uBAAmB,GAPrB;AAQE,kBAAc,GARhB;AASE,eAAW,GATb;AAUE,qBAAiB;AAVnB,GADQ,EAaR;AACE,oBAAgB,IADlB;AAEE,WAAO,IAFT;AAGE,oBAAgB,MAHlB;AAIE,oBAAgB,GAJlB;AAKE,oBAAgB,GALlB;AAME,uBAAmB,GANrB;AAOE,uBAAmB,GAPrB;AAQE,kBAAc,IARhB;AASE,eAAW,MATb;AAUE,qBAAiB;AAVnB,GAbQ;AAHd,CADe,CAAjB","sourcesContent":["module.exports = [\n  {\n      \"message\": \"\\\"適用\\\"の誤用である可能性があります。適応 => 適用\",\n      \"expected\": \"を適用\",\n      \"tokens\": [\n        {\n          \"surface_form\": \"を\",\n          \"pos\": \"助詞\",\n          \"pos_detail_1\": \"格助詞\",\n          \"pos_detail_2\": \"一般\",\n          \"pos_detail_3\": \"*\",\n          \"conjugated_type\": \"*\",\n          \"conjugated_form\": \"*\",\n          \"basic_form\": \"を\",\n          \"reading\": \"ヲ\",\n          \"pronunciation\": \"ヲ\"\n        },\n        {\n          \"surface_form\": \"適応\",\n          \"pos\": \"名詞\",\n          \"pos_detail_1\": \"サ変接続\",\n          \"pos_detail_2\": \"*\",\n          \"pos_detail_3\": \"*\",\n          \"conjugated_type\": \"*\",\n          \"conjugated_form\": \"*\",\n          \"basic_form\": \"適応\",\n          \"reading\": \"テキオウ\",\n          \"pronunciation\": \"テキオー\"\n        }\n      ]\n  },\n];"],"file":"dict2.js"}

package/lib/textlint-rule-for-creation.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _morphemeMatchTextlint = require("morpheme-match-textlint");
+
+var _kuromojin = require("kuromojin");
+
+var loadDictionaries = () => {
+  // unavoidable
+  var dict1 = require('./dict/dict');
+
+  var dict2 = require('./dict/dict2');
+
+  return dict1.concat(dict2);
+};
+
+var reporter = context => {
+  var {
+    Syntax,
+    RuleError,
+    fixer,
+    report,
+    getSource
+  } = context;
+  var matchAll = (0, _morphemeMatchTextlint.createTextlintMatcher)({
+    tokenize: _kuromojin.tokenize,
+    dictionaries: loadDictionaries()
+  });
+  return {
+    [Syntax.Str](node) {
+      var text = getSource(node);
+      return matchAll(text).then(results => {
+        results.forEach(result => {
+          if (result.expected) {
+            report(node, new RuleError(result.message, {
+              index: result.index,
+              fix: fixer.replaceTextRange(result.range, result.expected)
+            }));
+          } else {
+            report(node, new RuleError(result.message, {
+              index: result.index
+            }));
+          }
+        });
+      });
+    }
+
+  };
+};
+
+var _default = {
+  linter: reporter,
+  fixer: reporter
+};
+exports.default = _default;
+//# sourceMappingURL=textlint-rule-for-creation.js.map

package/lib/textlint-rule-for-creation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/textlint-rule-for-creation.js"],"names":["loadDictionaries","dict1","require","dict2","concat","reporter","context","Syntax","RuleError","fixer","report","getSource","matchAll","tokenize","dictionaries","Str","node","text","then","results","forEach","result","expected","message","index","fix","replaceTextRange","range","linter"],"mappings":";;;;;;;AAAA;;AACA;;AAEA,IAAMA,gBAAgB,GAAG,MAAM;AAC3B;AACA,MAAIC,KAAK,GAAGC,OAAO,CAAC,aAAD,CAAnB;;AACA,MAAIC,KAAK,GAAGD,OAAO,CAAC,cAAD,CAAnB;;AACA,SAAOD,KAAK,CAACG,MAAN,CAAaD,KAAb,CAAP;AACH,CALD;;AAOA,IAAME,QAAQ,GAAIC,OAAD,IAAa;AAC1B,MAAM;AAAEC,IAAAA,MAAF;AAAUC,IAAAA,SAAV;AAAqBC,IAAAA,KAArB;AAA4BC,IAAAA,MAA5B;AAAoCC,IAAAA;AAApC,MAAkDL,OAAxD;AACA,MAAMM,QAAQ,GAAG,kDAAsB;AACnCC,IAAAA,QAAQ,EAAEA,mBADyB;AAEnCC,IAAAA,YAAY,EAAEd,gBAAgB;AAFK,GAAtB,CAAjB;AAIA,SAAO;AACH,KAACO,MAAM,CAACQ,GAAR,EAAaC,IAAb,EAAmB;AACf,UAAMC,IAAI,GAAGN,SAAS,CAACK,IAAD,CAAtB;AACA,aAAOJ,QAAQ,CAACK,IAAD,CAAR,CAAeC,IAAf,CAAoBC,OAAO,IAAI;AAClCA,QAAAA,OAAO,CAACC,OAAR,CAAgBC,MAAM,IAAI;AACtB,cAAIA,MAAM,CAACC,QAAX,EAAqB;AACjBZ,YAAAA,MAAM,CAACM,IAAD,EAAO,IAAIR,SAAJ,CAAca,MAAM,CAACE,OAArB,EAA8B;AACvCC,cAAAA,KAAK,EAAEH,MAAM,CAACG,KADyB;AAEvCC,cAAAA,GAAG,EAAEhB,KAAK,CAACiB,gBAAN,CAAuBL,MAAM,CAACM,KAA9B,EAAqCN,MAAM,CAACC,QAA5C;AAFkC,aAA9B,CAAP,CAAN;AAIH,WALD,MAKO;AACHZ,YAAAA,MAAM,CAACM,IAAD,EAAO,IAAIR,SAAJ,CAAca,MAAM,CAACE,OAArB,EAA8B;AACvCC,cAAAA,KAAK,EAAEH,MAAM,CAACG;AADyB,aAA9B,CAAP,CAAN;AAGH;AACJ,SAXD;AAYH,OAbM,CAAP;AAcH;;AAjBE,GAAP;AAmBH,CAzBD;;eA2Be;AACXI,EAAAA,MAAM,EAAEvB,QADG;AAEXI,EAAAA,KAAK,EAAEJ;AAFI,C","sourcesContent":["import { createTextlintMatcher } from \"morpheme-match-textlint\";\nimport { tokenize } from \"kuromojin\";\n\nconst loadDictionaries = () => {\n    // unavoidable\n    let dict1 = require('./dict/dict');\n    let dict2 = require('./dict/dict2');\n    return dict1.concat(dict2)\n}\n\nconst reporter = (context) => {\n    const { Syntax, RuleError, fixer, report, getSource } = context;\n    const matchAll = createTextlintMatcher({\n        tokenize: tokenize,\n        dictionaries: loadDictionaries()\n    });\n    return {\n        [Syntax.Str](node) {\n            const text = getSource(node);\n            return matchAll(text).then(results => {\n                results.forEach(result => {\n                    if (result.expected) {\n                        report(node, new RuleError(result.message, {\n                            index: result.index,\n                            fix: fixer.replaceTextRange(result.range, result.expected)\n                        }));\n                    } else {\n                        report(node, new RuleError(result.message, {\n                            index: result.index\n                        }));\n                    }\n                });\n            });\n        }\n    };\n};\n\nexport default {\n    linter: reporter,\n    fixer: reporter\n};"],"file":"textlint-rule-for-creation.js"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "version": "0.0.1",
+  "keywords": [
+    "textlintrule"
+  ],
+  "main": "lib/textlint-rule-for-creation.js",
+  "files": [
+    "lib/",
+    "src/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/doujinreviewers/textlint-rule-for-creation.git"
+  },
+  "homepage": "https://github.com/doujinreviewers/textlint-rule-for-creation",
+  "bugs": {
+    "url": "https://github.com/doujinreviewers/textlint-rule-for-creation/issues"
+  },
+  "scripts": {
+    "test": "textlint-scripts test",
+    "build": "textlint-scripts build",
+    "prepublish": "npm run --if-present build"
+  },
+  "devDependencies": {
+    "textlint-scripts": "^12.0.2",
+    "textlint-tester": "^12.0.2"
+  },
+  "name": "@doujinreviewers/textlint-rule-for-creation",
+  "author": "同人Reviewers",
+  "license": "MIT",
+  "description": "日本語の明確な誤りのみを検出するクリエイター向けtextlintルール",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "kuromojin": "^3.0.0",
+    "morpheme-match-textlint": "^2.0.6"
+  }
+}

package/src/dict/dict.js

@@ -0,0 +1,55 @@
+module.exports = [
+  {
+      message: `"することが可能$1"は冗長な表現です。"することが可能"を省き簡潔な表現にすると文章が明瞭になります。`,
+      tokens: [
+          {
+              "surface_form": "する",
+              "pos": "動詞",
+              "pos_detail_1": "自立",
+              "pos_detail_2": "*",
+              "pos_detail_3": "*",
+              "conjugated_type": "サ変・スル",
+              "conjugated_form": "基本形",
+              "basic_form": "する",
+              "reading": "スル",
+              "pronunciation": "スル"
+          }, {
+              "surface_form": "こと",
+              "pos": "名詞",
+              "pos_detail_1": "非自立",
+              "pos_detail_2": "一般",
+              "pos_detail_3": "*",
+              "conjugated_type": "*",
+              "conjugated_form": "*",
+              "basic_form": "こと",
+              "reading": "コト",
+              "pronunciation": "コト"
+          }, {
+              "surface_form": "が",
+              "pos": "助詞",
+              "pos_detail_1": "格助詞",
+              "pos_detail_2": "一般",
+              "pos_detail_3": "*",
+              "conjugated_type": "*",
+              "conjugated_form": "*",
+              "basic_form": "が",
+              "reading": "ガ",
+              "pronunciation": "ガ"
+          }, {
+              "surface_form": "可能",
+              "pos": "名詞",
+              "pos_detail_1": "形容動詞語幹",
+              "pos_detail_2": "*",
+              "pos_detail_3": "*",
+              "conjugated_type": "*",
+              "conjugated_form": "*",
+              "basic_form": "可能",
+              "reading": "カノウ",
+              "pronunciation": "カノー"
+          }, {
+              "pos": "助動詞",
+              "_capture": "$1"
+          }
+      ]
+  },
+];

package/src/dict/dict2.js

@@ -0,0 +1,32 @@
+module.exports = [
+  {
+      "message": "\"適用\"の誤用である可能性があります。適応 => 適用",
+      "expected": "を適用",
+      "tokens": [
+        {
+          "surface_form": "を",
+          "pos": "助詞",
+          "pos_detail_1": "格助詞",
+          "pos_detail_2": "一般",
+          "pos_detail_3": "*",
+          "conjugated_type": "*",
+          "conjugated_form": "*",
+          "basic_form": "を",
+          "reading": "ヲ",
+          "pronunciation": "ヲ"
+        },
+        {
+          "surface_form": "適応",
+          "pos": "名詞",
+          "pos_detail_1": "サ変接続",
+          "pos_detail_2": "*",
+          "pos_detail_3": "*",
+          "conjugated_type": "*",
+          "conjugated_form": "*",
+          "basic_form": "適応",
+          "reading": "テキオウ",
+          "pronunciation": "テキオー"
+        }
+      ]
+  },
+];

package/src/textlint-rule-for-creation.js

@@ -0,0 +1,41 @@
+import { createTextlintMatcher } from "morpheme-match-textlint";
+import { tokenize } from "kuromojin";
+
+const loadDictionaries = () => {
+    // unavoidable
+    let dict1 = require('./dict/dict');
+    let dict2 = require('./dict/dict2');
+    return dict1.concat(dict2)
+}
+
+const reporter = (context) => {
+    const { Syntax, RuleError, fixer, report, getSource } = context;
+    const matchAll = createTextlintMatcher({
+        tokenize: tokenize,
+        dictionaries: loadDictionaries()
+    });
+    return {
+        [Syntax.Str](node) {
+            const text = getSource(node);
+            return matchAll(text).then(results => {
+                results.forEach(result => {
+                    if (result.expected) {
+                        report(node, new RuleError(result.message, {
+                            index: result.index,
+                            fix: fixer.replaceTextRange(result.range, result.expected)
+                        }));
+                    } else {
+                        report(node, new RuleError(result.message, {
+                            index: result.index
+                        }));
+                    }
+                });
+            });
+        }
+    };
+};
+
+export default {
+    linter: reporter,
+    fixer: reporter
+};