slopless 0.2.7 → 0.2.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -3
- package/dist/adapters/textlint/report.js +1 -4
- package/dist/adapters/textlint/report.js.map +1 -1
- package/dist/adapters/textlint/rule.js +21 -0
- package/dist/adapters/textlint/rule.js.map +1 -0
- package/dist/adapters/textlint/units.js +149 -1
- package/dist/adapters/textlint/units.js.map +1 -1
- package/dist/cli.js +18 -7
- package/dist/cli.js.map +1 -1
- package/dist/presets/everything.js +8 -0
- package/dist/presets/everything.js.map +1 -1
- package/dist/registries/narrative-slop.js +2 -0
- package/dist/registries/narrative-slop.js.map +1 -1
- package/dist/registries/orthography.js +4 -0
- package/dist/registries/orthography.js.map +1 -1
- package/dist/registries/syntactic-patterns/authority.js +3 -1
- package/dist/registries/syntactic-patterns/authority.js.map +1 -1
- package/dist/registries/syntactic-patterns/lead-ins.js +2 -0
- package/dist/registries/syntactic-patterns/lead-ins.js.map +1 -1
- package/dist/registries/syntactic-patterns/repetition.js +4 -0
- package/dist/registries/syntactic-patterns/repetition.js.map +1 -1
- package/dist/registries/words.js +2 -0
- package/dist/registries/words.js.map +1 -1
- package/dist/reporting/reports.js +50 -0
- package/dist/reporting/reports.js.map +1 -1
- package/dist/rules/academic-slop/tortured-phrases.js +13 -23
- package/dist/rules/academic-slop/tortured-phrases.js.map +1 -1
- package/dist/rules/metrics/avg-sentence-length.js +29 -21
- package/dist/rules/metrics/avg-sentence-length.js.map +1 -1
- package/dist/rules/metrics/coleman-liau.js +23 -23
- package/dist/rules/metrics/coleman-liau.js.map +1 -1
- package/dist/rules/metrics/flesch-kincaid.js +23 -23
- package/dist/rules/metrics/flesch-kincaid.js.map +1 -1
- package/dist/rules/metrics/gunning-fog.js +23 -23
- package/dist/rules/metrics/gunning-fog.js.map +1 -1
- package/dist/rules/metrics/paragraph-length.js +19 -20
- package/dist/rules/metrics/paragraph-length.js.map +1 -1
- package/dist/rules/metrics/word-repetition.js +20 -21
- package/dist/rules/metrics/word-repetition.js.map +1 -1
- package/dist/rules/narrative-slop/body-action-density.js +104 -24
- package/dist/rules/narrative-slop/body-action-density.js.map +1 -1
- package/dist/rules/narrative-slop/data/narrative-cliches.json +76 -0
- package/dist/rules/narrative-slop/flat-action-cadence.js +117 -172
- package/dist/rules/narrative-slop/flat-action-cadence.js.map +1 -1
- package/dist/rules/narrative-slop/low-information-beat-density.js +79 -0
- package/dist/rules/narrative-slop/low-information-beat-density.js.map +1 -0
- package/dist/rules/narrative-slop/narrative-cliches.js +35 -33
- package/dist/rules/narrative-slop/narrative-cliches.js.map +1 -1
- package/dist/rules/narrative-slop/perception-verb-density.js +47 -24
- package/dist/rules/narrative-slop/perception-verb-density.js.map +1 -1
- package/dist/rules/orthography/artifact-placeholders.js +110 -0
- package/dist/rules/orthography/artifact-placeholders.js.map +1 -0
- package/dist/rules/orthography/colon-dramatic.js +24 -32
- package/dist/rules/orthography/colon-dramatic.js.map +1 -1
- package/dist/rules/orthography/em-dashes.js +19 -33
- package/dist/rules/orthography/em-dashes.js.map +1 -1
- package/dist/rules/orthography/exclamation-density.js +20 -34
- package/dist/rules/orthography/exclamation-density.js.map +1 -1
- package/dist/rules/orthography/fake-timestamps.js +12 -32
- package/dist/rules/orthography/fake-timestamps.js.map +1 -1
- package/dist/rules/orthography/hidden-unicode-controls.js +51 -0
- package/dist/rules/orthography/hidden-unicode-controls.js.map +1 -0
- package/dist/rules/orthography/sentence-case.js +26 -32
- package/dist/rules/orthography/sentence-case.js.map +1 -1
- package/dist/rules/orthography/smart-quotes.js +12 -32
- package/dist/rules/orthography/smart-quotes.js.map +1 -1
- package/dist/rules/phrases/cliches.js +16 -27
- package/dist/rules/phrases/cliches.js.map +1 -1
- package/dist/rules/phrases/corporate-speak.js +16 -27
- package/dist/rules/phrases/corporate-speak.js.map +1 -1
- package/dist/rules/phrases/data/llm-disclaimer-expansions.json +9 -2
- package/dist/rules/phrases/data/redundancy-patterns.json +7 -0
- package/dist/rules/phrases/data/wordiness-patterns.json +2 -0
- package/dist/rules/phrases/humble-bragger.js +12 -22
- package/dist/rules/phrases/humble-bragger.js.map +1 -1
- package/dist/rules/phrases/jargon-faker.js +14 -25
- package/dist/rules/phrases/jargon-faker.js.map +1 -1
- package/dist/rules/phrases/llm-disclaimer.js +19 -23
- package/dist/rules/phrases/llm-disclaimer.js.map +1 -1
- package/dist/rules/phrases/prohibited-phrases.js +13 -23
- package/dist/rules/phrases/prohibited-phrases.js.map +1 -1
- package/dist/rules/phrases/redundancy.js +13 -23
- package/dist/rules/phrases/redundancy.js.map +1 -1
- package/dist/rules/phrases/skunked-terms.js +13 -23
- package/dist/rules/phrases/skunked-terms.js.map +1 -1
- package/dist/rules/phrases/uncomparables.js +15 -26
- package/dist/rules/phrases/uncomparables.js.map +1 -1
- package/dist/rules/phrases/wordiness.js +13 -23
- package/dist/rules/phrases/wordiness.js.map +1 -1
- package/dist/rules/private/textlint-rule-builders.js +48 -0
- package/dist/rules/private/textlint-rule-builders.js.map +1 -0
- package/dist/rules/semantic-thinness/patterns/abstract-metaphor-claim.json +91 -2
- package/dist/rules/semantic-thinness/patterns/abstract-personification-line.json +34 -3
- package/dist/rules/semantic-thinness/patterns/body-emotion-shorthand.json +23 -0
- package/dist/rules/semantic-thinness/patterns/deictic-summary.json +118 -6
- package/dist/rules/semantic-thinness/patterns/different-job-summary.json +30 -0
- package/dist/rules/semantic-thinness/patterns/emotion-as-substance.json +14 -4
- package/dist/rules/semantic-thinness/patterns/empty-atmosphere-shift.json +2 -0
- package/dist/rules/semantic-thinness/patterns/empty-scene-state.json +1 -0
- package/dist/rules/semantic-thinness/patterns/empty-scene-transition.json +1 -0
- package/dist/rules/semantic-thinness/patterns/gaze-choreography.json +2 -0
- package/dist/rules/semantic-thinness/patterns/generic-pressure-or-stakes.json +1 -0
- package/dist/rules/semantic-thinness/patterns/generic-realization.json +1 -0
- package/dist/rules/semantic-thinness/patterns/hollow-significance.json +94 -2
- package/dist/rules/semantic-thinness/patterns/missing-conversation-plan.json +44 -0
- package/dist/rules/semantic-thinness/patterns/puffery-evaluative-claim.json +122 -0
- package/dist/rules/semantic-thinness/patterns/real-work-begins.json +3 -1
- package/dist/rules/semantic-thinness/patterns/silence-as-actor.json +4 -0
- package/dist/rules/semantic-thinness/patterns/solution-boring-frame.json +72 -0
- package/dist/rules/semantic-thinness/patterns/truth-answer-moves.json +2 -0
- package/dist/rules/semantic-thinness/patterns/vague-connective-payoff.json +31 -4
- package/dist/rules/semantic-thinness/patterns/vague-summary-cost.json +34 -0
- package/dist/rules/semantic-thinness/patterns/vague-threshold-change.json +40 -4
- package/dist/rules/semantic-thinness/private/concrete-guards.js +119 -0
- package/dist/rules/semantic-thinness/private/concrete-guards.js.map +1 -0
- package/dist/rules/semantic-thinness/private/pattern-data-b.js +6 -0
- package/dist/rules/semantic-thinness/private/pattern-data-b.js.map +1 -1
- package/dist/rules/semantic-thinness/private/pattern-data-d.js +4 -0
- package/dist/rules/semantic-thinness/private/pattern-data-d.js.map +1 -1
- package/dist/rules/semantic-thinness/private/pattern-matcher.js +26 -14
- package/dist/rules/semantic-thinness/private/pattern-matcher.js.map +1 -1
- package/dist/rules/semantic-thinness/semantic-thinness.js +27 -23
- package/dist/rules/semantic-thinness/semantic-thinness.js.map +1 -1
- package/dist/rules/syntactic-patterns/authority/authority-padding.js +94 -30
- package/dist/rules/syntactic-patterns/authority/authority-padding.js.map +1 -1
- package/dist/rules/syntactic-patterns/authority/uncited-authority.js +124 -0
- package/dist/rules/syntactic-patterns/authority/uncited-authority.js.map +1 -0
- package/dist/rules/syntactic-patterns/closers/affirmation-closers.js +56 -44
- package/dist/rules/syntactic-patterns/closers/affirmation-closers.js.map +1 -1
- package/dist/rules/syntactic-patterns/closers/boilerplate-conclusion.js +76 -26
- package/dist/rules/syntactic-patterns/closers/boilerplate-conclusion.js.map +1 -1
- package/dist/rules/syntactic-patterns/closers/false-question.js +20 -24
- package/dist/rules/syntactic-patterns/closers/false-question.js.map +1 -1
- package/dist/rules/syntactic-patterns/closers/summative-closer.js +69 -25
- package/dist/rules/syntactic-patterns/closers/summative-closer.js.map +1 -1
- package/dist/rules/syntactic-patterns/contrast/blame-reframe.js +19 -23
- package/dist/rules/syntactic-patterns/contrast/blame-reframe.js.map +1 -1
- package/dist/rules/syntactic-patterns/contrast/contrastive-aphorism.js +102 -31
- package/dist/rules/syntactic-patterns/contrast/contrastive-aphorism.js.map +1 -1
- package/dist/rules/syntactic-patterns/contrast/negation-reframe.js +30 -22
- package/dist/rules/syntactic-patterns/contrast/negation-reframe.js.map +1 -1
- package/dist/rules/syntactic-patterns/contrast/private/abstract-pair-gates.js +63 -0
- package/dist/rules/syntactic-patterns/contrast/private/abstract-pair-gates.js.map +1 -0
- package/dist/rules/syntactic-patterns/contrast/private/block-negation-reframe.js +194 -0
- package/dist/rules/syntactic-patterns/contrast/private/block-negation-reframe.js.map +1 -0
- package/dist/rules/syntactic-patterns/contrast/private/meaning-reframe.js +42 -0
- package/dist/rules/syntactic-patterns/contrast/private/meaning-reframe.js.map +1 -0
- package/dist/rules/syntactic-patterns/contrast/private/negation-reframe-matcher.js +34 -41
- package/dist/rules/syntactic-patterns/contrast/private/negation-reframe-matcher.js.map +1 -1
- package/dist/rules/syntactic-patterns/contrast/private/negation-reframe-parts.js +4 -2
- package/dist/rules/syntactic-patterns/contrast/private/negation-reframe-parts.js.map +1 -1
- package/dist/rules/syntactic-patterns/contrast/private/negative-slop-frames.js +39 -2
- package/dist/rules/syntactic-patterns/contrast/private/negative-slop-frames.js.map +1 -1
- package/dist/rules/syntactic-patterns/contrast/private/same-sentence-contrast.js +47 -0
- package/dist/rules/syntactic-patterns/contrast/private/same-sentence-contrast.js.map +1 -0
- package/dist/rules/syntactic-patterns/generalization/softening-language.js +19 -23
- package/dist/rules/syntactic-patterns/generalization/softening-language.js.map +1 -1
- package/dist/rules/syntactic-patterns/generalization/universalizing-claims.js +103 -24
- package/dist/rules/syntactic-patterns/generalization/universalizing-claims.js.map +1 -1
- package/dist/rules/syntactic-patterns/lead-ins/boilerplate-framing.js +12 -22
- package/dist/rules/syntactic-patterns/lead-ins/boilerplate-framing.js.map +1 -1
- package/dist/rules/syntactic-patterns/lead-ins/formal-transition-density.js +92 -0
- package/dist/rules/syntactic-patterns/lead-ins/formal-transition-density.js.map +1 -0
- package/dist/rules/syntactic-patterns/lead-ins/generic-signposting.js +72 -26
- package/dist/rules/syntactic-patterns/lead-ins/generic-signposting.js.map +1 -1
- package/dist/rules/syntactic-patterns/lead-ins/lesson-framing.js +28 -23
- package/dist/rules/syntactic-patterns/lead-ins/lesson-framing.js.map +1 -1
- package/dist/rules/syntactic-patterns/lead-ins/llm-openers.js +63 -25
- package/dist/rules/syntactic-patterns/lead-ins/llm-openers.js.map +1 -1
- package/dist/rules/syntactic-patterns/lead-ins/observer-guidance.js +36 -23
- package/dist/rules/syntactic-patterns/lead-ins/observer-guidance.js.map +1 -1
- package/dist/rules/syntactic-patterns/lead-ins/private/discourse-evaluation.js +91 -0
- package/dist/rules/syntactic-patterns/lead-ins/private/discourse-evaluation.js.map +1 -0
- package/dist/rules/syntactic-patterns/llm-artifacts/data/response-wrapper-patterns.json +6 -0
- package/dist/rules/syntactic-patterns/llm-artifacts/response-wrapper.js +21 -26
- package/dist/rules/syntactic-patterns/llm-artifacts/response-wrapper.js.map +1 -1
- package/dist/rules/syntactic-patterns/repetition/demonstrative-emphasis.js +32 -51
- package/dist/rules/syntactic-patterns/repetition/demonstrative-emphasis.js.map +1 -1
- package/dist/rules/syntactic-patterns/repetition/empty-emphasis.js +19 -23
- package/dist/rules/syntactic-patterns/repetition/empty-emphasis.js.map +1 -1
- package/dist/rules/syntactic-patterns/repetition/fragment-stacking.js +16 -33
- package/dist/rules/syntactic-patterns/repetition/fragment-stacking.js.map +1 -1
- package/dist/rules/syntactic-patterns/repetition/repeated-predicate-end.js +110 -0
- package/dist/rules/syntactic-patterns/repetition/repeated-predicate-end.js.map +1 -0
- package/dist/rules/syntactic-patterns/repetition/repeated-sentence-starts.js +91 -0
- package/dist/rules/syntactic-patterns/repetition/repeated-sentence-starts.js.map +1 -0
- package/dist/rules/syntactic-patterns/repetition/triple-repeat.js +21 -39
- package/dist/rules/syntactic-patterns/repetition/triple-repeat.js.map +1 -1
- package/dist/rules/term-policy/recommended-terms.js +27 -25
- package/dist/rules/term-policy/recommended-terms.js.map +1 -1
- package/dist/rules/term-policy/required-terms.js +21 -25
- package/dist/rules/term-policy/required-terms.js.map +1 -1
- package/dist/rules/words/hedge-stacking.js +19 -23
- package/dist/rules/words/hedge-stacking.js.map +1 -1
- package/dist/rules/words/llm-vocabulary-density.js +78 -0
- package/dist/rules/words/llm-vocabulary-density.js.map +1 -0
- package/dist/rules/words/llm-vocabulary.js +14 -20
- package/dist/rules/words/llm-vocabulary.js.map +1 -1
- package/dist/rules/words/prohibited-words.js +12 -17
- package/dist/rules/words/prohibited-words.js.map +1 -1
- package/dist/rules/words/simplicity.js +20 -25
- package/dist/rules/words/simplicity.js.map +1 -1
- package/dist/shared/matchers/concrete-evidence.js +161 -0
- package/dist/shared/matchers/concrete-evidence.js.map +1 -0
- package/package.json +12 -4
|
@@ -1,12 +1,14 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { hasConcreteAuthorityEvidence } from "../../../shared/matchers/concrete-evidence.js";
|
|
2
|
+
import { cleanSentence, tokens } from "../../../shared/matchers/prose-patterns.js";
|
|
3
|
+
import { oneToOneRule } from "../../private/textlint-rule-builders.js";
|
|
4
4
|
const PREFIXES = ["however, ", "but ", "and ", "so "];
|
|
5
5
|
const EVIDENCE_SUBJECTS = [
|
|
6
6
|
"the evidence",
|
|
7
|
+
"evidence",
|
|
7
8
|
"the strongest evidence",
|
|
8
9
|
"the recent evidence",
|
|
9
|
-
"the broader evidence"
|
|
10
|
+
"the broader evidence",
|
|
11
|
+
"the available evidence"
|
|
10
12
|
];
|
|
11
13
|
const RESEARCH_SUBJECTS = [
|
|
12
14
|
"the research",
|
|
@@ -15,33 +17,98 @@ const RESEARCH_SUBJECTS = [
|
|
|
15
17
|
"the recent research",
|
|
16
18
|
"the science",
|
|
17
19
|
"the data",
|
|
20
|
+
"the dataset",
|
|
21
|
+
"the literature",
|
|
22
|
+
"data",
|
|
23
|
+
"research",
|
|
18
24
|
"studies"
|
|
19
25
|
];
|
|
20
|
-
const RESEARCHER_SUBJECTS = [
|
|
21
|
-
|
|
26
|
+
const RESEARCHER_SUBJECTS = [
|
|
27
|
+
"experts",
|
|
28
|
+
"researchers",
|
|
29
|
+
"scientists",
|
|
30
|
+
"specialists"
|
|
31
|
+
];
|
|
32
|
+
const EVIDENCE_PREDICATES = [
|
|
33
|
+
"backs",
|
|
34
|
+
"is clear",
|
|
35
|
+
"is strongest",
|
|
36
|
+
"is not subtle",
|
|
37
|
+
"points",
|
|
38
|
+
"shows",
|
|
39
|
+
"suggests"
|
|
40
|
+
];
|
|
22
41
|
const RESEARCH_PREDICATES = [
|
|
23
42
|
"backs",
|
|
43
|
+
"confirms",
|
|
24
44
|
"does show is",
|
|
25
45
|
"is clear",
|
|
26
46
|
"is not mysterious",
|
|
27
47
|
"points",
|
|
48
|
+
"proves",
|
|
28
49
|
"shows",
|
|
29
50
|
"suggests"
|
|
30
51
|
];
|
|
31
|
-
const RESEARCHER_PREDICATES = [
|
|
52
|
+
const RESEARCHER_PREDICATES = [
|
|
53
|
+
"agree",
|
|
54
|
+
"keep finding",
|
|
55
|
+
"keep saying",
|
|
56
|
+
"keep showing",
|
|
57
|
+
"say"
|
|
58
|
+
];
|
|
32
59
|
const AUTHORITY_ADVERBS = ["clearly", "consistently", "strongly"];
|
|
60
|
+
const ABSTRACT_AUTHORITY_COMPLEMENTS = [
|
|
61
|
+
"alignment",
|
|
62
|
+
"aligned",
|
|
63
|
+
"claim",
|
|
64
|
+
"content",
|
|
65
|
+
"decision",
|
|
66
|
+
"engagement",
|
|
67
|
+
"launch",
|
|
68
|
+
"meeting",
|
|
69
|
+
"meetings",
|
|
70
|
+
"owner",
|
|
71
|
+
"owners",
|
|
72
|
+
"progress",
|
|
73
|
+
"retention",
|
|
74
|
+
"rollback",
|
|
75
|
+
"strategy",
|
|
76
|
+
"teams",
|
|
77
|
+
"trust",
|
|
78
|
+
"visibility"
|
|
79
|
+
];
|
|
33
80
|
const PRESTIGE_SUFFIXES = [
|
|
34
81
|
"'s work is famous for a reason",
|
|
35
82
|
"\u2019s work is famous for a reason"
|
|
36
83
|
];
|
|
84
|
+
function hasAbstractAuthorityComplement(text) {
|
|
85
|
+
const words = tokens(text);
|
|
86
|
+
return ABSTRACT_AUTHORITY_COMPLEMENTS.some((word) => words.includes(word));
|
|
87
|
+
}
|
|
37
88
|
function matchesSubjectPredicate(text, subjects, predicates) {
|
|
38
|
-
return subjects.some((subject) =>
|
|
89
|
+
return subjects.some((subject) => {
|
|
90
|
+
const subjectText = `${subject} `;
|
|
91
|
+
if (!text.startsWith(subjectText)) {
|
|
92
|
+
return false;
|
|
93
|
+
}
|
|
94
|
+
return predicates.some((predicate) => {
|
|
95
|
+
const predicateText = `${subjectText}${predicate}`;
|
|
96
|
+
if (!text.startsWith(predicateText)) {
|
|
97
|
+
return false;
|
|
98
|
+
}
|
|
99
|
+
return predicate.includes("is ") || hasAbstractAuthorityComplement(text);
|
|
100
|
+
});
|
|
101
|
+
});
|
|
39
102
|
}
|
|
40
103
|
function matchesAdverbialSubjectPredicate(text, subjects, predicates) {
|
|
41
|
-
return subjects.some((subject) => AUTHORITY_ADVERBS.some((adverb) => predicates.some((predicate) => text.startsWith(`${subject} ${adverb} ${predicate}`)
|
|
104
|
+
return subjects.some((subject) => AUTHORITY_ADVERBS.some((adverb) => predicates.some((predicate) => text.startsWith(`${subject} ${adverb} ${predicate}`) &&
|
|
105
|
+
(predicate.includes("is ") || hasAbstractAuthorityComplement(text)))));
|
|
42
106
|
}
|
|
43
107
|
function matchAuthorityPadding(sentence) {
|
|
44
108
|
const stripped = cleanSentence(sentence, PREFIXES);
|
|
109
|
+
if (hasConcreteAuthorityEvidence(stripped)) {
|
|
110
|
+
return undefined;
|
|
111
|
+
}
|
|
45
112
|
if (PRESTIGE_SUFFIXES.some((suffix) => stripped.includes(suffix))) {
|
|
46
113
|
return { kind: "prestige-frame", signal: "work is famous for a reason" };
|
|
47
114
|
}
|
|
@@ -59,27 +126,24 @@ function matchAuthorityPadding(sentence) {
|
|
|
59
126
|
}
|
|
60
127
|
return undefined;
|
|
61
128
|
}
|
|
62
|
-
const rule = (
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
const matched = matchAuthorityPadding(item.sentence.text);
|
|
68
|
-
if (matched === undefined) {
|
|
69
|
-
continue;
|
|
70
|
-
}
|
|
71
|
-
emitTextlintFinding(context, {
|
|
72
|
-
node: item.paragraph,
|
|
73
|
-
ruleId: "syntactic-patterns:authority-padding",
|
|
74
|
-
message: `Authority padding found: ${matched.signal}. Cite the actual evidence or remove the frame.`,
|
|
75
|
-
range: {
|
|
76
|
-
start: item.source.originalStartFor(item.sentence.start),
|
|
77
|
-
end: item.source.originalEndFor(item.sentence.end)
|
|
78
|
-
}
|
|
79
|
-
});
|
|
80
|
-
}
|
|
129
|
+
const rule = oneToOneRule({
|
|
130
|
+
detect: (unit) => {
|
|
131
|
+
const matched = matchAuthorityPadding(unit.text);
|
|
132
|
+
if (matched === undefined) {
|
|
133
|
+
return [];
|
|
81
134
|
}
|
|
82
|
-
|
|
83
|
-
|
|
135
|
+
return [
|
|
136
|
+
{
|
|
137
|
+
evidence: matched.signal,
|
|
138
|
+
label: matched.kind,
|
|
139
|
+
range: { start: 0, end: unit.text.length }
|
|
140
|
+
}
|
|
141
|
+
];
|
|
142
|
+
},
|
|
143
|
+
family: "syntactic-patterns",
|
|
144
|
+
formatMessage: (report) => `Authority padding found: ${report.evidence}. Cite the actual evidence or remove the frame.`,
|
|
145
|
+
ruleId: "syntactic-patterns:authority-padding",
|
|
146
|
+
unitKind: "sentence"
|
|
147
|
+
});
|
|
84
148
|
export default rule;
|
|
85
149
|
//# sourceMappingURL=authority-padding.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"authority-padding.js","sourceRoot":"","sources":["../../../../src/rules/syntactic-patterns/authority/authority-padding.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"authority-padding.js","sourceRoot":"","sources":["../../../../src/rules/syntactic-patterns/authority/authority-padding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,+CAA+C,CAAC;AAC7F,OAAO,EACL,aAAa,EACb,MAAM,EAEP,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAEvE,MAAM,QAAQ,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AACtD,MAAM,iBAAiB,GAAG;IACxB,cAAc;IACd,UAAU;IACV,wBAAwB;IACxB,qBAAqB;IACrB,sBAAsB;IACtB,wBAAwB;CACzB,CAAC;AACF,MAAM,iBAAiB,GAAG;IACxB,cAAc;IACd,mBAAmB;IACnB,sBAAsB;IACtB,qBAAqB;IACrB,aAAa;IACb,UAAU;IACV,aAAa;IACb,gBAAgB;IAChB,MAAM;IACN,UAAU;IACV,SAAS;CACV,CAAC;AACF,MAAM,mBAAmB,GAAG;IAC1B,SAAS;IACT,aAAa;IACb,YAAY;IACZ,aAAa;CACd,CAAC;AACF,MAAM,mBAAmB,GAAG;IAC1B,OAAO;IACP,UAAU;IACV,cAAc;IACd,eAAe;IACf,QAAQ;IACR,OAAO;IACP,UAAU;CACX,CAAC;AACF,MAAM,mBAAmB,GAAG;IAC1B,OAAO;IACP,UAAU;IACV,cAAc;IACd,UAAU;IACV,mBAAmB;IACnB,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,UAAU;CACX,CAAC;AACF,MAAM,qBAAqB,GAAG;IAC5B,OAAO;IACP,cAAc;IACd,aAAa;IACb,cAAc;IACd,KAAK;CACN,CAAC;AACF,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;AAClE,MAAM,8BAA8B,GAAG;IACrC,WAAW;IACX,SAAS;IACT,OAAO;IACP,SAAS;IACT,UAAU;IACV,YAAY;IACZ,QAAQ;IACR,SAAS;IACT,UAAU;IACV,OAAO;IACP,QAAQ;IACR,UAAU;IACV,WAAW;IACX,UAAU;IACV,UAAU;IACV,OAAO;IACP,OAAO;IACP,YAAY;CACb,CAAC;AACF,MAAM,iBAAiB,GAAG;IACxB,gCAAgC;IAChC,qCAAqC;CACtC,CAAC;AAEF,SAAS,8BAA8B,CAAC,IAAY;IAClD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,OAAO,8BAA8B,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED,SAAS,uBAAuB,CAC9B,IAAY,EACZ,QAA2B,EAC3B,UAA6B;IAE7B,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;QAC/B,MAAM,WAAW,GAAG,GAAG,OAAO,GAAG,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;YACnC,MAAM,aAAa,GAAG,GAAG,WAAW,GAAG,SAAS,EAAE,CAAC;YACnD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBACpC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,gCAAgC,CACvC,IAAY,EACZ,QAA2B,EAC3B,UAA6B;IAE7B,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAC/B,iBAAiB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAChC,UAAU,CAAC,IAAI,CACb,CAAC,SAAS,EAAE,EAAE,CACZ,IAAI,CAAC,UAAU,CAAC,GAAG,OAAO,IAAI,MAAM,IAAI,SAAS,EAAE,CAAC;QACpD,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,8BAA8B,CAAC,IAAI,CAAC,CAAC,CACtE,CACF,CACF,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,QAAgB;IAC7C,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAEnD,IAAI,4BAA4B,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QAClE,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,6BAA6B,EAAE,CAAC;IAC3E,CAAC;IAED,IACE,uBAAuB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,mBAAmB,CAAC;QACzE,gCAAgC,CAC9B,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,CACpB;QACD,QAAQ,CAAC,UAAU,CAAC,sCAAsC,CAAC,EAC3D,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;IAC5D,CAAC;IAED,IACE,uBAAuB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,mBAAmB,CAAC;QACzE,gCAAgC,CAC9B,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,CACpB;QACD,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;QACjD,uBAAuB,CACrB,QAAQ,EACR,mBAAmB,EACnB,qBAAqB,CACtB;QACD,gCAAgC,CAC9B,QAAQ,EACR,mBAAmB,EACnB,qBAAqB,CACtB,EACD,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;IAC5D,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,IAAI,GAAG,YAAY,CAAC;IACxB,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO;YACL;gBACE,QAAQ,EAAE,OAAO,CAAC,MAAM;gBACxB,KAAK,EAAE,OAAO,CAAC,IAAI;gBACnB,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;aAC3C;SACF,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,oBAAoB;IAC5B,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CACxB,4BAA4B,MAAM,CAAC,QAAQ,iDAAiD;IAC9F,MAAM,EAAE,sCAAsC;IAC9C,QAAQ,EAAE,UAAU;CACrB,CAAC,CAAC;AAEH,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import { cleanSentence, startsWithWords, tokens } from "../../../shared/matchers/prose-patterns.js";
|
|
2
|
+
import { oneToOneRule } from "../../private/textlint-rule-builders.js";
|
|
3
|
+
const PREFIXES = ["however, ", "but ", "and ", "so "];
|
|
4
|
+
const AUTHORITY_STARTS = [
|
|
5
|
+
["according", "to", "experts"],
|
|
6
|
+
["according", "to", "researchers"],
|
|
7
|
+
["according", "to", "scientists"],
|
|
8
|
+
["data", "shows"],
|
|
9
|
+
["data", "suggests"],
|
|
10
|
+
["evidence", "shows"],
|
|
11
|
+
["evidence", "suggests"],
|
|
12
|
+
["experts", "agree"],
|
|
13
|
+
["experts", "recommend"],
|
|
14
|
+
["experts", "say"],
|
|
15
|
+
["experts", "warn"],
|
|
16
|
+
["it", "is", "commonly", "believed"],
|
|
17
|
+
["it", "is", "considered"],
|
|
18
|
+
["it", "is", "known", "for"],
|
|
19
|
+
["it", "is", "regarded", "as"],
|
|
20
|
+
["it", "is", "well", "established"],
|
|
21
|
+
["it", "is", "widely", "accepted"],
|
|
22
|
+
["many", "believe"],
|
|
23
|
+
["research", "confirms"],
|
|
24
|
+
["research", "indicates"],
|
|
25
|
+
["research", "proves"],
|
|
26
|
+
["research", "shows"],
|
|
27
|
+
["research", "suggests"],
|
|
28
|
+
["researchers", "agree"],
|
|
29
|
+
["researchers", "have", "found"],
|
|
30
|
+
["researchers", "say"],
|
|
31
|
+
["researchers", "warn"],
|
|
32
|
+
["science", "says"],
|
|
33
|
+
["science", "shows"],
|
|
34
|
+
["scientists", "agree"],
|
|
35
|
+
["scientists", "say"],
|
|
36
|
+
["scientists", "warn"],
|
|
37
|
+
["some", "argue"],
|
|
38
|
+
["some", "critics", "argue"],
|
|
39
|
+
["studies", "confirm"],
|
|
40
|
+
["studies", "indicate"],
|
|
41
|
+
["studies", "prove"],
|
|
42
|
+
["studies", "show"],
|
|
43
|
+
["studies", "suggest"]
|
|
44
|
+
];
|
|
45
|
+
const NAMED_SOURCES = [
|
|
46
|
+
"american academy of pediatrics",
|
|
47
|
+
"american psychological association",
|
|
48
|
+
"centers for disease control",
|
|
49
|
+
"cdc",
|
|
50
|
+
"fda",
|
|
51
|
+
"medlineplus",
|
|
52
|
+
"mayo clinic",
|
|
53
|
+
"national institutes of health",
|
|
54
|
+
"nih",
|
|
55
|
+
"world health organization",
|
|
56
|
+
"who"
|
|
57
|
+
];
|
|
58
|
+
const CITATION_MARKERS = [
|
|
59
|
+
"doi:",
|
|
60
|
+
"et al",
|
|
61
|
+
"http://",
|
|
62
|
+
"https://",
|
|
63
|
+
"pmid:",
|
|
64
|
+
"source:"
|
|
65
|
+
];
|
|
66
|
+
const MIN_AUTHORITY_TOKENS = 8;
|
|
67
|
+
function authorityStart(words) {
|
|
68
|
+
const match = AUTHORITY_STARTS.find((pattern) => startsWithWords(words, pattern));
|
|
69
|
+
return match?.join(" ");
|
|
70
|
+
}
|
|
71
|
+
function hasCitationMarker(text) {
|
|
72
|
+
if (text.includes("[") && text.includes("](")) {
|
|
73
|
+
return true;
|
|
74
|
+
}
|
|
75
|
+
if (text.includes("(") && text.includes(")")) {
|
|
76
|
+
return true;
|
|
77
|
+
}
|
|
78
|
+
return CITATION_MARKERS.some((marker) => text.includes(marker));
|
|
79
|
+
}
|
|
80
|
+
function hasNamedSource(text) {
|
|
81
|
+
return NAMED_SOURCES.some((source) => text.includes(source));
|
|
82
|
+
}
|
|
83
|
+
function hasDigit(text) {
|
|
84
|
+
for (const character of text) {
|
|
85
|
+
if (character >= "0" && character <= "9") {
|
|
86
|
+
return true;
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
return false;
|
|
90
|
+
}
|
|
91
|
+
function matchUncitedAuthority(sentence) {
|
|
92
|
+
const cleaned = cleanSentence(sentence, PREFIXES);
|
|
93
|
+
if (hasCitationMarker(cleaned) ||
|
|
94
|
+
hasNamedSource(cleaned) ||
|
|
95
|
+
hasDigit(cleaned)) {
|
|
96
|
+
return undefined;
|
|
97
|
+
}
|
|
98
|
+
const words = tokens(cleaned);
|
|
99
|
+
if (words.length < MIN_AUTHORITY_TOKENS) {
|
|
100
|
+
return undefined;
|
|
101
|
+
}
|
|
102
|
+
return authorityStart(words);
|
|
103
|
+
}
|
|
104
|
+
const rule = oneToOneRule({
|
|
105
|
+
detect: (unit) => {
|
|
106
|
+
const matched = matchUncitedAuthority(unit.text);
|
|
107
|
+
if (matched === undefined) {
|
|
108
|
+
return [];
|
|
109
|
+
}
|
|
110
|
+
return [
|
|
111
|
+
{
|
|
112
|
+
evidence: matched,
|
|
113
|
+
label: "uncited authority",
|
|
114
|
+
range: { end: unit.text.length, start: 0 }
|
|
115
|
+
}
|
|
116
|
+
];
|
|
117
|
+
},
|
|
118
|
+
family: "syntactic-patterns",
|
|
119
|
+
formatMessage: (report) => `Uncited authority found: ${report.evidence}. Name the source, cite the evidence, or make the claim directly.`,
|
|
120
|
+
ruleId: "syntactic-patterns:uncited-authority",
|
|
121
|
+
unitKind: "sentence"
|
|
122
|
+
});
|
|
123
|
+
export default rule;
|
|
124
|
+
//# sourceMappingURL=uncited-authority.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"uncited-authority.js","sourceRoot":"","sources":["../../../../src/rules/syntactic-patterns/authority/uncited-authority.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,eAAe,EACf,MAAM,EACP,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAEvE,MAAM,QAAQ,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AACtD,MAAM,gBAAgB,GAAmC;IACvD,CAAC,WAAW,EAAE,IAAI,EAAE,SAAS,CAAC;IAC9B,CAAC,WAAW,EAAE,IAAI,EAAE,aAAa,CAAC;IAClC,CAAC,WAAW,EAAE,IAAI,EAAE,YAAY,CAAC;IACjC,CAAC,MAAM,EAAE,OAAO,CAAC;IACjB,CAAC,MAAM,EAAE,UAAU,CAAC;IACpB,CAAC,UAAU,EAAE,OAAO,CAAC;IACrB,CAAC,UAAU,EAAE,UAAU,CAAC;IACxB,CAAC,SAAS,EAAE,OAAO,CAAC;IACpB,CAAC,SAAS,EAAE,WAAW,CAAC;IACxB,CAAC,SAAS,EAAE,KAAK,CAAC;IAClB,CAAC,SAAS,EAAE,MAAM,CAAC;IACnB,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC;IACpC,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC;IAC1B,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC;IAC5B,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC;IAC9B,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC;IACnC,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC;IAClC,CAAC,MAAM,EAAE,SAAS,CAAC;IACnB,CAAC,UAAU,EAAE,UAAU,CAAC;IACxB,CAAC,UAAU,EAAE,WAAW,CAAC;IACzB,CAAC,UAAU,EAAE,QAAQ,CAAC;IACtB,CAAC,UAAU,EAAE,OAAO,CAAC;IACrB,CAAC,UAAU,EAAE,UAAU,CAAC;IACxB,CAAC,aAAa,EAAE,OAAO,CAAC;IACxB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC;IAChC,CAAC,aAAa,EAAE,KAAK,CAAC;IACtB,CAAC,aAAa,EAAE,MAAM,CAAC;IACvB,CAAC,SAAS,EAAE,MAAM,CAAC;IACnB,CAAC,SAAS,EAAE,OAAO,CAAC;IACpB,CAAC,YAAY,EAAE,OAAO,CAAC;IACvB,CAAC,YAAY,EAAE,KAAK,CAAC;IACrB,CAAC,YAAY,EAAE,MAAM,CAAC;IACtB,CAAC,MAAM,EAAE,OAAO,CAAC;IACjB,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;IAC5B,CAAC,SAAS,EAAE,SAAS,CAAC;IACtB,CAAC,SAAS,EAAE,UAAU,CAAC;IACvB,CAAC,SAAS,EAAE,OAAO,CAAC;IACpB,CAAC,SAAS,EAAE,MAAM,CAAC;IACnB,CAAC,SAAS,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,aAAa,GAAG;IACpB,gCAAgC;IAChC,oCAAoC;IACpC,6BAA6B;IAC7B,KAAK;IACL,KAAK;IACL,aAAa;IACb,aAAa;IACb,+BAA+B;IAC/B,KAAK;IACL,2BAA2B;IAC3B,KAAK;CACN,CAAC;AACF,MAAM,gBAAgB,GAAG;IACvB,MAAM;IACN,OAAO;IACP,SAAS;IACT,UAAU;IACV,OAAO;IACP,SAAS;CACV,CAAC;AACF,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAE/B,SAAS,cAAc,CAAC,KAAwB;IAC9C,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAC9C,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAChC,CAAC;IACF,OAAO,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY;IACrC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,cAAc,CAAC,IAAY;IAClC,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY;IAC5B,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;QAC7B,IAAI,SAAS,IAAI,GAAG,IAAI,SAAS,IAAI,GAAG,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,qBAAqB,CAAC,QAAgB;IAC7C,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,IACE,iBAAiB,CAAC,OAAO,CAAC;QAC1B,cAAc,CAAC,OAAO,CAAC;QACvB,QAAQ,CAAC,OAAO,CAAC,EACjB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,MAAM,GAAG,oBAAoB,EAAE,CAAC;QACxC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,IAAI,GAAG,YAAY,CAAC;IACxB,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO;YACL;gBACE,QAAQ,EAAE,OAAO;gBACjB,KAAK,EAAE,mBAAmB;gBAC1B,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE;aAC3C;SACF,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,oBAAoB;IAC5B,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CACxB,4BAA4B,MAAM,CAAC,QAAQ,mEAAmE;IAChH,MAAM,EAAE,sCAAsC;IAC9C,QAAQ,EAAE,UAAU;CACrB,CAAC,CAAC;AAEH,eAAe,IAAI,CAAC"}
|
|
@@ -1,55 +1,67 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { defineTextlintRule } from "../../../adapters/textlint/rule.js";
|
|
2
|
+
import { sectionLastSentenceUnits, sentenceUnits } from "../../../adapters/textlint/units.js";
|
|
2
3
|
import { wordTokens } from "../../../shared/text/tokens.js";
|
|
3
|
-
import { emitTextlintFinding } from "../../../adapters/textlint/report.js";
|
|
4
4
|
const CLOSERS = ["and that's the key.", "that's what matters."];
|
|
5
|
+
const FORMULA_TAILS = [
|
|
6
|
+
"key",
|
|
7
|
+
"point",
|
|
8
|
+
"the real shift",
|
|
9
|
+
"real shift",
|
|
10
|
+
"whole point",
|
|
11
|
+
"thing",
|
|
12
|
+
"answer"
|
|
13
|
+
];
|
|
5
14
|
function isFormulaLine(text) {
|
|
6
15
|
const lower = text.toLocaleLowerCase("en");
|
|
7
16
|
return (wordTokens(text).length <= 6 &&
|
|
8
|
-
(lower.startsWith("that's the ") || lower.startsWith("that is the "))
|
|
17
|
+
(lower.startsWith("that's the ") || lower.startsWith("that is the ")) &&
|
|
18
|
+
FORMULA_TAILS.some((tail) => lower.includes(tail)));
|
|
9
19
|
}
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
}
|
|
13
|
-
const
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
emitTextlintFinding(context, {
|
|
26
|
-
node: item.paragraph,
|
|
27
|
-
ruleId: "syntactic-patterns:affirmation-closers",
|
|
28
|
-
message: `Affirmation closer found: "${closer}". Replace the empty affirmation with the actual conclusion.`,
|
|
29
|
-
range: {
|
|
30
|
-
start: item.source.originalStartFor(item.sentence.start),
|
|
31
|
-
end: item.source.originalEndFor(item.sentence.end)
|
|
20
|
+
const rule = defineTextlintRule({
|
|
21
|
+
detector: {
|
|
22
|
+
detect: ({ units }) => units.flatMap((unit) => {
|
|
23
|
+
const lower = unit.text.toLocaleLowerCase("en");
|
|
24
|
+
const closer = unit.id.startsWith("section-last-sentence:")
|
|
25
|
+
? CLOSERS.find((phrase) => lower.endsWith(phrase))
|
|
26
|
+
: undefined;
|
|
27
|
+
if (closer !== undefined) {
|
|
28
|
+
return [
|
|
29
|
+
{
|
|
30
|
+
evidence: closer,
|
|
31
|
+
label: "affirmation-closer",
|
|
32
|
+
range: { start: 0, end: unit.text.length },
|
|
33
|
+
ruleId: "syntactic-patterns:affirmation-closers",
|
|
34
|
+
unitId: unit.id
|
|
32
35
|
}
|
|
33
|
-
|
|
36
|
+
];
|
|
34
37
|
}
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
if (reported.has(key) || !isFormulaLine(item.sentence.text)) {
|
|
38
|
-
continue;
|
|
39
|
-
}
|
|
40
|
-
reported.add(key);
|
|
41
|
-
emitTextlintFinding(context, {
|
|
42
|
-
node: item.paragraph,
|
|
43
|
-
ruleId: "syntactic-patterns:affirmation-closers",
|
|
44
|
-
message: `Formula affirmation found: "${item.sentence.text}". Replace the empty formula line with substance.`,
|
|
45
|
-
range: {
|
|
46
|
-
start: item.source.originalStartFor(item.sentence.start),
|
|
47
|
-
end: item.source.originalEndFor(item.sentence.end)
|
|
48
|
-
}
|
|
49
|
-
});
|
|
38
|
+
if (!isFormulaLine(unit.text)) {
|
|
39
|
+
return [];
|
|
50
40
|
}
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
41
|
+
return [
|
|
42
|
+
{
|
|
43
|
+
evidence: unit.text,
|
|
44
|
+
label: "formula-affirmation",
|
|
45
|
+
range: { start: 0, end: unit.text.length },
|
|
46
|
+
ruleId: "syntactic-patterns:affirmation-closers",
|
|
47
|
+
unitId: unit.id
|
|
48
|
+
}
|
|
49
|
+
];
|
|
50
|
+
}),
|
|
51
|
+
family: "syntactic-patterns",
|
|
52
|
+
id: "syntactic-patterns:affirmation-closers"
|
|
53
|
+
},
|
|
54
|
+
formatMessage: (report) => report.detections[0]?.label === "affirmation-closer"
|
|
55
|
+
? `Affirmation closer found: "${report.evidence}". Replace the empty affirmation with the actual conclusion.`
|
|
56
|
+
: `Formula affirmation found: "${report.evidence}". Replace the empty formula line with substance.`,
|
|
57
|
+
reportPolicy: { kind: "one-to-one" },
|
|
58
|
+
units: (document) => {
|
|
59
|
+
const tailUnits = sectionLastSentenceUnits(document);
|
|
60
|
+
return [
|
|
61
|
+
...tailUnits,
|
|
62
|
+
...sentenceUnits(document).filter((unit) => !tailUnits.some((tailUnit) => tailUnit.text === unit.text && tailUnit.node === unit.node))
|
|
63
|
+
];
|
|
64
|
+
}
|
|
65
|
+
});
|
|
54
66
|
export default rule;
|
|
55
67
|
//# sourceMappingURL=affirmation-closers.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"affirmation-closers.js","sourceRoot":"","sources":["../../../../src/rules/syntactic-patterns/closers/affirmation-closers.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"affirmation-closers.js","sourceRoot":"","sources":["../../../../src/rules/syntactic-patterns/closers/affirmation-closers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EACL,wBAAwB,EACxB,aAAa,EACd,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAE5D,MAAM,OAAO,GAAG,CAAC,qBAAqB,EAAE,sBAAsB,CAAC,CAAC;AAChE,MAAM,aAAa,GAAG;IACpB,KAAK;IACL,OAAO;IACP,gBAAgB;IAChB,YAAY;IACZ,aAAa;IACb,OAAO;IACP,QAAQ;CACT,CAAC;AAEF,SAAS,aAAa,CAAC,IAAY;IACjC,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAE3C,OAAO,CACL,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC;QAC5B,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QACrE,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CACnD,CAAC;AACJ,CAAC;AAED,MAAM,IAAI,GAAG,kBAAkB,CAAC;IAC9B,QAAQ,EAAE;QACR,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CACpB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,wBAAwB,CAAC;gBACzD,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gBAClD,CAAC,CAAC,SAAS,CAAC;YACd,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,OAAO;oBACL;wBACE,QAAQ,EAAE,MAAM;wBAChB,KAAK,EAAE,oBAAoB;wBAC3B,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;wBAC1C,MAAM,EAAE,wCAAiD;wBACzD,MAAM,EAAE,IAAI,CAAC,EAAE;qBAChB;iBACF,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,OAAO;gBACL;oBACE,QAAQ,EAAE,IAAI,CAAC,IAAI;oBACnB,KAAK,EAAE,qBAAqB;oBAC5B,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;oBAC1C,MAAM,EAAE,wCAAiD;oBACzD,MAAM,EAAE,IAAI,CAAC,EAAE;iBAChB;aACF,CAAC;QACJ,CAAC,CAAC;QACJ,MAAM,EAAE,oBAAoB;QAC5B,EAAE,EAAE,wCAAwC;KAC7C;IACD,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CACxB,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,oBAAoB;QAClD,CAAC,CAAC,8BAA8B,MAAM,CAAC,QAAQ,8DAA8D;QAC7G,CAAC,CAAC,+BAA+B,MAAM,CAAC,QAAQ,mDAAmD;IACvG,YAAY,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE;IACpC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;QAClB,MAAM,SAAS,GAAG,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACrD,OAAO;YACL,GAAG,SAAS;YACZ,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAC/B,CAAC,IAAI,EAAE,EAAE,CACP,CAAC,SAAS,CAAC,IAAI,CACb,CAAC,QAAQ,EAAE,EAAE,CACX,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAC7D,CACJ;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,eAAe,IAAI,CAAC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { defineTextlintRule } from "../../../adapters/textlint/rule.js";
|
|
2
|
+
import { sentenceUnits } from "../../../adapters/textlint/units.js";
|
|
3
|
+
import { hasConcreteImplementationSummary } from "../../../shared/matchers/concrete-evidence.js";
|
|
2
4
|
import { cleanSentence, containsAny, tokens } from "../../../shared/matchers/prose-patterns.js";
|
|
3
|
-
import { allParagraphSentences } from "../../../shared/text/sections.js";
|
|
4
5
|
const PREFIXES = [
|
|
5
6
|
"ultimately, ",
|
|
6
7
|
"overall, ",
|
|
@@ -9,8 +10,13 @@ const PREFIXES = [
|
|
|
9
10
|
"and ",
|
|
10
11
|
"but "
|
|
11
12
|
];
|
|
12
|
-
const IMPORTANCE_CUES = [
|
|
13
|
-
|
|
13
|
+
const IMPORTANCE_CUES = [
|
|
14
|
+
"most important",
|
|
15
|
+
"single most important",
|
|
16
|
+
"deepest",
|
|
17
|
+
"powerful"
|
|
18
|
+
];
|
|
19
|
+
const SUMMARY_NOUNS = ["insight", "reason", "idea", "step", "method"];
|
|
14
20
|
const AUTHORITY_CLOSE_PATTERNS = [
|
|
15
21
|
"the research is clear",
|
|
16
22
|
"science is clear",
|
|
@@ -27,6 +33,10 @@ const BASIC_RULE_SIMPLE_PATTERN = "the basic rule is simple";
|
|
|
27
33
|
const COMPRESSION_CLOSE_PATTERNS = [
|
|
28
34
|
"the whole trick",
|
|
29
35
|
"the core fact",
|
|
36
|
+
"the useful part",
|
|
37
|
+
"the important part",
|
|
38
|
+
"the practical point",
|
|
39
|
+
"the practical takeaway",
|
|
30
40
|
"the rest is detail"
|
|
31
41
|
];
|
|
32
42
|
const FORMULA_SUBJECTS = ["that", "this", "it"];
|
|
@@ -37,6 +47,7 @@ const FORMULA_NOUNS = [
|
|
|
37
47
|
"game",
|
|
38
48
|
"idea",
|
|
39
49
|
"lesson",
|
|
50
|
+
"method",
|
|
40
51
|
"move",
|
|
41
52
|
"point",
|
|
42
53
|
"rule",
|
|
@@ -44,6 +55,14 @@ const FORMULA_NOUNS = [
|
|
|
44
55
|
"thing",
|
|
45
56
|
"trick"
|
|
46
57
|
];
|
|
58
|
+
const SUMMARY_FRAME_NOUNS = [
|
|
59
|
+
"answer",
|
|
60
|
+
"lesson",
|
|
61
|
+
"point",
|
|
62
|
+
"reason",
|
|
63
|
+
"takeaway",
|
|
64
|
+
"truth"
|
|
65
|
+
];
|
|
47
66
|
function matchInsightClose(text) {
|
|
48
67
|
if (IMPORTANCE_CUES.some((cue) => text.includes(cue)) &&
|
|
49
68
|
SUMMARY_NOUNS.some((noun) => text.includes(noun))) {
|
|
@@ -64,7 +83,7 @@ function matchResponseClose(text) {
|
|
|
64
83
|
}
|
|
65
84
|
function matchFormulaClose(text) {
|
|
66
85
|
const words = tokens(text);
|
|
67
|
-
if (words.length >
|
|
86
|
+
if (words.length > 12) {
|
|
68
87
|
return undefined;
|
|
69
88
|
}
|
|
70
89
|
const [first, second, third, fourth] = words;
|
|
@@ -78,6 +97,26 @@ function matchFormulaClose(text) {
|
|
|
78
97
|
}
|
|
79
98
|
return undefined;
|
|
80
99
|
}
|
|
100
|
+
function matchSummaryFrameClose(text) {
|
|
101
|
+
const words = tokens(text);
|
|
102
|
+
const [first, second, third] = words;
|
|
103
|
+
if (first === "the" &&
|
|
104
|
+
second !== undefined &&
|
|
105
|
+
SUMMARY_FRAME_NOUNS.includes(second) &&
|
|
106
|
+
(third === "is" || third === "was")) {
|
|
107
|
+
return `the-${second}-${third}`;
|
|
108
|
+
}
|
|
109
|
+
if (first === "the" &&
|
|
110
|
+
second !== undefined &&
|
|
111
|
+
third !== undefined &&
|
|
112
|
+
words[3] !== undefined &&
|
|
113
|
+
["real", "practical", "useful", "simple", "main", "big"].includes(second) &&
|
|
114
|
+
SUMMARY_FRAME_NOUNS.includes(third) &&
|
|
115
|
+
(words[3] === "is" || words[3] === "was")) {
|
|
116
|
+
return `the-${second}-${third}-${words[3]}`;
|
|
117
|
+
}
|
|
118
|
+
return undefined;
|
|
119
|
+
}
|
|
81
120
|
function matchConclusion(sentence, isTail) {
|
|
82
121
|
const stripped = cleanSentence(sentence, PREFIXES);
|
|
83
122
|
if (isTail) {
|
|
@@ -85,6 +124,12 @@ function matchConclusion(sentence, isTail) {
|
|
|
85
124
|
if (formula !== undefined) {
|
|
86
125
|
return { kind: "formula-close", signal: formula };
|
|
87
126
|
}
|
|
127
|
+
const summaryFrame = hasConcreteImplementationSummary(stripped)
|
|
128
|
+
? undefined
|
|
129
|
+
: matchSummaryFrameClose(stripped);
|
|
130
|
+
if (summaryFrame !== undefined) {
|
|
131
|
+
return { kind: "summary-frame-close", signal: summaryFrame };
|
|
132
|
+
}
|
|
88
133
|
const insight = matchInsightClose(stripped);
|
|
89
134
|
if (insight !== undefined) {
|
|
90
135
|
return { kind: "insight-close", signal: insight };
|
|
@@ -102,34 +147,39 @@ function matchConclusion(sentence, isTail) {
|
|
|
102
147
|
if (response !== undefined) {
|
|
103
148
|
return { kind: "response-close", signal: response };
|
|
104
149
|
}
|
|
105
|
-
const compression =
|
|
150
|
+
const compression = hasConcreteImplementationSummary(stripped)
|
|
151
|
+
? undefined
|
|
152
|
+
: containsAny(stripped, COMPRESSION_CLOSE_PATTERNS);
|
|
106
153
|
return compression === undefined
|
|
107
154
|
? undefined
|
|
108
155
|
: { kind: "compression-close", signal: compression };
|
|
109
156
|
}
|
|
110
|
-
const rule = (
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
sentences.forEach((item, index) => {
|
|
117
|
-
const matched = matchConclusion(item.sentence.text, index >= tailStart);
|
|
157
|
+
const rule = defineTextlintRule({
|
|
158
|
+
detector: {
|
|
159
|
+
detect: ({ units }) => {
|
|
160
|
+
const tailStart = Math.max(units.length - 3, 0);
|
|
161
|
+
return units.flatMap((unit, index) => {
|
|
162
|
+
const matched = matchConclusion(unit.text, index >= tailStart);
|
|
118
163
|
if (matched === undefined) {
|
|
119
|
-
return;
|
|
164
|
+
return [];
|
|
120
165
|
}
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
166
|
+
return [
|
|
167
|
+
{
|
|
168
|
+
evidence: matched.signal,
|
|
169
|
+
label: matched.kind,
|
|
170
|
+
range: { start: 0, end: unit.text.length },
|
|
171
|
+
ruleId: "syntactic-patterns:boilerplate-conclusion",
|
|
172
|
+
unitId: unit.id
|
|
128
173
|
}
|
|
129
|
-
|
|
174
|
+
];
|
|
130
175
|
});
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
|
|
176
|
+
},
|
|
177
|
+
family: "syntactic-patterns",
|
|
178
|
+
id: "syntactic-patterns:boilerplate-conclusion"
|
|
179
|
+
},
|
|
180
|
+
formatMessage: (report) => `Boilerplate conclusion found: ${report.evidence}. Replace the closer with a specific ending.`,
|
|
181
|
+
reportPolicy: { kind: "one-to-one" },
|
|
182
|
+
units: (document) => sentenceUnits(document)
|
|
183
|
+
});
|
|
134
184
|
export default rule;
|
|
135
185
|
//# sourceMappingURL=boilerplate-conclusion.js.map
|