@chaffjs/lang-en 0.16.0 → 0.17.0

package/dist/definitions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../src/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAwB9C,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,KAAG,OAAsC,CAAC;AAE3F,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,KAAG,MAAM,GAAG,SACuC,CAAC;AAMrG,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,KAAG,OAAO,EAS/C,CAAC"}
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../src/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAwB9C,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,KAAG,OAAsC,CAAC;AAE3F,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,KAAG,MAAM,GAAG,SACuC,CAAC;AAMrG,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,KAAG,OAAO,EAW/C,CAAC"}

package/dist/definitions.js

@@ -27,7 +27,9 @@ export const definitions = (text) => DEFINITIONS.flatMap((pattern) => [...text.m
     if (term === undefined)
         return [];
     const end = match.index + match[0].length;
-    const namesAParty = match[0].startsWith("(") && APPLIES.test(text);
-    return [{ start: match.index, end, attrs: { term, ...(isPointer(text, end) || namesAParty ? { scope: "local" } : {}) } }];
+    const inline = match[0].startsWith("(");
+    const namesAParty = inline && APPLIES.test(text);
+    const scope = isPointer(text, end) || namesAParty ? { scope: "local" } : {};
+    return [{ start: match.index, end, attrs: { term, ...scope, ...(inline ? { placement: "inline" } : {}) } }];
 }));
 //# sourceMappingURL=definitions.js.map

package/dist/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../src/definitions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEvD,oEAAoE;AAEpE,MAAM,WAAW,GAAG;IAClB,mFAAmF;IACnF,4DAA4D;IAC5D,iEAAiE;CAClE,CAAC;AAEF;;;GAGG;AACH,MAAM,gBAAgB,GAAG,+GAA+G,CAAC;AACzI,iHAAiH;AACjH,MAAM,OAAO,GAAG,2BAA2B,CAAC;AAC5C,0HAA0H;AAC1H,MAAM,WAAW,GAA2C;IAC1D,CAAC,4BAA4B,EAAE,UAAU,CAAC;IAC1C,CAAC,+BAA+B,EAAE,aAAa,CAAC;CACjD,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAE3F,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAsB,EAAE,CACvE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAErG,mGAAmG;AACnG,MAAM,OAAO,GAAG,sCAAsC,CAAC;AACvD,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,GAAW,EAAW,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;AAEpH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAa,EAAE,CACrD,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC9B,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;IAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAClC,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAC1C,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnE,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAC5H,CAAC,CAAC,CACH,CAAC"}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../src/definitions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEvD,oEAAoE;AAEpE,MAAM,WAAW,GAAG;IAClB,mFAAmF;IACnF,4DAA4D;IAC5D,iEAAiE;CAClE,CAAC;AAEF;;;GAGG;AACH,MAAM,gBAAgB,GAAG,+GAA+G,CAAC;AACzI,iHAAiH;AACjH,MAAM,OAAO,GAAG,2BAA2B,CAAC;AAC5C,0HAA0H;AAC1H,MAAM,WAAW,GAA2C;IAC1D,CAAC,4BAA4B,EAAE,UAAU,CAAC;IAC1C,CAAC,+BAA+B,EAAE,aAAa,CAAC;CACjD,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAE3F,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAsB,EAAE,CACvE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAErG,mGAAmG;AACnG,MAAM,OAAO,GAAG,sCAAsC,CAAC;AACvD,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,GAAW,EAAW,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;AAEpH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAa,EAAE,CACrD,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC9B,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;IAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAClC,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAC1C,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACxC,MAAM,WAAW,GAAG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5E,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAC9G,CAAC,CAAC,CACH,CAAC"}

