@faircopy/rules-nlp 1.3.0 → 1.4.0
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 +9 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,17 +6,21 @@ Optional NLP-powered ruleset for faircopy using `compromise`.
|
|
|
6
6
|
npm i -D @faircopy/rules-nlp
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Load the ruleset once, then configure rules with bare rule IDs:
|
|
10
10
|
|
|
11
11
|
```ts
|
|
12
|
+
rulesets: ['@faircopy/rules-nlp'],
|
|
12
13
|
rules: {
|
|
13
|
-
'
|
|
14
|
-
'
|
|
15
|
-
'
|
|
16
|
-
'
|
|
14
|
+
'no-filter-words': 'warn',
|
|
15
|
+
'no-passive-voice': 'warn',
|
|
16
|
+
'no-weak-modals': 'warn',
|
|
17
|
+
'no-stacked-adjectives': 'warn',
|
|
18
|
+
'no-nominalized-phrases': 'warn',
|
|
17
19
|
}
|
|
18
20
|
```
|
|
19
21
|
|
|
22
|
+
Package-qualified IDs like `@faircopy/rules-nlp/no-passive-voice` still work and are required if another loaded ruleset exposes the same bare rule name.
|
|
23
|
+
|
|
20
24
|
## Rules
|
|
21
25
|
|
|
22
26
|
| Rule | Description |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@faircopy/rules-nlp",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"description": "Optional NLP-powered ruleset for faircopy using compromise",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"prepublishOnly": "pnpm run build"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@faircopy/core": "1.
|
|
22
|
+
"@faircopy/core": "1.4.0",
|
|
23
23
|
"compromise": "^14.15.0"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|