-
Notifications
You must be signed in to change notification settings - Fork 14
/
sentence-splitter-test.ts
275 lines (269 loc) · 14.2 KB
/
sentence-splitter-test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
import * as assert from "node:assert";
import { ASTNodeTypes, TxtParagraphNode } from "@textlint/ast-node-types";
import {
DefaultSentenceSplitterOptions,
SentenceSplitterSyntax,
split as splitSentences,
splitAST,
TxtParentNodeWithSentenceNode,
TxtSentenceNode,
TxtWhiteSpaceNode
} from "../src/sentence-splitter.js";
import { English } from "sentence-splitter/lang";
const getSentence = (children: TxtParentNodeWithSentenceNode["children"], index: number): TxtSentenceNode => {
const sentence = children[index];
assert.strictEqual(sentence.type, SentenceSplitterSyntax.Sentence);
return sentence;
};
const getWhitespace = (children: TxtParentNodeWithSentenceNode["children"], index: number): TxtWhiteSpaceNode => {
const sentence = children[index];
assert.strictEqual(sentence.type, SentenceSplitterSyntax.WhiteSpace);
return sentence;
};
describe("sentence-splitter", function () {
it("should return array", function () {
const sentences = splitSentences("text");
assert.equal(sentences.length, 1);
const sentence = getSentence(sentences, 0);
assert.strictEqual(sentence.raw, "text");
// @ts-expect-error
assert.strictEqual(typeof sentence.value, "undefined");
assert.deepStrictEqual(getSentence(sentences, 0).loc.start, { line: 1, column: 0 });
assert.deepStrictEqual(getSentence(sentences, 0).loc.end, { line: 1, column: 4 });
});
it("should not split number", function () {
const sentences = splitSentences("Temperature is 40.2 degrees.");
assert.equal(sentences.length, 1);
const [sentence] = sentences;
assert.strictEqual(sentence.type, SentenceSplitterSyntax.Sentence);
assert.strictEqual(sentence.raw, "Temperature is 40.2 degrees.");
assert.deepStrictEqual(sentence.range, [0, 28]);
});
it("should not split in pair string which pair string is same mark", function () {
const sentences = splitSentences(`I hear "I'm back to home." from radio.`);
assert.equal(sentences.length, 1);
const [sentence] = sentences;
assert.strictEqual(sentence.type, SentenceSplitterSyntax.Sentence);
assert.strictEqual(sentence.raw, `I hear "I'm back to home." from radio.`);
assert.deepStrictEqual(sentence.range, [0, 38]);
});
it("should not split in pair string", function () {
const sentences = splitSentences(`彼は「ココにある。」と言った。`);
assert.equal(sentences.length, 1);
const [sentence] = sentences;
assert.strictEqual(sentence.type, SentenceSplitterSyntax.Sentence);
assert.strictEqual(sentence.raw, `彼は「ココにある。」と言った。`);
assert.deepStrictEqual(sentence.range, [0, 15]);
});
it("should not split in pair string and correct after sentence", function () {
const sentences = splitSentences(`彼は「ココにある。」と言った。だけではそれは違った。`);
assert.equal(sentences.length, 2);
const [sentence1, sentence2] = sentences;
assert.strictEqual(sentence1.type, SentenceSplitterSyntax.Sentence);
assert.strictEqual(sentence1.raw, `彼は「ココにある。」と言った。`);
assert.deepStrictEqual(sentence1.range, [0, 15]);
assert.strictEqual(sentence2.type, SentenceSplitterSyntax.Sentence);
assert.strictEqual(sentence2.raw, `だけではそれは違った。`);
assert.deepStrictEqual(sentence2.range, [15, 26]);
});
it("should return sentences split by first line break", function () {
const sentences = splitSentences("\ntext");
assert.equal(sentences.length, 2);
const whiteSpace0 = getWhitespace(sentences, 0);
assert.strictEqual(whiteSpace0.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whiteSpace0.raw, "\n");
assert.deepStrictEqual(whiteSpace0.loc.start, { line: 1, column: 0 });
assert.deepStrictEqual(whiteSpace0.loc.end, { line: 2, column: 0 });
assert.equal(getSentence(sentences, 1).children.length, 1);
const text = getSentence(sentences, 1).children[0];
assert.strictEqual(text.type, ASTNodeTypes.Str);
assert.strictEqual(text.raw, "text");
assert.deepStrictEqual(text.loc.start, { line: 2, column: 0 });
assert.deepStrictEqual(text.loc.end, { line: 2, column: 4 });
});
it("should return sentences split by last line break", function () {
const sentences = splitSentences("text\n");
assert.equal(sentences.length, 1);
const [sentence0, whiteSpace1] = getSentence(sentences, 0).children;
assert.strictEqual(sentence0.type, ASTNodeTypes.Str);
assert.strictEqual(sentence0.raw, "text");
assert.deepStrictEqual(sentence0.loc.start, { line: 1, column: 0 });
assert.deepStrictEqual(sentence0.loc.end, { line: 1, column: 4 });
assert.strictEqual(whiteSpace1.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whiteSpace1.raw, "\n");
assert.deepStrictEqual(whiteSpace1.loc.start, { line: 1, column: 4 });
assert.deepStrictEqual(whiteSpace1.loc.end, { line: 2, column: 0 });
});
it("should return sentences split by line break*2", function () {
const sentences = splitSentences("text\n\ntext");
assert.equal(sentences.length, 1);
assert.equal(getSentence(sentences, 0).children.length, 3);
const [sentence0, whiteSpace1, sentence3] = getSentence(sentences, 0).children;
assert.strictEqual(sentence0.type, ASTNodeTypes.Str);
assert.strictEqual(sentence0.raw, "text");
assert.deepStrictEqual(sentence0.loc.start, { line: 1, column: 0 });
assert.deepStrictEqual(sentence0.loc.end, { line: 1, column: 4 });
assert.strictEqual(whiteSpace1.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whiteSpace1.raw, "\n\n");
assert.deepStrictEqual(whiteSpace1.loc.start, { line: 1, column: 4 });
assert.deepStrictEqual(whiteSpace1.loc.end, { line: 3, column: 0 });
assert.strictEqual(sentence3.type, ASTNodeTypes.Str);
assert.strictEqual(sentence3.raw, "text");
assert.deepStrictEqual(sentence3.loc.start, { line: 3, column: 0 });
assert.deepStrictEqual(sentence3.loc.end, { line: 3, column: 4 });
});
it("should return sentences split by 。", function () {
const sentences = splitSentences("text。。text");
assert.equal(sentences.length, 2);
const [sentence0, punctuation] = getSentence(sentences, 0).children;
assert.strictEqual(sentence0.raw, "text");
assert.deepStrictEqual(sentence0.loc.start, { line: 1, column: 0 });
assert.deepStrictEqual(sentence0.loc.end, { line: 1, column: 4 });
assert.strictEqual(punctuation.raw, "。。");
assert.deepStrictEqual(punctuation.loc.start, { line: 1, column: 4 });
assert.deepStrictEqual(punctuation.loc.end, { line: 1, column: 6 });
const [sentence1] = getSentence(sentences, 1).children;
assert.strictEqual(sentence1.raw, "text");
assert.deepStrictEqual(sentence1.loc.start, { line: 1, column: 6 });
assert.deepStrictEqual(sentence1.loc.end, { line: 1, column: 10 });
});
it("should return sentences split by 。 and linebreak", function () {
const sentences = splitSentences("text。\ntext");
assert.equal(sentences.length, 3);
const sentence0 = getSentence(sentences, 0);
assert.strictEqual(sentence0.raw, "text。");
assert.deepStrictEqual(sentence0.loc.start, { line: 1, column: 0 });
assert.deepStrictEqual(sentence0.loc.end, { line: 1, column: 5 });
const whiteSpace1 = getWhitespace(sentences, 1);
assert.strictEqual(whiteSpace1.raw, "\n");
assert.deepStrictEqual(whiteSpace1.loc.start, { line: 1, column: 5 });
assert.deepStrictEqual(whiteSpace1.loc.end, { line: 2, column: 0 });
const sentence2 = sentences[2];
assert.strictEqual(sentence2.raw, "text");
assert.deepStrictEqual(sentence2.loc.start, { line: 2, column: 0 });
assert.deepStrictEqual(sentence2.loc.end, { line: 2, column: 4 });
});
it("should return sentences split by . and whitespace", function () {
const sentences = splitSentences("1st text. 2nd text");
assert.equal(sentences.length, 3);
const sentence0 = getSentence(sentences, 0);
assert.strictEqual(sentence0.raw, "1st text.");
assert.deepStrictEqual(sentence0.loc.start, { line: 1, column: 0 });
assert.deepStrictEqual(sentence0.loc.end, { line: 1, column: 9 });
const whiteSpace1 = getWhitespace(sentences, 1);
assert.strictEqual(whiteSpace1.raw, " ");
assert.deepStrictEqual(whiteSpace1.loc.start, { line: 1, column: 9 });
assert.deepStrictEqual(whiteSpace1.loc.end, { line: 1, column: 10 });
const sentence2 = sentences[2];
assert.strictEqual(sentence2.raw, "2nd text");
assert.deepStrictEqual(sentence2.loc.start, { line: 1, column: 10 });
assert.deepStrictEqual(sentence2.loc.end, { line: 1, column: 18 });
});
it("should return sentences split by multiple whitespaces", function () {
const sentences = splitSentences("1st text. 2nd text");
assert.equal(sentences.length, 3);
const [sentence0, whitespace0, sentence1] = sentences;
assert.strictEqual(sentence0.raw, "1st text.");
assert.deepStrictEqual(sentence0.range, [0, 9]);
assert.strictEqual(whitespace0.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whitespace0.value, " ");
assert.deepStrictEqual(whitespace0.range, [9, 12]);
assert.strictEqual(sentence1.raw, "2nd text");
assert.deepStrictEqual(sentence1.range, [12, 20]);
});
it("should support start and end whitespace", function () {
const sentences = splitSentences(" text. ");
assert.equal(sentences.length, 1 + 2);
const [whitespace0, sentence0, whitespace1] = sentences;
assert.strictEqual(whitespace0.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whitespace0.value, " ");
assert.deepStrictEqual(whitespace0.range, [0, 1]);
assert.strictEqual(sentence0.raw, "text.");
assert.deepStrictEqual(sentence0.range, [1, 6]);
assert.strictEqual(whitespace1.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whitespace1.value, " ");
assert.deepStrictEqual(whitespace1.range, [6, 7]);
});
it("should return sentences split by text and whitespaces, and new line", function () {
const sentences = splitSentences("1st text. \n 2nd text");
assert.strictEqual(sentences.length, 5);
const [sentence0, whitespace1, lineBreak, whitespace2, sentence1] = sentences;
assert.strictEqual(sentence0.raw, "1st text.");
assert.deepStrictEqual(sentence0.range, [0, 9]);
assert.strictEqual(lineBreak.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whitespace1.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whitespace1.value, " ");
assert.strictEqual(lineBreak.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(lineBreak.value, "\n");
assert.strictEqual(whitespace2.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whitespace2.value, " ");
assert.strictEqual(sentence1.raw, "2nd text");
assert.deepStrictEqual(sentence1.range, [12, 20]);
});
it("should return sentences split by !?", function () {
const sentences = splitSentences("text!?text");
assert.equal(sentences.length, 2);
const sentence0 = getSentence(sentences, 0);
assert.strictEqual(sentence0.raw, "text!?");
assert.deepStrictEqual(sentence0.loc.start, { line: 1, column: 0 });
assert.deepStrictEqual(sentence0.loc.end, { line: 1, column: 6 });
const sentence1 = getSentence(sentences, 1);
assert.strictEqual(sentence1.raw, "text");
assert.deepStrictEqual(sentence1.loc.start, { line: 1, column: 6 });
assert.deepStrictEqual(sentence1.loc.end, { line: 1, column: 10 });
});
it("should sentences split by last 。", function () {
const sentences = splitSentences("text。");
assert.equal(sentences.length, 1);
const sentence = getSentence(sentences, 0);
assert.strictEqual(sentence.raw, "text。");
assert.deepStrictEqual(getSentence(sentences, 0).loc.start, { line: 1, column: 0 });
assert.deepStrictEqual(getSentence(sentences, 0).loc.end, { line: 1, column: 5 });
});
it("should not split line indexes", function () {
const sentences = splitSentences("1. 1st text.\n2. 2nd text.");
assert.equal(sentences.length, 3);
const [sentence0, whiteSpace0, sentence1] = sentences;
assert.strictEqual(whiteSpace0.type, SentenceSplitterSyntax.WhiteSpace);
assert.strictEqual(whiteSpace0.raw, "\n");
assert.strictEqual(sentence0.raw, "1. 1st text.");
assert.strictEqual(sentence1.raw, "2. 2nd text.");
});
describe("splitAST", () => {
it("should handle empty child", () => {
const paragraphNode: TxtParagraphNode = {
type: "Paragraph",
children: [],
loc: {
start: {
line: 1,
column: 0
},
end: {
line: 1,
column: 0
}
},
range: [0, 0],
raw: ""
};
const resultParagraph = splitAST(paragraphNode);
assert.deepStrictEqual(resultParagraph, paragraphNode, "same result");
});
});
describe("Lang Options", () => {
it("should allow to pass lang", () => {
const sentences = splitSentences("text", {
AbbrMarker: {
language: English
}
});
assert.equal(sentences.length, 1);
});
});
describe("DefaultSentenceSplitterOptions", () => {
it("should return object", () => {
assert.ok(typeof DefaultSentenceSplitterOptions === "object");
});
});
});