package/dist/lexicons.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lexicons.d.ts","sourceRoot":"","sources":["../src/lexicons.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAgB,MAAM,gBAAgB,CAAC;AAoB5D;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,MAAK,MAAY,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CASpE,CAAC"}
+{"version":3,"file":"lexicons.d.ts","sourceRoot":"","sources":["../src/lexicons.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAgB,MAAM,gBAAgB,CAAC;AAwB5D;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,MAAK,MAAY,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CASpE,CAAC"}

package/dist/lexicons.js

@@ -10,11 +10,15 @@ const toEntry = (raw) => {
         return undefined;
     const weight = raw["weight"];
     const instead = raw["instead_of"];
+    const rewrite = raw["rewrite"];
+    const group = raw["group"];
     return {
         pattern: raw["pattern"],
         weight: typeof weight === "number" ? weight : undefined,
         instead_of: typeof instead === "string" ? instead : undefined,
         position: POSITIONS.find((position) => position === raw["position"]),
+        rewrite: typeof rewrite === "string" ? rewrite : undefined,
+        ...(typeof group === "string" ? { group } : {}),
     };
 };
 /**

package/dist/lexicons.js.map

@@ -1 +1 @@
-{"version":3,"file":"lexicons.js","sourceRoot":"","sources":["../src/lexicons.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAG7B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;AAE5E,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAE5I,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAU,CAAC;AAE/C,MAAM,OAAO,GAAG,CAAC,GAAY,EAA4B,EAAE;IACzD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC3E,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC7B,MAAM,OAAO,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;IAClC,OAAO;QACL,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC;QACvB,MAAM,EAAE,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QACvD,UAAU,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QAC7D,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,KAAK,GAAG,CAAC,UAAU,CAAC,CAAC;KACrE,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAc,GAAG,EAA2B,EAAE,CACzE,MAAM,CAAC,WAAW,CAChB,WAAW,CAAC,GAAG,CAAC;KACb,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;KACxC,OAAO,CAAC,CAAC,IAAI,EAAuB,EAAE;IACrC,MAAM,GAAG,GAAY,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAClE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IACjG,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;AAC3F,CAAC,CAAC,CACL,CAAC"}
+{"version":3,"file":"lexicons.js","sourceRoot":"","sources":["../src/lexicons.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAG7B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;AAE5E,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAE5I,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAU,CAAC;AAE/C,MAAM,OAAO,GAAG,CAAC,GAAY,EAA4B,EAAE;IACzD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC3E,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC7B,MAAM,OAAO,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;IAClC,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3B,OAAO;QACL,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC;QACvB,MAAM,EAAE,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QACvD,UAAU,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QAC7D,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,KAAK,GAAG,CAAC,UAAU,CAAC,CAAC;QACpE,OAAO,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QAC1D,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChD,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAc,GAAG,EAA2B,EAAE,CACzE,MAAM,CAAC,WAAW,CAChB,WAAW,CAAC,GAAG,CAAC;KACb,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;KACxC,OAAO,CAAC,CAAC,IAAI,EAAuB,EAAE;IACrC,MAAM,GAAG,GAAY,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAClE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IACjG,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;AAC3F,CAAC,CAAC,CACL,CAAC"}

package/lexicons/ai-tell.yaml

@@ -5,20 +5,27 @@ language: en
 entries:
   - pattern: delve into
     weight: 0.9
+    rewrite: look at, or explain
   - pattern: in today's fast-paced world
     weight: 0.9
+    rewrite: delete it and start with the point
   - pattern: tapestry
     weight: 0.6
+    rewrite: name the parts
   - pattern: it's not just
     weight: 0.7
   - pattern: plays a crucial role
     weight: 0.8
+    rewrite: say what it does
   - pattern: navigate the complexities
     weight: 0.8
+    rewrite: name the hard part and say how it is handled
   - pattern: a testament to
     weight: 0.7
+    rewrite: shows
   - pattern: unlock the potential
     weight: 0.8
+    rewrite: say what becomes possible
   - pattern: deep dive
     weight: 0.5
   - pattern: intricate
@@ -27,10 +34,13 @@ entries:
     weight: 0.5
   - pattern: meticulous
     weight: 0.6
+    rewrite: careful, and say what was checked
   - pattern: meticulously
     weight: 0.6
+    rewrite: carefully, and say what was checked
   - pattern: pivotal
     weight: 0.5
+    rewrite: say what depends on it
   - pattern: in the realm of
     weight: 0.6
   - pattern: showcasing
@@ -85,6 +95,7 @@ entries:
     weight: 0.7
   - pattern: seamlessly
     weight: 0.5
+    rewrite: say what the reader no longer has to do
   - pattern: empowering
     weight: 0.5
   - pattern: game-changer
@@ -101,6 +112,7 @@ entries:
     weight: 0.5
   - pattern: it's worth noting
     weight: 0.5
+    rewrite: delete it and state the point
   - pattern: faces several challenges
     weight: 0.8
   - pattern: despite these challenges

package/lexicons/count-counter.yaml

@@ -1,5 +1,9 @@
 # Nouns that name what a list holds ("three steps", "two reasons"). Only a number followed by one of these (up to two
 # words may stand between: "three key steps") is read as the count of the list below.
+# Only nouns that name what a list holds. A plural that measures ("three years:", "two hours:", "30 seconds:") or a verb
+# ending in s ("Release 2 includes:") is not an announcement, so "any plural before a colon" is not used. Nouns that are
+# also verbs after a label number ("Section 2 documents:", "Model 4 outputs:") or that measure a degree ("two levels:")
+# are left out too.
 id: count-counter
 language: en
 entries:
@@ -38,3 +42,49 @@ entries:
   - pattern: lessons
   - pattern: takeaways
   - pattern: recommendations
+  - pattern: decisions
+  - pattern: findings
+  - pattern: examples
+  - pattern: objectives
+  - pattern: priorities
+  - pattern: outcomes
+  - pattern: problems
+  - pattern: challenges
+  - pattern: concerns
+  - pattern: ideas
+  - pattern: suggestions
+  - pattern: alternatives
+  - pattern: scenarios
+  - pattern: deliverables
+  - pattern: milestones
+  - pattern: responsibilities
+  - pattern: topics
+  - pattern: themes
+  - pattern: considerations
+  - pattern: constraints
+  - pattern: assumptions
+  - pattern: limitations
+  - pattern: advantages
+  - pattern: disadvantages
+  - pattern: strengths
+  - pattern: weaknesses
+  - pattern: opportunities
+  - pattern: conclusions
+  - pattern: observations
+  - pattern: insights
+  - pattern: roles
+  - pattern: values
+  - pattern: sections
+  - pattern: elements
+  - pattern: properties
+  - pattern: attributes
+  - pattern: parameters
+  - pattern: tools
+  - pattern: services
+  - pattern: resources
+  - pattern: policies
+  - pattern: guidelines
+  - pattern: metrics
+  - pattern: modes
+  - pattern: pillars
+  - pattern: exceptions

package/lexicons/cushion-phrase.yaml

@@ -9,3 +9,9 @@ entries:
   - pattern: when you get a chance
   - pattern: no rush but
   - pattern: apologies for
+  - pattern: hope this email finds you well
+  - pattern: hope this message finds you well
+  - pattern: hope this finds you well
+  - pattern: sorry to trouble
+  - pattern: just reaching out
+  - pattern: just checking in

package/lexicons/date-change-word.yaml

@@ -0,0 +1,27 @@
+# Words that, anywhere in the same sentence as "from … to", make it a change of date rather than a period: "the review
+# moved from March 10, 2026 to March 3, 2026", "the meeting from March 10 to March 3 was postponed".
+id: date-change-word
+language: en
+entries:
+  - pattern: moved
+  - pattern: move
+  - pattern: moving
+  - pattern: changed
+  - pattern: change
+  - pattern: changing
+  - pattern: postponed
+  - pattern: rescheduled
+  - pattern: reschedule
+  - pattern: brought forward
+  - pattern: bring forward
+  - pattern: pushed back
+  - pattern: push back
+  - pattern: delayed
+  - pattern: shifted
+  - pattern: advanced
+  - pattern: extended
+  - pattern: shortened
+  - pattern: updated
+  - pattern: corrected
+  - pattern: revised
+  - pattern: amended

package/lexicons/double-negative.yaml

@@ -0,0 +1,25 @@
+# Double negatives: a negation of a negative word, which says a positive without committing to it. The reader turns
+# the sentence over twice. "not without" is left out: "do not enter without a badge" is a plain prohibition.
+id: double-negative
+language: en
+entries:
+  - pattern: not uncommon
+  - pattern: not unusual
+  - pattern: not unlike
+  - pattern: not unreasonable
+  - pattern: not insignificant
+  - pattern: not inconsiderable
+  - pattern: not impossible
+  - pattern: not unlikely
+  - pattern: not unknown
+  - pattern: not unheard of
+  - pattern: not infrequently
+  - pattern: not infrequent
+  - pattern: not unimportant
+  - pattern: not dissimilar
+  - pattern: not unaware
+  - pattern: not unhelpful
+  - pattern: not ineffective
+  - pattern: not inconsistent
+  - pattern: not insubstantial
+  - pattern: not unwilling

package/lexicons/enumeration-frame.yaml

@@ -0,0 +1,37 @@
+# Words that announce a set of names: the platforms a product runs on, the languages it comes in. outside-announced-list
+# reads the names right after (position: before) or right before (position: after) the words, and compares later
+# statements of the same group with the first list of two or more names. Words that also frame ordinary nouns are left out.
+# "version" and "edition" are a group of their own: a product's editions (Oracle Free, Oracle Express Edition) are not its platforms.
+id: enumeration-frame
+language: en
+entries:
+  - pattern: supported on
+    position: before
+    group: platform
+  - pattern: runs on
+    position: before
+    group: platform
+  - pattern: available on
+    position: before
+    group: platform
+  - pattern: available for
+    position: before
+    group: platform
+  - pattern: compatible with
+    position: before
+    group: platform
+  - pattern: works on
+    position: before
+    group: platform
+  - pattern: version
+    position: after
+    group: edition
+  - pattern: edition
+    position: after
+    group: edition
+  - pattern: available in
+    position: before
+    group: language
+  - pattern: translated into
+    position: before
+    group: language

package/lexicons/enumeration-joiner.yaml

@@ -0,0 +1,9 @@
+# Words and marks that join the names of one list ("Windows, macOS and Linux"). Each entry is one token.
+id: enumeration-joiner
+language: en
+entries:
+  - pattern: ","
+  - pattern: and
+  - pattern: or
+  - pattern: "&"
+  - pattern: /

package/lexicons/enumeration-negation.yaml

@@ -0,0 +1,13 @@
+# Words that negate a sentence. A negated listing ("neither image is available on Docker Hub") names what is left out
+# of a list, not what belongs to it, so outside-announced-list does not read it. Each entry is one token.
+id: enumeration-negation
+language: en
+entries:
+  - pattern: not
+  - pattern: n't
+  - pattern: never
+  - pattern: neither
+  - pattern: nor
+  - pattern: "no"
+  - pattern: cannot
+  - pattern: unsupported

package/lexicons/nominalization-phrase.yaml

@@ -0,0 +1,27 @@
+# Hidden verbs: a verb turned into a noun and carried by a weak verb ("make a decision" for "decide"). nominalization
+# reads them. The Federal Plain Language Guidelines ("Use the active voice" / "Avoid hidden verbs") and GOV.UK ("Use
+# clear language") ask for the verb. instead_of is the verb. A verb in the pattern matches its other forms (made, makes).
+id: nominalization-phrase
+language: en
+entries:
+  - { pattern: make a decision, instead_of: decide }
+  - { pattern: reach a decision, instead_of: decide }
+  - { pattern: conduct an investigation, instead_of: investigate }
+  - { pattern: carry out an investigation, instead_of: investigate }
+  - { pattern: conduct an analysis, instead_of: analyze }
+  - { pattern: perform an analysis, instead_of: analyze }
+  - { pattern: carry out an analysis, instead_of: analyze }
+  - { pattern: make an assessment, instead_of: assess }
+  - { pattern: conduct an assessment, instead_of: assess }
+  - { pattern: conduct a review, instead_of: review }
+  - { pattern: perform a review, instead_of: review }
+  - { pattern: make a recommendation, instead_of: recommend }
+  - { pattern: make a determination, instead_of: determine }
+  - { pattern: give consideration to, instead_of: consider }
+  - { pattern: provide assistance, instead_of: help }
+  - { pattern: make an application, instead_of: apply }
+  - { pattern: make a payment, instead_of: pay }
+  - { pattern: make an adjustment, instead_of: adjust }
+  - { pattern: come to a conclusion, instead_of: conclude }
+  - { pattern: have a discussion, instead_of: discuss }
+  - { pattern: make reference to, instead_of: refer to }

package/lexicons/place-region.yaml

@@ -0,0 +1,247 @@
+# The names a place is followed by, after a comma, to say where it is: US states and the District of Columbia, and
+# countries ("New London, Wisconsin, and …", "Lyon, France, and …"). The comma between a place and its state or country
+# is part of the name, not a list's comma. Matched as written, word by word. A name with position: after is written only
+# after a place's name (Washington, D.C.), so it is read as one even after a state's name.
+id: place-region
+language: en
+entries:
+  - pattern: Alabama
+  - pattern: Alaska
+  - pattern: Arizona
+  - pattern: Arkansas
+  - pattern: California
+  - pattern: Colorado
+  - pattern: Connecticut
+  - pattern: Delaware
+  - pattern: Florida
+  - pattern: Georgia
+  - pattern: Hawaii
+  - pattern: Idaho
+  - pattern: Illinois
+  - pattern: Indiana
+  - pattern: Iowa
+  - pattern: Kansas
+  - pattern: Kentucky
+  - pattern: Louisiana
+  - pattern: Maine
+  - pattern: Maryland
+  - pattern: Massachusetts
+  - pattern: Michigan
+  - pattern: Minnesota
+  - pattern: Mississippi
+  - pattern: Missouri
+  - pattern: Montana
+  - pattern: Nebraska
+  - pattern: Nevada
+  - pattern: New Hampshire
+  - pattern: New Jersey
+  - pattern: New Mexico
+  - pattern: New York
+  - pattern: North Carolina
+  - pattern: North Dakota
+  - pattern: Ohio
+  - pattern: Oklahoma
+  - pattern: Oregon
+  - pattern: Pennsylvania
+  - pattern: Rhode Island
+  - pattern: South Carolina
+  - pattern: South Dakota
+  - pattern: Tennessee
+  - pattern: Texas
+  - pattern: Utah
+  - pattern: Vermont
+  - pattern: Virginia
+  - pattern: Washington
+  - pattern: West Virginia
+  - pattern: Wisconsin
+  - pattern: Wyoming
+  - pattern: D.C.
+    position: after
+  - pattern: Puerto Rico
+  - pattern: Guam
+  - pattern: Afghanistan
+  - pattern: Albania
+  - pattern: Algeria
+  - pattern: Andorra
+  - pattern: Angola
+  - pattern: Argentina
+  - pattern: Armenia
+  - pattern: Australia
+  - pattern: Austria
+  - pattern: Azerbaijan
+  - pattern: Bahamas
+  - pattern: Bahrain
+  - pattern: Bangladesh
+  - pattern: Barbados
+  - pattern: Belarus
+  - pattern: Belgium
+  - pattern: Belize
+  - pattern: Benin
+  - pattern: Bhutan
+  - pattern: Bolivia
+  - pattern: Bosnia and Herzegovina
+  - pattern: Botswana
+  - pattern: Brazil
+  - pattern: Brunei
+  - pattern: Bulgaria
+  - pattern: Burkina Faso
+  - pattern: Burundi
+  - pattern: Cambodia
+  - pattern: Cameroon
+  - pattern: Canada
+  - pattern: Chad
+  - pattern: Chile
+  - pattern: China
+  - pattern: Colombia
+  - pattern: Costa Rica
+  - pattern: Croatia
+  - pattern: Cuba
+  - pattern: Cyprus
+  - pattern: Czechia
+  - pattern: Czech Republic
+  - pattern: Denmark
+  - pattern: Djibouti
+  - pattern: Dominican Republic
+  - pattern: Ecuador
+  - pattern: Egypt
+  - pattern: El Salvador
+  - pattern: England
+  - pattern: Eritrea
+  - pattern: Estonia
+  - pattern: Eswatini
+  - pattern: Ethiopia
+  - pattern: Fiji
+  - pattern: Finland
+  - pattern: France
+  - pattern: Gabon
+  - pattern: Gambia
+  - pattern: Germany
+  - pattern: Ghana
+  - pattern: Greece
+  - pattern: Guatemala
+  - pattern: Guinea
+  - pattern: Guyana
+  - pattern: Haiti
+  - pattern: Honduras
+  - pattern: Hungary
+  - pattern: Iceland
+  - pattern: India
+  - pattern: Indonesia
+  - pattern: Iran
+  - pattern: Iraq
+  - pattern: Ireland
+  - pattern: Israel
+  - pattern: Italy
+  - pattern: Jamaica
+  - pattern: Japan
+  - pattern: Jordan
+  - pattern: Kazakhstan
+  - pattern: Kenya
+  - pattern: Kosovo
+  - pattern: Kuwait
+  - pattern: Kyrgyzstan
+  - pattern: Laos
+  - pattern: Latvia
+  - pattern: Lebanon
+  - pattern: Lesotho
+  - pattern: Liberia
+  - pattern: Libya
+  - pattern: Liechtenstein
+  - pattern: Lithuania
+  - pattern: Luxembourg
+  - pattern: Madagascar
+  - pattern: Malawi
+  - pattern: Malaysia
+  - pattern: Maldives
+  - pattern: Mali
+  - pattern: Malta
+  - pattern: Mauritania
+  - pattern: Mauritius
+  - pattern: Mexico
+  - pattern: Moldova
+  - pattern: Monaco
+  - pattern: Mongolia
+  - pattern: Montenegro
+  - pattern: Morocco
+  - pattern: Mozambique
+  - pattern: Myanmar
+  - pattern: Namibia
+  - pattern: Nepal
+  - pattern: Netherlands
+  - pattern: New Zealand
+  - pattern: Nicaragua
+  - pattern: Niger
+  - pattern: Nigeria
+  - pattern: North Korea
+  - pattern: North Macedonia
+  - pattern: Northern Ireland
+  - pattern: Norway
+  - pattern: Oman
+  - pattern: Pakistan
+  - pattern: Panama
+  - pattern: Papua New Guinea
+  - pattern: Paraguay
+  - pattern: Peru
+  - pattern: Philippines
+  - pattern: Poland
+  - pattern: Portugal
+  - pattern: Qatar
+  - pattern: Romania
+  - pattern: Russia
+  - pattern: Rwanda
+  - pattern: Saudi Arabia
+  - pattern: Scotland
+  - pattern: Senegal
+  - pattern: Serbia
+  - pattern: Sierra Leone
+  - pattern: Singapore
+  - pattern: Slovakia
+  - pattern: Slovenia
+  - pattern: Somalia
+  - pattern: South Africa
+  - pattern: South Korea
+  - pattern: South Sudan
+  - pattern: Spain
+  - pattern: Sri Lanka
+  - pattern: Sudan
+  - pattern: Suriname
+  - pattern: Sweden
+  - pattern: Switzerland
+  - pattern: Syria
+  - pattern: Taiwan
+  - pattern: Tajikistan
+  - pattern: Tanzania
+  - pattern: Thailand
+  - pattern: Togo
+  - pattern: Trinidad and Tobago
+  - pattern: Tunisia
+  - pattern: Turkey
+  - pattern: Türkiye
+  - pattern: Turkmenistan
+  - pattern: Uganda
+  - pattern: Ukraine
+  - pattern: United Arab Emirates
+  - pattern: United Kingdom
+  - pattern: UK
+  - pattern: U.K.
+  - pattern: United States
+  - pattern: USA
+  - pattern: U.S.
+  - pattern: U.S.A.
+  - pattern: Uruguay
+  - pattern: Uzbekistan
+  - pattern: Venezuela
+  - pattern: Vietnam
+  - pattern: Wales
+  - pattern: Yemen
+  - pattern: Zambia
+  - pattern: Zimbabwe
+  - pattern: Alberta
+  - pattern: British Columbia
+  - pattern: Manitoba
+  - pattern: New Brunswick
+  - pattern: Newfoundland and Labrador
+  - pattern: Nova Scotia
+  - pattern: Ontario
+  - pattern: Quebec
+  - pattern: Saskatchewan

package/lexicons/range-frame.yaml

@@ -0,0 +1,9 @@
+# A word before the first date and a word between the two dates that together make a period: "from 1 May 2026 to
+# 31 May 2026". Written as "lead … joint". "to" alone is not a range-connector because "moved from March 10 to March 3"
+# changes a date; date-change-word says when the frame is a change instead. "between … and" is not a frame: "choose
+# between 1 May and 30 April" names two dates to pick from.
+id: range-frame
+language: en
+entries:
+  - pattern: from … to
+  - pattern: from … up to

package/lexicons/requirement-either.yaml

@@ -0,0 +1,5 @@
+# "and/or" (Berry et al. 2003): the reader cannot tell whether both are meant, or either one is enough.
+id: requirement-either
+language: en
+entries:
+  - pattern: and/or

package/lexicons/requirement-loophole.yaml

@@ -0,0 +1,17 @@
+# Phrases that open a loophole in a requirement or leave it unverifiable (Femmer et al. 2017; the terms ISO/IEC/IEEE
+# 29148 says to avoid). The reader cannot tell how much is enough to meet it.
+id: requirement-loophole
+language: en
+entries:
+  - pattern: as far as possible
+  - pattern: as much as possible
+  - pattern: as soon as possible
+  - pattern: as fast as possible
+  - pattern: to the extent possible
+  - pattern: if possible
+  - pattern: where possible
+  - pattern: as appropriate
+  - pattern: where appropriate
+  - pattern: as applicable
+  - pattern: if necessary
+  - pattern: as needed

package/lexicons/requirement-marker.yaml

@@ -0,0 +1,9 @@
+# What makes a sentence a requirement for requirement-smell: the forms ISO/IEC/IEEE 29148 and the Federal Plain Language
+# Guidelines use for an obligation. Only a sentence with one of them is read as a requirement.
+id: requirement-marker
+language: en
+entries:
+  - pattern: shall
+  - pattern: must
+  - pattern: is required to
+  - pattern: are required to

package/lexicons/requirement-modal-must.yaml

@@ -0,0 +1,7 @@
+# "shall" and what to write instead (instead_of), read by requirement-modal when shall: must is set.
+# The Federal Plain Language Guidelines (PLAIN 2011) say to use "must" for an obligation: "shall" is ambiguous, read as
+# an obligation, a future or a permission, and courts have read it each way.
+id: requirement-modal-must
+language: en
+entries:
+  - { pattern: shall, instead_of: must }

package/lexicons/requirement-open-end.yaml

@@ -0,0 +1,9 @@
+# Words that leave a list open (Femmer et al. 2017, open-ended terms; ISO/IEC/IEEE 29148 names "but not limited to").
+# In a requirement the reader cannot tell what else it covers.
+id: requirement-open-end
+language: en
+entries:
+  - pattern: etc.
+  - pattern: and so on
+  - pattern: and the like
+  - pattern: but not limited to

package/lexicons/spelling-ize.yaml

@@ -0,0 +1,273 @@
+# -ise and -ize (organise / organize, organisation / organization). pattern is -ise, instead_of -ize.
+# Compared apart from spelling-variant: British writing uses both, and Oxford spelling writes -ize with colour.
+id: spelling-ize
+language: en
+entries:
+  - pattern: organise
+    instead_of: organize
+  - pattern: organises
+    instead_of: organizes
+  - pattern: organised
+    instead_of: organized
+  - pattern: organising
+    instead_of: organizing
+  - pattern: organisation
+    instead_of: organization
+  - pattern: organisations
+    instead_of: organizations
+  - pattern: organiser
+    instead_of: organizer
+  - pattern: organisers
+    instead_of: organizers
+  - pattern: recognise
+    instead_of: recognize
+  - pattern: recognises
+    instead_of: recognizes
+  - pattern: recognised
+    instead_of: recognized
+  - pattern: recognising
+    instead_of: recognizing
+  - pattern: realise
+    instead_of: realize
+  - pattern: realises
+    instead_of: realizes
+  - pattern: realised
+    instead_of: realized
+  - pattern: realising
+    instead_of: realizing
+  - pattern: realisation
+    instead_of: realization
+  - pattern: prioritise
+    instead_of: prioritize
+  - pattern: prioritises
+    instead_of: prioritizes
+  - pattern: prioritised
+    instead_of: prioritized
+  - pattern: prioritising
+    instead_of: prioritizing
+  - pattern: prioritisation
+    instead_of: prioritization
+  - pattern: minimise
+    instead_of: minimize
+  - pattern: minimises
+    instead_of: minimizes
+  - pattern: minimised
+    instead_of: minimized
+  - pattern: minimising
+    instead_of: minimizing
+  - pattern: maximise
+    instead_of: maximize
+  - pattern: maximises
+    instead_of: maximizes
+  - pattern: maximised
+    instead_of: maximized
+  - pattern: maximising
+    instead_of: maximizing
+  - pattern: optimise
+    instead_of: optimize
+  - pattern: optimises
+    instead_of: optimizes
+  - pattern: optimised
+    instead_of: optimized
+  - pattern: optimising
+    instead_of: optimizing
+  - pattern: optimisation
+    instead_of: optimization
+  - pattern: optimisations
+    instead_of: optimizations
+  - pattern: customise
+    instead_of: customize
+  - pattern: customises
+    instead_of: customizes
+  - pattern: customised
+    instead_of: customized
+  - pattern: customising
+    instead_of: customizing
+  - pattern: customisation
+    instead_of: customization
+  - pattern: customisable
+    instead_of: customizable
+  - pattern: standardise
+    instead_of: standardize
+  - pattern: standardises
+    instead_of: standardizes
+  - pattern: standardised
+    instead_of: standardized
+  - pattern: standardising
+    instead_of: standardizing
+  - pattern: standardisation
+    instead_of: standardization
+  - pattern: summarise
+    instead_of: summarize
+  - pattern: summarises
+    instead_of: summarizes
+  - pattern: summarised
+    instead_of: summarized
+  - pattern: summarising
+    instead_of: summarizing
+  - pattern: emphasise
+    instead_of: emphasize
+  - pattern: emphasises
+    instead_of: emphasizes
+  - pattern: emphasised
+    instead_of: emphasized
+  - pattern: emphasising
+    instead_of: emphasizing
+  - pattern: authorise
+    instead_of: authorize
+  - pattern: authorises
+    instead_of: authorizes
+  - pattern: authorised
+    instead_of: authorized
+  - pattern: authorising
+    instead_of: authorizing
+  - pattern: authorisation
+    instead_of: authorization
+  - pattern: authorisations
+    instead_of: authorizations
+  - pattern: categorise
+    instead_of: categorize
+  - pattern: categorises
+    instead_of: categorizes
+  - pattern: categorised
+    instead_of: categorized
+  - pattern: categorising
+    instead_of: categorizing
+  - pattern: categorisation
+    instead_of: categorization
+  - pattern: finalise
+    instead_of: finalize
+  - pattern: finalises
+    instead_of: finalizes
+  - pattern: finalised
+    instead_of: finalized
+  - pattern: finalising
+    instead_of: finalizing
+  - pattern: utilise
+    instead_of: utilize
+  - pattern: utilises
+    instead_of: utilizes
+  - pattern: utilised
+    instead_of: utilized
+  - pattern: utilising
+    instead_of: utilizing
+  - pattern: utilisation
+    instead_of: utilization
+  - pattern: apologise
+    instead_of: apologize
+  - pattern: apologises
+    instead_of: apologizes
+  - pattern: apologised
+    instead_of: apologized
+  - pattern: apologising
+    instead_of: apologizing
+  - pattern: criticise
+    instead_of: criticize
+  - pattern: criticises
+    instead_of: criticizes
+  - pattern: criticised
+    instead_of: criticized
+  - pattern: criticising
+    instead_of: criticizing
+  - pattern: specialise
+    instead_of: specialize
+  - pattern: specialises
+    instead_of: specializes
+  - pattern: specialised
+    instead_of: specialized
+  - pattern: specialising
+    instead_of: specializing
+  - pattern: specialisation
+    instead_of: specialization
+  - pattern: visualise
+    instead_of: visualize
+  - pattern: visualises
+    instead_of: visualizes
+  - pattern: visualised
+    instead_of: visualized
+  - pattern: visualising
+    instead_of: visualizing
+  - pattern: visualisation
+    instead_of: visualization
+  - pattern: visualisations
+    instead_of: visualizations
+  - pattern: initialise
+    instead_of: initialize
+  - pattern: initialises
+    instead_of: initializes
+  - pattern: initialised
+    instead_of: initialized
+  - pattern: initialising
+    instead_of: initializing
+  - pattern: initialisation
+    instead_of: initialization
+  - pattern: normalise
+    instead_of: normalize
+  - pattern: normalises
+    instead_of: normalizes
+  - pattern: normalised
+    instead_of: normalized
+  - pattern: normalising
+    instead_of: normalizing
+  - pattern: normalisation
+    instead_of: normalization
+  - pattern: synchronise
+    instead_of: synchronize
+  - pattern: synchronises
+    instead_of: synchronizes
+  - pattern: synchronised
+    instead_of: synchronized
+  - pattern: synchronising
+    instead_of: synchronizing
+  - pattern: synchronisation
+    instead_of: synchronization
+  - pattern: modernise
+    instead_of: modernize
+  - pattern: modernises
+    instead_of: modernizes
+  - pattern: modernised
+    instead_of: modernized
+  - pattern: modernising
+    instead_of: modernizing
+  - pattern: modernisation
+    instead_of: modernization
+  - pattern: digitise
+    instead_of: digitize
+  - pattern: digitises
+    instead_of: digitizes
+  - pattern: digitised
+    instead_of: digitized
+  - pattern: digitising
+    instead_of: digitizing
+  - pattern: digitisation
+    instead_of: digitization
+  - pattern: localise
+    instead_of: localize
+  - pattern: localises
+    instead_of: localizes
+  - pattern: localised
+    instead_of: localized
+  - pattern: localising
+    instead_of: localizing
+  - pattern: localisation
+    instead_of: localization
+  - pattern: centralise
+    instead_of: centralize
+  - pattern: centralises
+    instead_of: centralizes
+  - pattern: centralised
+    instead_of: centralized
+  - pattern: centralising
+    instead_of: centralizing
+  - pattern: centralisation
+    instead_of: centralization
+  - pattern: characterise
+    instead_of: characterize
+  - pattern: characterises
+    instead_of: characterizes
+  - pattern: characterised
+    instead_of: characterized
+  - pattern: characterising
+    instead_of: characterizing
+  - pattern: characterisation
+    instead_of: characterization

package/lexicons/spelling-variant.yaml

@@ -0,0 +1,260 @@
+# British and American spellings of the same word (colour / color, centre / center, travelled / traveled, analyse / analyze).
+# pattern is the British spelling, instead_of the American. Neither is wrong: spelling-consistency points at whichever the
+# document uses less. -ise / -ize is in spelling-ize, compared on its own, since Oxford spelling writes colour and organize.
+# Words with another meaning in one variety are left out: meter (a device), check (a verb), tire (a verb), program, license,
+# practice, judgment (a court's), dialog and analog (in software and electronics), analyses (the plural of analysis).
+id: spelling-variant
+language: en
+entries:
+  - pattern: colour
+    instead_of: color
+  - pattern: colours
+    instead_of: colors
+  - pattern: coloured
+    instead_of: colored
+  - pattern: colouring
+    instead_of: coloring
+  - pattern: colourful
+    instead_of: colorful
+  - pattern: colourless
+    instead_of: colorless
+  - pattern: favour
+    instead_of: favor
+  - pattern: favours
+    instead_of: favors
+  - pattern: favoured
+    instead_of: favored
+  - pattern: favouring
+    instead_of: favoring
+  - pattern: favourable
+    instead_of: favorable
+  - pattern: favourite
+    instead_of: favorite
+  - pattern: favourites
+    instead_of: favorites
+  - pattern: honour
+    instead_of: honor
+  - pattern: honours
+    instead_of: honors
+  - pattern: honoured
+    instead_of: honored
+  - pattern: honouring
+    instead_of: honoring
+  - pattern: honourable
+    instead_of: honorable
+  - pattern: labour
+    instead_of: labor
+  - pattern: labours
+    instead_of: labors
+  - pattern: laboured
+    instead_of: labored
+  - pattern: labouring
+    instead_of: laboring
+  - pattern: behaviour
+    instead_of: behavior
+  - pattern: behaviours
+    instead_of: behaviors
+  - pattern: behavioural
+    instead_of: behavioral
+  - pattern: neighbour
+    instead_of: neighbor
+  - pattern: neighbours
+    instead_of: neighbors
+  - pattern: neighbourhood
+    instead_of: neighborhood
+  - pattern: neighbourhoods
+    instead_of: neighborhoods
+  - pattern: neighbouring
+    instead_of: neighboring
+  - pattern: humour
+    instead_of: humor
+  - pattern: humours
+    instead_of: humors
+  - pattern: rumour
+    instead_of: rumor
+  - pattern: rumours
+    instead_of: rumors
+  - pattern: rumoured
+    instead_of: rumored
+  - pattern: harbour
+    instead_of: harbor
+  - pattern: harbours
+    instead_of: harbors
+  - pattern: endeavour
+    instead_of: endeavor
+  - pattern: endeavours
+    instead_of: endeavors
+  - pattern: endeavoured
+    instead_of: endeavored
+  - pattern: endeavouring
+    instead_of: endeavoring
+  - pattern: flavour
+    instead_of: flavor
+  - pattern: flavours
+    instead_of: flavors
+  - pattern: flavoured
+    instead_of: flavored
+  - pattern: flavouring
+    instead_of: flavoring
+  - pattern: vapour
+    instead_of: vapor
+  - pattern: vapours
+    instead_of: vapors
+  - pattern: savour
+    instead_of: savor
+  - pattern: savours
+    instead_of: savors
+  - pattern: savoury
+    instead_of: savory
+  - pattern: centre
+    instead_of: center
+  - pattern: centres
+    instead_of: centers
+  - pattern: centred
+    instead_of: centered
+  - pattern: theatre
+    instead_of: theater
+  - pattern: theatres
+    instead_of: theaters
+  - pattern: fibre
+    instead_of: fiber
+  - pattern: fibres
+    instead_of: fibers
+  - pattern: litre
+    instead_of: liter
+  - pattern: litres
+    instead_of: liters
+  - pattern: kilometre
+    instead_of: kilometer
+  - pattern: kilometres
+    instead_of: kilometers
+  - pattern: centimetre
+    instead_of: centimeter
+  - pattern: centimetres
+    instead_of: centimeters
+  - pattern: millimetre
+    instead_of: millimeter
+  - pattern: millimetres
+    instead_of: millimeters
+  - pattern: calibre
+    instead_of: caliber
+  - pattern: sombre
+    instead_of: somber
+  - pattern: analyse
+    instead_of: analyze
+  - pattern: analysed
+    instead_of: analyzed
+  - pattern: analysing
+    instead_of: analyzing
+  - pattern: analyser
+    instead_of: analyzer
+  - pattern: analysers
+    instead_of: analyzers
+  - pattern: paralyse
+    instead_of: paralyze
+  - pattern: paralysed
+    instead_of: paralyzed
+  - pattern: paralysing
+    instead_of: paralyzing
+  - pattern: catalyse
+    instead_of: catalyze
+  - pattern: catalysed
+    instead_of: catalyzed
+  - pattern: catalysing
+    instead_of: catalyzing
+  - pattern: defence
+    instead_of: defense
+  - pattern: defences
+    instead_of: defenses
+  - pattern: offence
+    instead_of: offense
+  - pattern: offences
+    instead_of: offenses
+  - pattern: pretence
+    instead_of: pretense
+  - pattern: pretences
+    instead_of: pretenses
+  - pattern: travelled
+    instead_of: traveled
+  - pattern: travelling
+    instead_of: traveling
+  - pattern: traveller
+    instead_of: traveler
+  - pattern: travellers
+    instead_of: travelers
+  - pattern: cancelled
+    instead_of: canceled
+  - pattern: cancelling
+    instead_of: canceling
+  - pattern: labelled
+    instead_of: labeled
+  - pattern: labelling
+    instead_of: labeling
+  - pattern: modelled
+    instead_of: modeled
+  - pattern: modelling
+    instead_of: modeling
+  - pattern: signalled
+    instead_of: signaled
+  - pattern: signalling
+    instead_of: signaling
+  - pattern: fuelled
+    instead_of: fueled
+  - pattern: fuelling
+    instead_of: fueling
+  - pattern: totalled
+    instead_of: totaled
+  - pattern: totalling
+    instead_of: totaling
+  - pattern: catalogue
+    instead_of: catalog
+  - pattern: catalogues
+    instead_of: catalogs
+  - pattern: catalogued
+    instead_of: cataloged
+  - pattern: grey
+    instead_of: gray
+  - pattern: greys
+    instead_of: grays
+  - pattern: greyer
+    instead_of: grayer
+  - pattern: greyest
+    instead_of: grayest
+  - pattern: aluminium
+    instead_of: aluminum
+  - pattern: enrol
+    instead_of: enroll
+  - pattern: enrols
+    instead_of: enrolls
+  - pattern: enrolment
+    instead_of: enrollment
+  - pattern: enrolments
+    instead_of: enrollments
+  - pattern: fulfil
+    instead_of: fulfill
+  - pattern: fulfils
+    instead_of: fulfills
+  - pattern: fulfilment
+    instead_of: fulfillment
+  - pattern: instalment
+    instead_of: installment
+  - pattern: instalments
+    instead_of: installments
+  - pattern: acknowledgement
+    instead_of: acknowledgment
+  - pattern: acknowledgements
+    instead_of: acknowledgments
+  - pattern: ageing
+    instead_of: aging
+  - pattern: manoeuvre
+    instead_of: maneuver
+  - pattern: manoeuvres
+    instead_of: maneuvers
+  - pattern: paediatric
+    instead_of: pediatric
+  - pattern: paediatrics
+    instead_of: pediatrics
+  - pattern: anaesthesia
+    instead_of: anesthesia
+  - pattern: oestrogen
+    instead_of: estrogen

package/lexicons/vague-clause-pointer.yaml

@@ -0,0 +1,10 @@
+# Pointing at a clause by where it is instead of by its number (JIS Z 8301:2019 10.6 avoids "the clause below").
+# instead_of names the kind in the message. Only a document that numbers its clauses or chapters (a numbered article
+# or chapter in its structure tree) is checked. Matched in any case.
+id: vague-clause-pointer
+language: en
+entries:
+  - { pattern: the above clause, instead_of: clause }
+  - { pattern: the clause above, instead_of: clause }
+  - { pattern: the below clause, instead_of: clause }
+  - { pattern: the clause below, instead_of: clause }

package/lexicons/vague-figure-pointer.yaml

@@ -0,0 +1,14 @@
+# Pointing at a figure or a table by where it is instead of by its number (JIS Z 8301:2019 10.6 avoids "the figure
+# above"). instead_of names the kind it points at, as figure-label names it (Figure, Table). Only a document that
+# numbers that kind is checked. Matched in any case.
+id: vague-figure-pointer
+language: en
+entries:
+  - { pattern: the above figure, instead_of: Figure }
+  - { pattern: the figure above, instead_of: Figure }
+  - { pattern: the below figure, instead_of: Figure }
+  - { pattern: the figure below, instead_of: Figure }
+  - { pattern: the above table, instead_of: Table }
+  - { pattern: the table above, instead_of: Table }
+  - { pattern: the below table, instead_of: Table }
+  - { pattern: the table below, instead_of: Table }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chaffjs/lang-en",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "English language adapter for chaff",
   "license": "MIT",
   "author": "isamu",

package/src/definitions.ts

@@ -37,7 +37,9 @@ export const definitions = (text: string): Mention[] =>
       const term = match.groups?.["term"];
       if (term === undefined) return [];
       const end = match.index + match[0].length;
-      const namesAParty = match[0].startsWith("(") && APPLIES.test(text);
-      return [{ start: match.index, end, attrs: { term, ...(isPointer(text, end) || namesAParty ? { scope: "local" } : {}) } }];
+      const inline = match[0].startsWith("(");
+      const namesAParty = inline && APPLIES.test(text);
+      const scope = isPointer(text, end) || namesAParty ? { scope: "local" } : {};
+      return [{ start: match.index, end, attrs: { term, ...scope, ...(inline ? { placement: "inline" } : {}) } }];
     }),
   );

package/src/lexicons.ts

@@ -14,11 +14,15 @@ const toEntry = (raw: unknown): LexiconEntry | undefined => {
   if (!isRecord(raw) || typeof raw["pattern"] !== "string") return undefined;
   const weight = raw["weight"];
   const instead = raw["instead_of"];
+  const rewrite = raw["rewrite"];
+  const group = raw["group"];
   return {
     pattern: raw["pattern"],
     weight: typeof weight === "number" ? weight : undefined,
     instead_of: typeof instead === "string" ? instead : undefined,
     position: POSITIONS.find((position) => position === raw["position"]),
+    rewrite: typeof rewrite === "string" ? rewrite : undefined,
+    ...(typeof group === "string" ? { group } : {}),
   };
 };