Skip to content

Commit 9cd0538

Browse files
azuazu
authored
fix(dict2): fixで"[助詞]"を省略するのは「が」のみに限定する (#17)
> "すること[助詞]できる"は冗長な表現です。"すること[助詞]"を省き簡潔な表現にすると文章が明瞭になります。 とメッセージが出ているのに対して `--fix` では [助詞] が修正されてないのを修正する #17 (comment) 誤修正を防ぐために、「が」のみを自動修正するように変更した。 - https://gist.github.com/azu/b8c78fbd179e52a13dc932d03249edf6
2 parents 45865e1 + 6050229 commit 9cd0538

File tree

5 files changed

+93
-39
lines changed

5 files changed

+93
-39
lines changed

‎src/dictionary.js‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
// MIT © 2016 azu
22
"use strict";
33
const punctuations = ["、", "､", "，", ","];
4-
5-
module.exports = [
4+
/**
5+
* _capture_to_expectedで返すことが特殊な値
6+
* @type {{STOP_REPLACE: string}}
7+
*/
8+
const ExpectedType = {
9+
// Expectedへの変換自体を取りやめる
10+
"STOP_REPLACE": "STOP_REPLACE"
11+
};
12+
const Dictionary = [
613
{
714
// https://azu.github.io/morpheme-match/?text=省略(することが可能)。
815
id: "dict1",
@@ -80,13 +87,12 @@ module.exports = [
8087
{
8188
pos: "助詞",
8289
_capture: "$3",
83-
_capture_to_expected: function(actualToken) {
84-
if (actualToken.surface_form === "も") {
85-
return "も";
86-
} else if (actualToken.surface_form === "は") {
87-
return "は";
90+
_capture_to_expected: (actualToken) => {
91+
// 誤検知しにくい「が」のみ修正する
92+
if (actualToken.surface_form === "が") {
93+
return "";
8894
}
89-
return "";
95+
return ExpectedType.STOP_REPLACE;
9096
},
9197
_readme: "[助詞]"
9298
},
@@ -359,3 +365,6 @@ module.exports = [
359365
]
360366
}
361367
];
368+
369+
module.exports.Dictionary = Dictionary;
370+
module.exports.ExpectedType = ExpectedType;

‎src/index.js‎

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
// MIT © 2016 azu
22
"use strict";
3+
import { matchPatterns } from "@textlint/regexp-string-matcher";
34
import { wrapReportHandler } from "textlint-rule-helper";
45
import StringSource from "textlint-util-to-string";
5-
import { matchPatterns } from "@textlint/regexp-string-matcher";
6+
const { Dictionary, ExpectedType } = require("./dictionary.js")
67

78
const tokenize = require("kuromojin").tokenize;
8-
const dictionaryList = require("./dictionary");
9+
910
const createMatchAll = require("morpheme-match-all");
1011

1112
/**
@@ -49,22 +50,40 @@ const isTokensAllowed = (tokens, allows) => {
4950
return allowsMatchResults.length > 0;
5051
};
5152

52-
const createExpected = ({ text, matcherTokens, skipped, actualTokens }) => {
53-
let resultText = text;
53+
/**
54+
* マッチしたtokensを置換した結果の文字列を返す
55+
* 置換できなかった場合はnullを返す
56+
* @param {string} expected
57+
* @param {*[]} matcherTokens
58+
* @param {boolean[]} skipped
59+
* @param {*[]} actualTokens
60+
* @returns {null|string}
61+
*/
62+
const createExpected = ({ expected, matcherTokens, skipped, actualTokens }) => {
63+
if (!expected) {
64+
return null;
65+
}
66+
let resultText = expected;
5467
let actualTokenIndex = 0;
55-
matcherTokens.forEach((token, index) => {
68+
for (let index = 0; index < matcherTokens.length; index++) {
69+
const token = matcherTokens[index];
5670
if (skipped[index]) {
5771
resultText = replaceAll(resultText, token._capture, "");
58-
return;
72+
continue;
5973
}
6074
if (token._capture) {
6175
const to = replaceTokenWith(token, actualTokens[actualTokenIndex], "_capture_to_expected");
76+
// _capture_to_expectedが"STOP_REPLACE"を返した場合は置換を取りやめる
77+
if (to === ExpectedType.STOP_REPLACE) {
78+
return null;
79+
}
6280
resultText = replaceAll(resultText, token._capture, to);
6381
}
6482
++actualTokenIndex;
65-
});
83+
}
6684
return resultText;
6785
};
86+
6887
const createMessage = ({ id, text, matcherTokens, skipped, actualTokens }) => {
6988
let resultText = text;
7089
let actualTokenIndex = 0;
@@ -93,7 +112,7 @@ const reporter = (context, options = {}) => {
93112
};
94113
const dictOptions = options.dictOptions || DefaultOptions.dictOptions;
95114
// "disabled": trueな辞書は取り除く
96-
const enabledDictionaryList = dictionaryList.filter(dict => {
115+
const enabledDictionaryList = Dictionary.filter(dict => {
97116
const dictOption = dictOptions[dict.id] || {};
98117
const disabled = typeof dictOption.disabled === "boolean" ? dictOption.disabled : dict.disabled;
99118
return !disabled;
@@ -132,7 +151,7 @@ const reporter = (context, options = {}) => {
132151
const lastWordIndex = source.originalIndexFromIndex(
133152
Math.max(lastToken.word_position - 1, 0)
134153
);
135-
// replace $1
154+
// エラーメッセージ
136155
const message =
137156
createMessage({
138157
id: matchResult.dict.id,
@@ -141,15 +160,15 @@ const reporter = (context, options = {}) => {
141160
skipped: matchResult.skipped,
142161
actualTokens: matchResult.tokens
143162
});
144-
const expected = matchResult.dict.expected
145-
? createExpected({
146-
text: matchResult.dict.expected,
147-
matcherTokens: matchResult.dict.tokens,
148-
skipped: matchResult.skipped,
149-
actualTokens: matchResult.tokens
150-
})
151-
: undefined;
152-
if (expected) {
163+
// 置換結果
164+
const expected = createExpected({
165+
expected: matchResult.dict.expected,
166+
matcherTokens: matchResult.dict.tokens,
167+
skipped: matchResult.skipped,
168+
actualTokens: matchResult.tokens
169+
});
170+
const hasFixableResult = expected && tokensToString(matchResult.tokens) !== expected;
171+
if (hasFixableResult) {
153172
const wordLength = lastToken.surface_form.length;
154173
report(
155174
node,

‎test/dictionary-test.js‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,22 @@
22
"use strict";
33
import assert from "assert";
44

5+
import { Dictionary } from "../src/dictionary.js";
56
describe('dictionary', function() {
67
it("should not have duplicated id", () => {
7-
const dictionary = require("../src/dictionary.js");
8-
dictionary.forEach(item => {
8+
Dictionary.forEach(item => {
99
assert.ok(typeof item.id === "string", "should have id property");
10-
const sameIdItems = dictionary.filter(target => target.id === item.id);
10+
const sameIdItems = Dictionary.filter(target => target.id === item.id);
1111
assert.ok(sameIdItems.length === 1, "should not have duplicated id item");
1212
});
1313
});
1414
it("should have disabled default value", () => {
15-
const dictionary = require("../src/dictionary.js");
16-
dictionary.forEach(item => {
15+
Dictionary.forEach(item => {
1716
assert.ok(typeof item.disabled === "boolean", `${item} should have disabled property`);
1817
});
1918
});
2019
it("should have allows default value", () => {
21-
const dictionary = require("../src/dictionary.js");
22-
dictionary.forEach(item => {
20+
Dictionary.forEach(item => {
2321
assert.ok(Array.isArray(item.allows), `${item}: should have disabled property`);
2422
});
2523
});

‎test/index-test.js‎

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ tester.run("textlint-rule-ja-no-redundant-expression", rule, {
158158
}
159159
]
160160
},
161+
// "が"は修正可能
161162
{
162163
text: "必要なら解析することができます。",
163164
output: "必要なら解析できます。",
@@ -180,6 +181,26 @@ tester.run("textlint-rule-ja-no-redundant-expression", rule, {
180181
}
181182
]
182183
},
184+
{
185+
text: "ES5では`class`は予約語であるため、構文エラーとなり実行することはできません。",
186+
errors: [
187+
{
188+
message: `【dict2】 "することはできませ"は冗長な表現です。"することは"を省き簡潔な表現にすると文章が明瞭になります。
189+
解説: https://github.com/textlint-ja/textlint-rule-ja-no-redundant-expression#dict2`,
190+
index: 32
191+
}
192+
]
193+
},
194+
{
195+
text: "たとえば`window.document`プロパティは、グローバル変数の`document`としてアクセスすることもできます。",
196+
errors: [
197+
{
198+
message: `【dict2】 "することもできます"は冗長な表現です。"することも"を省き簡潔な表現にすると文章が明瞭になります。
199+
解説: https://github.com/textlint-ja/textlint-rule-ja-no-redundant-expression#dict2`,
200+
index: 53
201+
}
202+
]
203+
},
183204
{
184205
text: "必要なら解析することが,できます。",
185206
output: "必要なら解析できます。",
@@ -193,7 +214,6 @@ tester.run("textlint-rule-ja-no-redundant-expression", rule, {
193214
},
194215
{
195216
text: "解析することもできますよ。",
196-
output: "解析もできますよ。",
197217
errors: [
198218
{
199219
message: `【dict2】 "することもできます"は冗長な表現です。"することも"を省き簡潔な表現にすると文章が明瞭になります。
@@ -204,7 +224,6 @@ tester.run("textlint-rule-ja-no-redundant-expression", rule, {
204224
},
205225
{
206226
text: "解析することはできますよ。",
207-
output: "解析はできますよ。",
208227
errors: [
209228
{
210229
message: `【dict2】 "することはできます"は冗長な表現です。"することは"を省き簡潔な表現にすると文章が明瞭になります。
@@ -215,7 +234,6 @@ tester.run("textlint-rule-ja-no-redundant-expression", rule, {
215234
},
216235
{
217236
text: "解析する事はできますよ。",
218-
output: "解析はできますよ。",
219237
errors: [
220238
{
221239
message: `【dict2】 "する事はできます"は冗長な表現です。"する事は"を省き簡潔な表現にすると文章が明瞭になります。
@@ -227,7 +245,6 @@ tester.run("textlint-rule-ja-no-redundant-expression", rule, {
227245

228246
{
229247
text: "解析することをできますよ。",
230-
output: "解析できますよ。",
231248
errors: [
232249
{
233250
message: `【dict2】 "することをできます"は冗長な表現です。"することを"を省き簡潔な表現にすると文章が明瞭になります。
@@ -287,6 +304,17 @@ tester.run("textlint-rule-ja-no-redundant-expression", rule, {
287304
}
288305
]
289306
},
307+
{
308+
text: "この関数では、XHRを使ったデータの取得・HTML文字列の組み立て・組み立てたHTMLの表示を行っています。",
309+
output: "この関数では、XHRを使ったデータの取得・HTML文字列の組み立て・組み立てたHTMLの表示を行っています。",
310+
errors: [
311+
{
312+
message: `【dict5】 "表示を行う"は冗長な表現です。"表示する"など簡潔な表現にすると文章が明瞭になります。
313+
解説: https://github.com/textlint-ja/textlint-rule-ja-no-redundant-expression#dict5`,
314+
index: 44
315+
}
316+
]
317+
},
290318
{
291319
text: "実験を行えば分かります。",
292320
errors: [

‎tools/update-readme.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"use strict";
33
const fs = require("fs");
44
const path = require("path");
5-
const dict = require("../src/dictionary");
5+
const Dictionary = require("../src/dictionary").Dictionary;
66
const addMarkdown = require("add-text-to-markdown");
77
const SectionName = "表現の一覧";
88
const escapeMarkdown = (text) => {
@@ -53,5 +53,5 @@ ${replaceWithCaptureTokens(dict.message, dict.tokens)}${createDescription(dict)}
5353

5454
const README_PATH = path.join(__dirname, "..", "README.md");
5555
const README = fs.readFileSync(README_PATH, "utf-8");
56-
const UpdatedREADM = addMarkdown(README, createExamples(dict), SectionName);
56+
const UpdatedREADM = addMarkdown(README, createExamples(Dictionary), SectionName);
5757
fs.writeFileSync(README_PATH, UpdatedREADM, "utf-8");

0 commit comments

Comments
 (0)