@faircopy/rules-nlp 1.4.0 → 1.6.0

package/README.md

@@ -11,7 +11,9 @@ Load the ruleset once, then configure rules with bare rule IDs:
 ```ts
 rulesets: ['@faircopy/rules-nlp'],
 rules: {
+  'no-expletive-openers': 'warn',
   'no-filter-words': 'warn',
+  'no-empty-transformation-claims': 'warn',
   'no-passive-voice': 'warn',
   'no-weak-modals': 'warn',
   'no-stacked-adjectives': 'warn',
@@ -25,6 +27,8 @@ Package-qualified IDs like `@faircopy/rules-nlp/no-passive-voice` still work and
 
 | Rule | Description |
 |---|---|
+| `no-empty-transformation-claims` | Flag broad transformation cliches like `transform the way teams work` |
+| `no-expletive-openers` | Flag sentence openings like `There are` |
 | `no-filter-words` | Ban filter phrases like `I think` and `it seems` |
 | `no-passive-voice` | Flag likely passive-voice constructions |
 | `no-weak-modals` | Flag hedged modal claims like `can help` and `might improve` |

package/dist/index.d.ts

@@ -1,10 +1,20 @@
 import { Rule } from '@faircopy/core';
 
+interface NoExpletiveOpenersOptions {
+    phrases?: string[];
+}
+declare const noExpletiveOpeners: Rule<NoExpletiveOpenersOptions>;
+
 interface NoFilterWordsOptions {
     phrases?: string[];
 }
 declare const noFilterWords: Rule<NoFilterWordsOptions>;
 
+interface NoEmptyTransformationClaimsOptions {
+    allowedPhrases?: string[];
+}
+declare const noEmptyTransformationClaims: Rule<NoEmptyTransformationClaimsOptions>;
+
 interface NoNominalizedPhrasesOptions {
     suffixes?: string[];
     allowedWords?: string[];
@@ -30,4 +40,4 @@ declare const noWeakModals: Rule<NoWeakModalsOptions>;
 /** All NLP rules keyed by their rule ID. */
 declare const ruleRegistry: Map<string, Rule>;
 
-export { type NoFilterWordsOptions, type NoNominalizedPhrasesOptions, type NoPassiveVoiceOptions, type NoStackedAdjectivesOptions, type NoWeakModalsOptions, noFilterWords, noNominalizedPhrases, noPassiveVoice, noStackedAdjectives, noWeakModals, ruleRegistry };
+export { type NoEmptyTransformationClaimsOptions, type NoExpletiveOpenersOptions, type NoFilterWordsOptions, type NoNominalizedPhrasesOptions, type NoPassiveVoiceOptions, type NoStackedAdjectivesOptions, type NoWeakModalsOptions, noEmptyTransformationClaims, noExpletiveOpeners, noFilterWords, noNominalizedPhrases, noPassiveVoice, noStackedAdjectives, noWeakModals, ruleRegistry };

package/dist/index.js

@@ -35,8 +35,49 @@ function sumTermLengths(terms) {
   return total;
 }
 
-// src/no-filter-words.ts
+// src/no-expletive-openers.ts
 var DEFAULT_PHRASES = [
+  "there is",
+  "there are",
+  "there was",
+  "there were",
+  "there will be"
+];
+var noExpletiveOpeners = {
+  id: "no-expletive-openers",
+  description: "Flag sentence openings that delay the real subject",
+  defaults: { phrases: DEFAULT_PHRASES },
+  help: 'Expletive openers like "there are" make copy indirect. Start with the actor, product, or benefit so the sentence lands faster.',
+  check({ text, sourceMap, options }) {
+    const diagnostics = [];
+    const phrases = options.phrases?.length ? options.phrases : DEFAULT_PHRASES;
+    const doc = createDoc(text);
+    for (const phrase of phrases) {
+      const matches = doc.match(phrase);
+      for (const occurrence of getMatchOccurrences(text, matches)) {
+        if (!startsSentence(text, occurrence.start)) continue;
+        const range = getOccurrenceRange(sourceMap, occurrence);
+        if (!range) continue;
+        diagnostics.push({
+          ruleId: "no-expletive-openers",
+          severity: "warn",
+          message: `start with the real subject instead of "${occurrence.text.toLowerCase()}"`,
+          range,
+          help: noExpletiveOpeners.help
+        });
+      }
+    }
+    return diagnostics.sort((left, right) => left.range.start - right.range.start);
+  }
+};
+function startsSentence(text, start) {
+  let index = start - 1;
+  while (index >= 0 && /\s/.test(text[index])) index--;
+  return index < 0 || /[.!?]/.test(text[index]);
+}
+
+// src/no-filter-words.ts
+var DEFAULT_PHRASES2 = [
   "I think",
   "it seems",
   "basically",
@@ -45,11 +86,11 @@ var DEFAULT_PHRASES = [
 var noFilterWords = {
   id: "no-filter-words",
   description: "Ban filter phrases that distance the claim from the reader",
-  defaults: { phrases: DEFAULT_PHRASES },
+  defaults: { phrases: DEFAULT_PHRASES2 },
   help: "Filter phrases announce a perspective or pad the sentence instead of making the point. Delete the phrase or rewrite the sentence so the claim stands on its own.",
   check({ text, sourceMap, options }) {
     const diagnostics = [];
-    const phrases = options.phrases?.length ? options.phrases : DEFAULT_PHRASES;
+    const phrases = options.phrases?.length ? options.phrases : DEFAULT_PHRASES2;
     const doc = createDoc(text);
     for (const phrase of phrases) {
       const matches = doc.match(phrase);
@@ -70,6 +111,54 @@ var noFilterWords = {
   }
 };
 
+// src/no-empty-transformation-claims.ts
+var PATTERNS = [
+  {
+    re: /\b(?:transform(?:s|ed|ing)?|chang(?:e|es|ed|ing)|reimagin(?:e|es|ed|ing)|revolutioniz(?:e|es|ed|ing))\s+the\s+way\s+(?:you|your\s+team|teams|companies|businesses|people)\s+(?:work|build|sell|operate|collaborate|communicate|create|grow|ship|scale|learn|manage)\b/gi,
+    message: "replace empty transformation claim with a concrete outcome"
+  },
+  {
+    re: /\bunlock\s+(?:your|their|team|teams'|your\s+team's|the\s+team's|the\s+full)\s+(?:potential|productivity|growth|creativity|efficiency)\b/gi,
+    message: "replace empty unlock claim with the specific benefit"
+  },
+  {
+    re: /\btake\s+(?:your|their|team|teams'|your\s+team's|the\s+team's)?\s*(?:productivity|workflow|workflows|growth|collaboration|business|operations|process|processes)\s+to\s+the\s+next\s+level\b/gi,
+    message: "replace next-level claim with measurable value"
+  }
+];
+var noEmptyTransformationClaims = {
+  id: "no-empty-transformation-claims",
+  description: "Flag broad transformation claims that do not name a concrete outcome",
+  defaults: { allowedPhrases: [] },
+  help: "Transformation cliches promise a feeling instead of a result. Replace them with the specific workflow, metric, or customer outcome the product changes.",
+  check({ text, sourceMap, options }) {
+    const diagnostics = [];
+    const allowedPhrases = new Set((options.allowedPhrases ?? []).map((value) => normalize(value)));
+    for (const pattern of PATTERNS) {
+      const re = new RegExp(pattern.re.source, pattern.re.flags);
+      let match;
+      while ((match = re.exec(text)) !== null) {
+        const phrase = match[0];
+        if (allowedPhrases.has(normalize(phrase))) continue;
+        const start = sourceMap[match.index];
+        const end = sourceMap[match.index + phrase.length - 1];
+        if (start === void 0 || end === void 0) continue;
+        diagnostics.push({
+          ruleId: "no-empty-transformation-claims",
+          severity: "warn",
+          message: `${pattern.message}: "${phrase}"`,
+          range: { start, end: end + 1 },
+          help: noEmptyTransformationClaims.help
+        });
+      }
+    }
+    return diagnostics;
+  }
+};
+function normalize(value) {
+  return value.toLowerCase().replace(/\s+/g, " ").trim();
+}
+
 // src/no-nominalized-phrases.ts
 var DEFAULT_SUFFIXES = ["tion", "sion", "ment", "ance", "ence", "ity"];
 var DEFAULT_ALLOWED_WORDS = [
@@ -231,6 +320,8 @@ var noWeakModals = {
 
 // src/index.ts
 var ruleRegistry = /* @__PURE__ */ new Map([
+  ["no-empty-transformation-claims", noEmptyTransformationClaims],
+  ["no-expletive-openers", noExpletiveOpeners],
   ["no-filter-words", noFilterWords],
   ["no-nominalized-phrases", noNominalizedPhrases],
   ["no-passive-voice", noPassiveVoice],
@@ -238,6 +329,8 @@ var ruleRegistry = /* @__PURE__ */ new Map([
   ["no-weak-modals", noWeakModals]
 ]);
 export {
+  noEmptyTransformationClaims,
+  noExpletiveOpeners,
   noFilterWords,
   noNominalizedPhrases,
   noPassiveVoice,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/utils.ts","../src/no-filter-words.ts","../src/no-nominalized-phrases.ts","../src/no-passive-voice.ts","../src/no-stacked-adjectives.ts","../src/no-weak-modals.ts","../src/index.ts"],"sourcesContent":["import nlp from 'compromise'\nimport type { Diagnostic } from '@faircopy/core'\nimport type { DocView, JsonOffsetEntry, JsonOffsetTerm, MatchView } from './types.js'\n\nexport interface MatchOccurrence {\n  text: string\n  start: number\n  end: number\n}\n\nexport function createDoc(text: string): DocView {\n  return nlp(text) as unknown as DocView\n}\n\nexport function getMatchOccurrences(text: string, matches: MatchView): MatchOccurrence[] {\n  const json = matches.json({ offset: true, text: true, terms: { offset: true } }) as JsonOffsetEntry[]\n\n  return json.flatMap((entry) => {\n    const start = entry.offset?.start ?? entry.terms?.[0]?.offset?.start\n    const length = entry.offset?.length ?? sumTermLengths(entry.terms)\n\n    if (typeof start !== 'number' || typeof length !== 'number' || length <= 0) {\n      return []\n    }\n\n    return [{\n      text: entry.text ?? text.slice(start, start + length),\n      start,\n      end: start + length,\n    }]\n  })\n}\n\nexport function getOccurrenceRange(sourceMap: number[], occurrence: MatchOccurrence): Diagnostic['range'] | null {\n  const start = sourceMap[occurrence.start]\n  const end = sourceMap[occurrence.end - 1]\n  if (start === undefined || end === undefined) return null\n\n  return { start, end: end + 1 }\n}\n\nfunction sumTermLengths(terms: JsonOffsetTerm[] | undefined): number | undefined {\n  if (!terms?.length) return undefined\n\n  let total = 0\n  for (const term of terms) {\n    const length = term.offset?.length\n    if (typeof length !== 'number') return undefined\n    total += length\n  }\n\n  return total\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences } from './utils.js'\n\nexport interface NoFilterWordsOptions {\n  phrases?: string[]\n}\n\nconst DEFAULT_PHRASES = [\n  'I think',\n  'it seems',\n  'basically',\n  'in order to',\n]\n\nexport const noFilterWords: Rule<NoFilterWordsOptions> = {\n  id: 'no-filter-words',\n  description: 'Ban filter phrases that distance the claim from the reader',\n  defaults: { phrases: DEFAULT_PHRASES },\n  help: 'Filter phrases announce a perspective or pad the sentence instead of making the point. Delete the phrase or rewrite the sentence so the claim stands on its own.',\n\n  check({ text, sourceMap, options }: RuleInput<NoFilterWordsOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const phrases = options.phrases?.length ? options.phrases : DEFAULT_PHRASES\n    const doc = createDoc(text)\n\n    for (const phrase of phrases) {\n      const matches = doc.match(phrase)\n      for (const occurrence of getMatchOccurrences(text, matches)) {\n        const start = sourceMap[occurrence.start]\n        const end = sourceMap[occurrence.end - 1]\n        if (start === undefined || end === undefined) continue\n\n        diagnostics.push({\n          ruleId: 'no-filter-words',\n          severity: 'error',\n          message: `remove \"${occurrence.text.toLowerCase()}\" — state the claim directly`,\n          range: { start, end: end + 1 },\n          help: noFilterWords.help,\n        })\n      }\n    }\n\n    return diagnostics\n  },\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences, getOccurrenceRange } from './utils.js'\n\nexport interface NoNominalizedPhrasesOptions {\n  suffixes?: string[]\n  allowedWords?: string[]\n}\n\nconst DEFAULT_SUFFIXES = ['tion', 'sion', 'ment', 'ance', 'ence', 'ity']\nconst DEFAULT_ALLOWED_WORDS = [\n  'accessibility',\n  'availability',\n  'capacity',\n  'community',\n  'identity',\n  'opportunity',\n  'privacy',\n  'quality',\n  'reliability',\n  'security',\n]\n\nexport const noNominalizedPhrases: Rule<NoNominalizedPhrasesOptions> = {\n  id: 'no-nominalized-phrases',\n  description: 'Flag nominalized \"X of Y\" phrases that hide the action in a noun',\n  defaults: { suffixes: DEFAULT_SUFFIXES, allowedWords: DEFAULT_ALLOWED_WORDS },\n  help: 'Nominalized phrases bury the action. Rewrite the phrase with a verb so the sentence says who does what.',\n\n  check({ text, sourceMap, options }: RuleInput<NoNominalizedPhrasesOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const suffixes = options.suffixes?.length ? options.suffixes : DEFAULT_SUFFIXES\n    const allowedWords = new Set((options.allowedWords?.length ? options.allowedWords : DEFAULT_ALLOWED_WORDS).map(value => value.toLowerCase()))\n    const suffixPattern = suffixes.map(escapeRegex).join('|')\n    if (!suffixPattern) return diagnostics\n\n    const doc = createDoc(text)\n    const matches = doc.match(`/[a-z]+(${suffixPattern})/ of .`)\n\n    for (const occurrence of getMatchOccurrences(text, matches)) {\n      const nominalization = occurrence.text.trim().split(/\\s+/)[0]?.toLowerCase()\n      if (!nominalization || allowedWords.has(nominalization)) continue\n\n      const range = getOccurrenceRange(sourceMap, occurrence)\n      if (!range) continue\n\n      diagnostics.push({\n        ruleId: 'no-nominalized-phrases',\n        severity: 'warn',\n        message: `rewrite \"${occurrence.text}\" with a verb`,\n        range,\n        help: noNominalizedPhrases.help,\n      })\n    }\n\n    return diagnostics\n  },\n}\n\nfunction escapeRegex(value: string): string {\n  return value.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\$&')\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences } from './utils.js'\n\nexport interface NoPassiveVoiceOptions {\n  allowedAuxiliaries?: string[]\n}\n\nconst DEFAULT_ALLOWED_AUXILIARIES = ['is', 'are', 'was', 'were', 'be', 'been', 'being']\n\nexport const noPassiveVoice: Rule<NoPassiveVoiceOptions> = {\n  id: 'no-passive-voice',\n  description: 'Flag likely passive-voice constructions using POS tagging patterns',\n  defaults: { allowedAuxiliaries: DEFAULT_ALLOWED_AUXILIARIES },\n  help: 'Passive voice often hides the actor and adds drag. Prefer naming who did the action unless the actor genuinely does not matter.',\n\n  check({ text, sourceMap, options }: RuleInput<NoPassiveVoiceOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const auxiliaries = new Set((options.allowedAuxiliaries?.length ? options.allowedAuxiliaries : DEFAULT_ALLOWED_AUXILIARIES).map(value => value.toLowerCase()))\n    const doc = createDoc(text)\n    const matches = doc.match('(#Copula|#Auxiliary) #PastTense')\n\n    for (const occurrence of getMatchOccurrences(text, matches)) {\n      const words = occurrence.text.trim().split(/\\s+/)\n      if (words.length < 2) continue\n      if (!auxiliaries.has(words[0]!.toLowerCase())) continue\n\n      const start = sourceMap[occurrence.start]\n      const end = sourceMap[occurrence.end - 1]\n      if (start === undefined || end === undefined) continue\n\n      diagnostics.push({\n        ruleId: 'no-passive-voice',\n        severity: 'warn',\n        message: `rewrite passive construction \"${occurrence.text}\" with a named actor`,\n        range: { start, end: end + 1 },\n        help: noPassiveVoice.help,\n      })\n    }\n\n    return dedupeDiagnostics(diagnostics)\n  },\n}\n\nfunction dedupeDiagnostics(diagnostics: Diagnostic[]): Diagnostic[] {\n  const seen = new Set<string>()\n  return diagnostics.filter((diagnostic) => {\n    const key = `${diagnostic.range.start}:${diagnostic.range.end}`\n    if (seen.has(key)) return false\n    seen.add(key)\n    return true\n  })\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences, getOccurrenceRange } from './utils.js'\n\nexport interface NoStackedAdjectivesOptions {\n  allowedPhrases?: string[]\n}\n\nexport const noStackedAdjectives: Rule<NoStackedAdjectivesOptions> = {\n  id: 'no-stacked-adjectives',\n  description: 'Flag noun phrases with multiple adjectives before the noun',\n  defaults: { allowedPhrases: [] },\n  help: 'Stacked adjectives make copy feel generic. Keep the one descriptor that earns its place or replace the phrase with concrete evidence.',\n\n  check({ text, sourceMap, options }: RuleInput<NoStackedAdjectivesOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const allowedPhrases = new Set((options.allowedPhrases ?? []).map(value => value.toLowerCase()))\n    const doc = createDoc(text)\n    const matches = doc.match('#Adjective #Adjective+ #Noun')\n\n    for (const occurrence of getMatchOccurrences(text, matches)) {\n      if (allowedPhrases.has(occurrence.text.toLowerCase())) continue\n\n      const range = getOccurrenceRange(sourceMap, occurrence)\n      if (!range) continue\n\n      diagnostics.push({\n        ruleId: 'no-stacked-adjectives',\n        severity: 'warn',\n        message: `cut stacked adjectives in \"${occurrence.text}\"`,\n        range,\n        help: noStackedAdjectives.help,\n      })\n    }\n\n    return diagnostics\n  },\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences, getOccurrenceRange } from './utils.js'\n\nexport interface NoWeakModalsOptions {\n  modals?: string[]\n  verbs?: string[]\n}\n\nconst DEFAULT_MODALS = ['can', 'could', 'may', 'might']\nconst DEFAULT_VERBS = [\n  'boost',\n  'drive',\n  'enable',\n  'help',\n  'improve',\n  'increase',\n  'make',\n  'reduce',\n  'support',\n  'transform',\n  'unlock',\n]\n\nexport const noWeakModals: Rule<NoWeakModalsOptions> = {\n  id: 'no-weak-modals',\n  description: 'Flag hedged modal claims like \"can help\" and \"might improve\"',\n  defaults: { modals: DEFAULT_MODALS, verbs: DEFAULT_VERBS },\n  help: 'Hedged modal claims sound tentative. Replace them with the outcome, capability, or proof you can stand behind.',\n\n  check({ text, sourceMap, options }: RuleInput<NoWeakModalsOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const modals = new Set((options.modals?.length ? options.modals : DEFAULT_MODALS).map(value => value.toLowerCase()))\n    const verbs = new Set((options.verbs?.length ? options.verbs : DEFAULT_VERBS).map(value => value.toLowerCase()))\n    const doc = createDoc(text)\n    const matches = doc.match('#Modal #Adverb? #Verb')\n\n    for (const occurrence of getMatchOccurrences(text, matches)) {\n      const words = occurrence.text.trim().split(/\\s+/)\n      const modal = words[0]?.toLowerCase()\n      const verb = words[words.length - 1]?.toLowerCase()\n      if (!modal || !verb || !modals.has(modal) || !verbs.has(verb)) continue\n\n      const range = getOccurrenceRange(sourceMap, occurrence)\n      if (!range) continue\n\n      diagnostics.push({\n        ruleId: 'no-weak-modals',\n        severity: 'warn',\n        message: `replace \"${occurrence.text.toLowerCase()}\" with a direct claim`,\n        range,\n        help: noWeakModals.help,\n      })\n    }\n\n    return diagnostics\n  },\n}\n","import type { Rule } from '@faircopy/core'\nimport { noFilterWords } from './no-filter-words.js'\nimport { noNominalizedPhrases } from './no-nominalized-phrases.js'\nimport { noPassiveVoice } from './no-passive-voice.js'\nimport { noStackedAdjectives } from './no-stacked-adjectives.js'\nimport { noWeakModals } from './no-weak-modals.js'\n\nexport { noFilterWords } from './no-filter-words.js'\nexport { noNominalizedPhrases } from './no-nominalized-phrases.js'\nexport { noPassiveVoice } from './no-passive-voice.js'\nexport { noStackedAdjectives } from './no-stacked-adjectives.js'\nexport { noWeakModals } from './no-weak-modals.js'\nexport type { NoFilterWordsOptions } from './no-filter-words.js'\nexport type { NoNominalizedPhrasesOptions } from './no-nominalized-phrases.js'\nexport type { NoPassiveVoiceOptions } from './no-passive-voice.js'\nexport type { NoStackedAdjectivesOptions } from './no-stacked-adjectives.js'\nexport type { NoWeakModalsOptions } from './no-weak-modals.js'\n\n/** All NLP rules keyed by their rule ID. */\nexport const ruleRegistry: Map<string, Rule> = new Map([\n  ['no-filter-words', noFilterWords as Rule],\n  ['no-nominalized-phrases', noNominalizedPhrases as Rule],\n  ['no-passive-voice', noPassiveVoice as Rule],\n  ['no-stacked-adjectives', noStackedAdjectives as Rule],\n  ['no-weak-modals', noWeakModals as Rule],\n])\n"],"mappings":";AAAA,OAAO,SAAS;AAUT,SAAS,UAAU,MAAuB;AAC/C,SAAO,IAAI,IAAI;AACjB;AAEO,SAAS,oBAAoB,MAAc,SAAuC;AACvF,QAAM,OAAO,QAAQ,KAAK,EAAE,QAAQ,MAAM,MAAM,MAAM,OAAO,EAAE,QAAQ,KAAK,EAAE,CAAC;AAE/E,SAAO,KAAK,QAAQ,CAAC,UAAU;AAC7B,UAAM,QAAQ,MAAM,QAAQ,SAAS,MAAM,QAAQ,CAAC,GAAG,QAAQ;AAC/D,UAAM,SAAS,MAAM,QAAQ,UAAU,eAAe,MAAM,KAAK;AAEjE,QAAI,OAAO,UAAU,YAAY,OAAO,WAAW,YAAY,UAAU,GAAG;AAC1E,aAAO,CAAC;AAAA,IACV;AAEA,WAAO,CAAC;AAAA,MACN,MAAM,MAAM,QAAQ,KAAK,MAAM,OAAO,QAAQ,MAAM;AAAA,MACpD;AAAA,MACA,KAAK,QAAQ;AAAA,IACf,CAAC;AAAA,EACH,CAAC;AACH;AAEO,SAAS,mBAAmB,WAAqB,YAAyD;AAC/G,QAAM,QAAQ,UAAU,WAAW,KAAK;AACxC,QAAM,MAAM,UAAU,WAAW,MAAM,CAAC;AACxC,MAAI,UAAU,UAAa,QAAQ,OAAW,QAAO;AAErD,SAAO,EAAE,OAAO,KAAK,MAAM,EAAE;AAC/B;AAEA,SAAS,eAAe,OAAyD;AAC/E,MAAI,CAAC,OAAO,OAAQ,QAAO;AAE3B,MAAI,QAAQ;AACZ,aAAW,QAAQ,OAAO;AACxB,UAAM,SAAS,KAAK,QAAQ;AAC5B,QAAI,OAAO,WAAW,SAAU,QAAO;AACvC,aAAS;AAAA,EACX;AAEA,SAAO;AACT;;;AC7CA,IAAM,kBAAkB;AAAA,EACtB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,gBAA4C;AAAA,EACvD,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,SAAS,gBAAgB;AAAA,EACrC,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAkD;AACjF,UAAM,cAA4B,CAAC;AACnC,UAAM,UAAU,QAAQ,SAAS,SAAS,QAAQ,UAAU;AAC5D,UAAM,MAAM,UAAU,IAAI;AAE1B,eAAW,UAAU,SAAS;AAC5B,YAAM,UAAU,IAAI,MAAM,MAAM;AAChC,iBAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,cAAM,QAAQ,UAAU,WAAW,KAAK;AACxC,cAAM,MAAM,UAAU,WAAW,MAAM,CAAC;AACxC,YAAI,UAAU,UAAa,QAAQ,OAAW;AAE9C,oBAAY,KAAK;AAAA,UACf,QAAQ;AAAA,UACR,UAAU;AAAA,UACV,SAAS,WAAW,WAAW,KAAK,YAAY,CAAC;AAAA,UACjD,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE;AAAA,UAC7B,MAAM,cAAc;AAAA,QACtB,CAAC;AAAA,MACH;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AACF;;;ACpCA,IAAM,mBAAmB,CAAC,QAAQ,QAAQ,QAAQ,QAAQ,QAAQ,KAAK;AACvE,IAAM,wBAAwB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,uBAA0D;AAAA,EACrE,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,UAAU,kBAAkB,cAAc,sBAAsB;AAAA,EAC5E,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAyD;AACxF,UAAM,cAA4B,CAAC;AACnC,UAAM,WAAW,QAAQ,UAAU,SAAS,QAAQ,WAAW;AAC/D,UAAM,eAAe,IAAI,KAAK,QAAQ,cAAc,SAAS,QAAQ,eAAe,uBAAuB,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AAC5I,UAAM,gBAAgB,SAAS,IAAI,WAAW,EAAE,KAAK,GAAG;AACxD,QAAI,CAAC,cAAe,QAAO;AAE3B,UAAM,MAAM,UAAU,IAAI;AAC1B,UAAM,UAAU,IAAI,MAAM,WAAW,aAAa,SAAS;AAE3D,eAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,YAAM,iBAAiB,WAAW,KAAK,KAAK,EAAE,MAAM,KAAK,EAAE,CAAC,GAAG,YAAY;AAC3E,UAAI,CAAC,kBAAkB,aAAa,IAAI,cAAc,EAAG;AAEzD,YAAM,QAAQ,mBAAmB,WAAW,UAAU;AACtD,UAAI,CAAC,MAAO;AAEZ,kBAAY,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,UAAU;AAAA,QACV,SAAS,YAAY,WAAW,IAAI;AAAA,QACpC;AAAA,QACA,MAAM,qBAAqB;AAAA,MAC7B,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AACF;AAEA,SAAS,YAAY,OAAuB;AAC1C,SAAO,MAAM,QAAQ,uBAAuB,MAAM;AACpD;;;ACrDA,IAAM,8BAA8B,CAAC,MAAM,OAAO,OAAO,QAAQ,MAAM,QAAQ,OAAO;AAE/E,IAAM,iBAA8C;AAAA,EACzD,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,oBAAoB,4BAA4B;AAAA,EAC5D,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAmD;AAClF,UAAM,cAA4B,CAAC;AACnC,UAAM,cAAc,IAAI,KAAK,QAAQ,oBAAoB,SAAS,QAAQ,qBAAqB,6BAA6B,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AAC7J,UAAM,MAAM,UAAU,IAAI;AAC1B,UAAM,UAAU,IAAI,MAAM,iCAAiC;AAE3D,eAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,YAAM,QAAQ,WAAW,KAAK,KAAK,EAAE,MAAM,KAAK;AAChD,UAAI,MAAM,SAAS,EAAG;AACtB,UAAI,CAAC,YAAY,IAAI,MAAM,CAAC,EAAG,YAAY,CAAC,EAAG;AAE/C,YAAM,QAAQ,UAAU,WAAW,KAAK;AACxC,YAAM,MAAM,UAAU,WAAW,MAAM,CAAC;AACxC,UAAI,UAAU,UAAa,QAAQ,OAAW;AAE9C,kBAAY,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,UAAU;AAAA,QACV,SAAS,iCAAiC,WAAW,IAAI;AAAA,QACzD,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE;AAAA,QAC7B,MAAM,eAAe;AAAA,MACvB,CAAC;AAAA,IACH;AAEA,WAAO,kBAAkB,WAAW;AAAA,EACtC;AACF;AAEA,SAAS,kBAAkB,aAAyC;AAClE,QAAM,OAAO,oBAAI,IAAY;AAC7B,SAAO,YAAY,OAAO,CAAC,eAAe;AACxC,UAAM,MAAM,GAAG,WAAW,MAAM,KAAK,IAAI,WAAW,MAAM,GAAG;AAC7D,QAAI,KAAK,IAAI,GAAG,EAAG,QAAO;AAC1B,SAAK,IAAI,GAAG;AACZ,WAAO;AAAA,EACT,CAAC;AACH;;;AC5CO,IAAM,sBAAwD;AAAA,EACnE,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,gBAAgB,CAAC,EAAE;AAAA,EAC/B,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAwD;AACvF,UAAM,cAA4B,CAAC;AACnC,UAAM,iBAAiB,IAAI,KAAK,QAAQ,kBAAkB,CAAC,GAAG,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AAC/F,UAAM,MAAM,UAAU,IAAI;AAC1B,UAAM,UAAU,IAAI,MAAM,8BAA8B;AAExD,eAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,UAAI,eAAe,IAAI,WAAW,KAAK,YAAY,CAAC,EAAG;AAEvD,YAAM,QAAQ,mBAAmB,WAAW,UAAU;AACtD,UAAI,CAAC,MAAO;AAEZ,kBAAY,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,UAAU;AAAA,QACV,SAAS,8BAA8B,WAAW,IAAI;AAAA,QACtD;AAAA,QACA,MAAM,oBAAoB;AAAA,MAC5B,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AACF;;;AC5BA,IAAM,iBAAiB,CAAC,OAAO,SAAS,OAAO,OAAO;AACtD,IAAM,gBAAgB;AAAA,EACpB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,eAA0C;AAAA,EACrD,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,QAAQ,gBAAgB,OAAO,cAAc;AAAA,EACzD,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAiD;AAChF,UAAM,cAA4B,CAAC;AACnC,UAAM,SAAS,IAAI,KAAK,QAAQ,QAAQ,SAAS,QAAQ,SAAS,gBAAgB,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AACnH,UAAM,QAAQ,IAAI,KAAK,QAAQ,OAAO,SAAS,QAAQ,QAAQ,eAAe,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AAC/G,UAAM,MAAM,UAAU,IAAI;AAC1B,UAAM,UAAU,IAAI,MAAM,uBAAuB;AAEjD,eAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,YAAM,QAAQ,WAAW,KAAK,KAAK,EAAE,MAAM,KAAK;AAChD,YAAM,QAAQ,MAAM,CAAC,GAAG,YAAY;AACpC,YAAM,OAAO,MAAM,MAAM,SAAS,CAAC,GAAG,YAAY;AAClD,UAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,IAAI,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,EAAG;AAE/D,YAAM,QAAQ,mBAAmB,WAAW,UAAU;AACtD,UAAI,CAAC,MAAO;AAEZ,kBAAY,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,UAAU;AAAA,QACV,SAAS,YAAY,WAAW,KAAK,YAAY,CAAC;AAAA,QAClD;AAAA,QACA,MAAM,aAAa;AAAA,MACrB,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AACF;;;ACrCO,IAAM,eAAkC,oBAAI,IAAI;AAAA,EACrD,CAAC,mBAAmB,aAAqB;AAAA,EACzC,CAAC,0BAA0B,oBAA4B;AAAA,EACvD,CAAC,oBAAoB,cAAsB;AAAA,EAC3C,CAAC,yBAAyB,mBAA2B;AAAA,EACrD,CAAC,kBAAkB,YAAoB;AACzC,CAAC;","names":[]}
+{"version":3,"sources":["../src/utils.ts","../src/no-expletive-openers.ts","../src/no-filter-words.ts","../src/no-empty-transformation-claims.ts","../src/no-nominalized-phrases.ts","../src/no-passive-voice.ts","../src/no-stacked-adjectives.ts","../src/no-weak-modals.ts","../src/index.ts"],"sourcesContent":["import nlp from 'compromise'\nimport type { Diagnostic } from '@faircopy/core'\nimport type { DocView, JsonOffsetEntry, JsonOffsetTerm, MatchView } from './types.js'\n\nexport interface MatchOccurrence {\n  text: string\n  start: number\n  end: number\n}\n\nexport function createDoc(text: string): DocView {\n  return nlp(text) as unknown as DocView\n}\n\nexport function getMatchOccurrences(text: string, matches: MatchView): MatchOccurrence[] {\n  const json = matches.json({ offset: true, text: true, terms: { offset: true } }) as JsonOffsetEntry[]\n\n  return json.flatMap((entry) => {\n    const start = entry.offset?.start ?? entry.terms?.[0]?.offset?.start\n    const length = entry.offset?.length ?? sumTermLengths(entry.terms)\n\n    if (typeof start !== 'number' || typeof length !== 'number' || length <= 0) {\n      return []\n    }\n\n    return [{\n      text: entry.text ?? text.slice(start, start + length),\n      start,\n      end: start + length,\n    }]\n  })\n}\n\nexport function getOccurrenceRange(sourceMap: number[], occurrence: MatchOccurrence): Diagnostic['range'] | null {\n  const start = sourceMap[occurrence.start]\n  const end = sourceMap[occurrence.end - 1]\n  if (start === undefined || end === undefined) return null\n\n  return { start, end: end + 1 }\n}\n\nfunction sumTermLengths(terms: JsonOffsetTerm[] | undefined): number | undefined {\n  if (!terms?.length) return undefined\n\n  let total = 0\n  for (const term of terms) {\n    const length = term.offset?.length\n    if (typeof length !== 'number') return undefined\n    total += length\n  }\n\n  return total\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences, getOccurrenceRange } from './utils.js'\n\nexport interface NoExpletiveOpenersOptions {\n  phrases?: string[]\n}\n\nconst DEFAULT_PHRASES = [\n  'there is',\n  'there are',\n  'there was',\n  'there were',\n  'there will be',\n]\n\nexport const noExpletiveOpeners: Rule<NoExpletiveOpenersOptions> = {\n  id: 'no-expletive-openers',\n  description: 'Flag sentence openings that delay the real subject',\n  defaults: { phrases: DEFAULT_PHRASES },\n  help: 'Expletive openers like \"there are\" make copy indirect. Start with the actor, product, or benefit so the sentence lands faster.',\n\n  check({ text, sourceMap, options }: RuleInput<NoExpletiveOpenersOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const phrases = options.phrases?.length ? options.phrases : DEFAULT_PHRASES\n    const doc = createDoc(text)\n\n    for (const phrase of phrases) {\n      const matches = doc.match(phrase)\n      for (const occurrence of getMatchOccurrences(text, matches)) {\n        if (!startsSentence(text, occurrence.start)) continue\n\n        const range = getOccurrenceRange(sourceMap, occurrence)\n        if (!range) continue\n\n        diagnostics.push({\n          ruleId: 'no-expletive-openers',\n          severity: 'warn',\n          message: `start with the real subject instead of \"${occurrence.text.toLowerCase()}\"`,\n          range,\n          help: noExpletiveOpeners.help,\n        })\n      }\n    }\n\n    return diagnostics.sort((left, right) => left.range.start - right.range.start)\n  },\n}\n\nfunction startsSentence(text: string, start: number): boolean {\n  let index = start - 1\n  while (index >= 0 && /\\s/.test(text[index]!)) index--\n  return index < 0 || /[.!?]/.test(text[index]!)\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences } from './utils.js'\n\nexport interface NoFilterWordsOptions {\n  phrases?: string[]\n}\n\nconst DEFAULT_PHRASES = [\n  'I think',\n  'it seems',\n  'basically',\n  'in order to',\n]\n\nexport const noFilterWords: Rule<NoFilterWordsOptions> = {\n  id: 'no-filter-words',\n  description: 'Ban filter phrases that distance the claim from the reader',\n  defaults: { phrases: DEFAULT_PHRASES },\n  help: 'Filter phrases announce a perspective or pad the sentence instead of making the point. Delete the phrase or rewrite the sentence so the claim stands on its own.',\n\n  check({ text, sourceMap, options }: RuleInput<NoFilterWordsOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const phrases = options.phrases?.length ? options.phrases : DEFAULT_PHRASES\n    const doc = createDoc(text)\n\n    for (const phrase of phrases) {\n      const matches = doc.match(phrase)\n      for (const occurrence of getMatchOccurrences(text, matches)) {\n        const start = sourceMap[occurrence.start]\n        const end = sourceMap[occurrence.end - 1]\n        if (start === undefined || end === undefined) continue\n\n        diagnostics.push({\n          ruleId: 'no-filter-words',\n          severity: 'error',\n          message: `remove \"${occurrence.text.toLowerCase()}\" — state the claim directly`,\n          range: { start, end: end + 1 },\n          help: noFilterWords.help,\n        })\n      }\n    }\n\n    return diagnostics\n  },\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\n\nexport interface NoEmptyTransformationClaimsOptions {\n  allowedPhrases?: string[]\n}\n\ninterface Pattern {\n  re: RegExp\n  message: string\n}\n\nconst PATTERNS: Pattern[] = [\n  {\n    re: /\\b(?:transform(?:s|ed|ing)?|chang(?:e|es|ed|ing)|reimagin(?:e|es|ed|ing)|revolutioniz(?:e|es|ed|ing))\\s+the\\s+way\\s+(?:you|your\\s+team|teams|companies|businesses|people)\\s+(?:work|build|sell|operate|collaborate|communicate|create|grow|ship|scale|learn|manage)\\b/gi,\n    message: 'replace empty transformation claim with a concrete outcome',\n  },\n  {\n    re: /\\bunlock\\s+(?:your|their|team|teams'|your\\s+team's|the\\s+team's|the\\s+full)\\s+(?:potential|productivity|growth|creativity|efficiency)\\b/gi,\n    message: 'replace empty unlock claim with the specific benefit',\n  },\n  {\n    re: /\\btake\\s+(?:your|their|team|teams'|your\\s+team's|the\\s+team's)?\\s*(?:productivity|workflow|workflows|growth|collaboration|business|operations|process|processes)\\s+to\\s+the\\s+next\\s+level\\b/gi,\n    message: 'replace next-level claim with measurable value',\n  },\n]\n\nexport const noEmptyTransformationClaims: Rule<NoEmptyTransformationClaimsOptions> = {\n  id: 'no-empty-transformation-claims',\n  description: 'Flag broad transformation claims that do not name a concrete outcome',\n  defaults: { allowedPhrases: [] },\n  help: 'Transformation cliches promise a feeling instead of a result. Replace them with the specific workflow, metric, or customer outcome the product changes.',\n\n  check({ text, sourceMap, options }: RuleInput<NoEmptyTransformationClaimsOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const allowedPhrases = new Set((options.allowedPhrases ?? []).map(value => normalize(value)))\n\n    for (const pattern of PATTERNS) {\n      const re = new RegExp(pattern.re.source, pattern.re.flags)\n      let match: RegExpExecArray | null\n      while ((match = re.exec(text)) !== null) {\n        const phrase = match[0]\n        if (allowedPhrases.has(normalize(phrase))) continue\n\n        const start = sourceMap[match.index]\n        const end = sourceMap[match.index + phrase.length - 1]\n        if (start === undefined || end === undefined) continue\n\n        diagnostics.push({\n          ruleId: 'no-empty-transformation-claims',\n          severity: 'warn',\n          message: `${pattern.message}: \"${phrase}\"`,\n          range: { start, end: end + 1 },\n          help: noEmptyTransformationClaims.help,\n        })\n      }\n    }\n\n    return diagnostics\n  },\n}\n\nfunction normalize(value: string): string {\n  return value.toLowerCase().replace(/\\s+/g, ' ').trim()\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences, getOccurrenceRange } from './utils.js'\n\nexport interface NoNominalizedPhrasesOptions {\n  suffixes?: string[]\n  allowedWords?: string[]\n}\n\nconst DEFAULT_SUFFIXES = ['tion', 'sion', 'ment', 'ance', 'ence', 'ity']\nconst DEFAULT_ALLOWED_WORDS = [\n  'accessibility',\n  'availability',\n  'capacity',\n  'community',\n  'identity',\n  'opportunity',\n  'privacy',\n  'quality',\n  'reliability',\n  'security',\n]\n\nexport const noNominalizedPhrases: Rule<NoNominalizedPhrasesOptions> = {\n  id: 'no-nominalized-phrases',\n  description: 'Flag nominalized \"X of Y\" phrases that hide the action in a noun',\n  defaults: { suffixes: DEFAULT_SUFFIXES, allowedWords: DEFAULT_ALLOWED_WORDS },\n  help: 'Nominalized phrases bury the action. Rewrite the phrase with a verb so the sentence says who does what.',\n\n  check({ text, sourceMap, options }: RuleInput<NoNominalizedPhrasesOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const suffixes = options.suffixes?.length ? options.suffixes : DEFAULT_SUFFIXES\n    const allowedWords = new Set((options.allowedWords?.length ? options.allowedWords : DEFAULT_ALLOWED_WORDS).map(value => value.toLowerCase()))\n    const suffixPattern = suffixes.map(escapeRegex).join('|')\n    if (!suffixPattern) return diagnostics\n\n    const doc = createDoc(text)\n    const matches = doc.match(`/[a-z]+(${suffixPattern})/ of .`)\n\n    for (const occurrence of getMatchOccurrences(text, matches)) {\n      const nominalization = occurrence.text.trim().split(/\\s+/)[0]?.toLowerCase()\n      if (!nominalization || allowedWords.has(nominalization)) continue\n\n      const range = getOccurrenceRange(sourceMap, occurrence)\n      if (!range) continue\n\n      diagnostics.push({\n        ruleId: 'no-nominalized-phrases',\n        severity: 'warn',\n        message: `rewrite \"${occurrence.text}\" with a verb`,\n        range,\n        help: noNominalizedPhrases.help,\n      })\n    }\n\n    return diagnostics\n  },\n}\n\nfunction escapeRegex(value: string): string {\n  return value.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\$&')\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences } from './utils.js'\n\nexport interface NoPassiveVoiceOptions {\n  allowedAuxiliaries?: string[]\n}\n\nconst DEFAULT_ALLOWED_AUXILIARIES = ['is', 'are', 'was', 'were', 'be', 'been', 'being']\n\nexport const noPassiveVoice: Rule<NoPassiveVoiceOptions> = {\n  id: 'no-passive-voice',\n  description: 'Flag likely passive-voice constructions using POS tagging patterns',\n  defaults: { allowedAuxiliaries: DEFAULT_ALLOWED_AUXILIARIES },\n  help: 'Passive voice often hides the actor and adds drag. Prefer naming who did the action unless the actor genuinely does not matter.',\n\n  check({ text, sourceMap, options }: RuleInput<NoPassiveVoiceOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const auxiliaries = new Set((options.allowedAuxiliaries?.length ? options.allowedAuxiliaries : DEFAULT_ALLOWED_AUXILIARIES).map(value => value.toLowerCase()))\n    const doc = createDoc(text)\n    const matches = doc.match('(#Copula|#Auxiliary) #PastTense')\n\n    for (const occurrence of getMatchOccurrences(text, matches)) {\n      const words = occurrence.text.trim().split(/\\s+/)\n      if (words.length < 2) continue\n      if (!auxiliaries.has(words[0]!.toLowerCase())) continue\n\n      const start = sourceMap[occurrence.start]\n      const end = sourceMap[occurrence.end - 1]\n      if (start === undefined || end === undefined) continue\n\n      diagnostics.push({\n        ruleId: 'no-passive-voice',\n        severity: 'warn',\n        message: `rewrite passive construction \"${occurrence.text}\" with a named actor`,\n        range: { start, end: end + 1 },\n        help: noPassiveVoice.help,\n      })\n    }\n\n    return dedupeDiagnostics(diagnostics)\n  },\n}\n\nfunction dedupeDiagnostics(diagnostics: Diagnostic[]): Diagnostic[] {\n  const seen = new Set<string>()\n  return diagnostics.filter((diagnostic) => {\n    const key = `${diagnostic.range.start}:${diagnostic.range.end}`\n    if (seen.has(key)) return false\n    seen.add(key)\n    return true\n  })\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences, getOccurrenceRange } from './utils.js'\n\nexport interface NoStackedAdjectivesOptions {\n  allowedPhrases?: string[]\n}\n\nexport const noStackedAdjectives: Rule<NoStackedAdjectivesOptions> = {\n  id: 'no-stacked-adjectives',\n  description: 'Flag noun phrases with multiple adjectives before the noun',\n  defaults: { allowedPhrases: [] },\n  help: 'Stacked adjectives make copy feel generic. Keep the one descriptor that earns its place or replace the phrase with concrete evidence.',\n\n  check({ text, sourceMap, options }: RuleInput<NoStackedAdjectivesOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const allowedPhrases = new Set((options.allowedPhrases ?? []).map(value => value.toLowerCase()))\n    const doc = createDoc(text)\n    const matches = doc.match('#Adjective #Adjective+ #Noun')\n\n    for (const occurrence of getMatchOccurrences(text, matches)) {\n      if (allowedPhrases.has(occurrence.text.toLowerCase())) continue\n\n      const range = getOccurrenceRange(sourceMap, occurrence)\n      if (!range) continue\n\n      diagnostics.push({\n        ruleId: 'no-stacked-adjectives',\n        severity: 'warn',\n        message: `cut stacked adjectives in \"${occurrence.text}\"`,\n        range,\n        help: noStackedAdjectives.help,\n      })\n    }\n\n    return diagnostics\n  },\n}\n","import type { Diagnostic, Rule, RuleInput } from '@faircopy/core'\nimport { createDoc, getMatchOccurrences, getOccurrenceRange } from './utils.js'\n\nexport interface NoWeakModalsOptions {\n  modals?: string[]\n  verbs?: string[]\n}\n\nconst DEFAULT_MODALS = ['can', 'could', 'may', 'might']\nconst DEFAULT_VERBS = [\n  'boost',\n  'drive',\n  'enable',\n  'help',\n  'improve',\n  'increase',\n  'make',\n  'reduce',\n  'support',\n  'transform',\n  'unlock',\n]\n\nexport const noWeakModals: Rule<NoWeakModalsOptions> = {\n  id: 'no-weak-modals',\n  description: 'Flag hedged modal claims like \"can help\" and \"might improve\"',\n  defaults: { modals: DEFAULT_MODALS, verbs: DEFAULT_VERBS },\n  help: 'Hedged modal claims sound tentative. Replace them with the outcome, capability, or proof you can stand behind.',\n\n  check({ text, sourceMap, options }: RuleInput<NoWeakModalsOptions>): Diagnostic[] {\n    const diagnostics: Diagnostic[] = []\n    const modals = new Set((options.modals?.length ? options.modals : DEFAULT_MODALS).map(value => value.toLowerCase()))\n    const verbs = new Set((options.verbs?.length ? options.verbs : DEFAULT_VERBS).map(value => value.toLowerCase()))\n    const doc = createDoc(text)\n    const matches = doc.match('#Modal #Adverb? #Verb')\n\n    for (const occurrence of getMatchOccurrences(text, matches)) {\n      const words = occurrence.text.trim().split(/\\s+/)\n      const modal = words[0]?.toLowerCase()\n      const verb = words[words.length - 1]?.toLowerCase()\n      if (!modal || !verb || !modals.has(modal) || !verbs.has(verb)) continue\n\n      const range = getOccurrenceRange(sourceMap, occurrence)\n      if (!range) continue\n\n      diagnostics.push({\n        ruleId: 'no-weak-modals',\n        severity: 'warn',\n        message: `replace \"${occurrence.text.toLowerCase()}\" with a direct claim`,\n        range,\n        help: noWeakModals.help,\n      })\n    }\n\n    return diagnostics\n  },\n}\n","import type { Rule } from '@faircopy/core'\nimport { noExpletiveOpeners } from './no-expletive-openers.js'\nimport { noFilterWords } from './no-filter-words.js'\nimport { noEmptyTransformationClaims } from './no-empty-transformation-claims.js'\nimport { noNominalizedPhrases } from './no-nominalized-phrases.js'\nimport { noPassiveVoice } from './no-passive-voice.js'\nimport { noStackedAdjectives } from './no-stacked-adjectives.js'\nimport { noWeakModals } from './no-weak-modals.js'\n\nexport { noExpletiveOpeners } from './no-expletive-openers.js'\nexport { noFilterWords } from './no-filter-words.js'\nexport { noEmptyTransformationClaims } from './no-empty-transformation-claims.js'\nexport { noNominalizedPhrases } from './no-nominalized-phrases.js'\nexport { noPassiveVoice } from './no-passive-voice.js'\nexport { noStackedAdjectives } from './no-stacked-adjectives.js'\nexport { noWeakModals } from './no-weak-modals.js'\nexport type { NoExpletiveOpenersOptions } from './no-expletive-openers.js'\nexport type { NoFilterWordsOptions } from './no-filter-words.js'\nexport type { NoEmptyTransformationClaimsOptions } from './no-empty-transformation-claims.js'\nexport type { NoNominalizedPhrasesOptions } from './no-nominalized-phrases.js'\nexport type { NoPassiveVoiceOptions } from './no-passive-voice.js'\nexport type { NoStackedAdjectivesOptions } from './no-stacked-adjectives.js'\nexport type { NoWeakModalsOptions } from './no-weak-modals.js'\n\n/** All NLP rules keyed by their rule ID. */\nexport const ruleRegistry: Map<string, Rule> = new Map([\n  ['no-empty-transformation-claims', noEmptyTransformationClaims as Rule],\n  ['no-expletive-openers', noExpletiveOpeners as Rule],\n  ['no-filter-words', noFilterWords as Rule],\n  ['no-nominalized-phrases', noNominalizedPhrases as Rule],\n  ['no-passive-voice', noPassiveVoice as Rule],\n  ['no-stacked-adjectives', noStackedAdjectives as Rule],\n  ['no-weak-modals', noWeakModals as Rule],\n])\n"],"mappings":";AAAA,OAAO,SAAS;AAUT,SAAS,UAAU,MAAuB;AAC/C,SAAO,IAAI,IAAI;AACjB;AAEO,SAAS,oBAAoB,MAAc,SAAuC;AACvF,QAAM,OAAO,QAAQ,KAAK,EAAE,QAAQ,MAAM,MAAM,MAAM,OAAO,EAAE,QAAQ,KAAK,EAAE,CAAC;AAE/E,SAAO,KAAK,QAAQ,CAAC,UAAU;AAC7B,UAAM,QAAQ,MAAM,QAAQ,SAAS,MAAM,QAAQ,CAAC,GAAG,QAAQ;AAC/D,UAAM,SAAS,MAAM,QAAQ,UAAU,eAAe,MAAM,KAAK;AAEjE,QAAI,OAAO,UAAU,YAAY,OAAO,WAAW,YAAY,UAAU,GAAG;AAC1E,aAAO,CAAC;AAAA,IACV;AAEA,WAAO,CAAC;AAAA,MACN,MAAM,MAAM,QAAQ,KAAK,MAAM,OAAO,QAAQ,MAAM;AAAA,MACpD;AAAA,MACA,KAAK,QAAQ;AAAA,IACf,CAAC;AAAA,EACH,CAAC;AACH;AAEO,SAAS,mBAAmB,WAAqB,YAAyD;AAC/G,QAAM,QAAQ,UAAU,WAAW,KAAK;AACxC,QAAM,MAAM,UAAU,WAAW,MAAM,CAAC;AACxC,MAAI,UAAU,UAAa,QAAQ,OAAW,QAAO;AAErD,SAAO,EAAE,OAAO,KAAK,MAAM,EAAE;AAC/B;AAEA,SAAS,eAAe,OAAyD;AAC/E,MAAI,CAAC,OAAO,OAAQ,QAAO;AAE3B,MAAI,QAAQ;AACZ,aAAW,QAAQ,OAAO;AACxB,UAAM,SAAS,KAAK,QAAQ;AAC5B,QAAI,OAAO,WAAW,SAAU,QAAO;AACvC,aAAS;AAAA,EACX;AAEA,SAAO;AACT;;;AC7CA,IAAM,kBAAkB;AAAA,EACtB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,qBAAsD;AAAA,EACjE,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,SAAS,gBAAgB;AAAA,EACrC,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAuD;AACtF,UAAM,cAA4B,CAAC;AACnC,UAAM,UAAU,QAAQ,SAAS,SAAS,QAAQ,UAAU;AAC5D,UAAM,MAAM,UAAU,IAAI;AAE1B,eAAW,UAAU,SAAS;AAC5B,YAAM,UAAU,IAAI,MAAM,MAAM;AAChC,iBAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,YAAI,CAAC,eAAe,MAAM,WAAW,KAAK,EAAG;AAE7C,cAAM,QAAQ,mBAAmB,WAAW,UAAU;AACtD,YAAI,CAAC,MAAO;AAEZ,oBAAY,KAAK;AAAA,UACf,QAAQ;AAAA,UACR,UAAU;AAAA,UACV,SAAS,2CAA2C,WAAW,KAAK,YAAY,CAAC;AAAA,UACjF;AAAA,UACA,MAAM,mBAAmB;AAAA,QAC3B,CAAC;AAAA,MACH;AAAA,IACF;AAEA,WAAO,YAAY,KAAK,CAAC,MAAM,UAAU,KAAK,MAAM,QAAQ,MAAM,MAAM,KAAK;AAAA,EAC/E;AACF;AAEA,SAAS,eAAe,MAAc,OAAwB;AAC5D,MAAI,QAAQ,QAAQ;AACpB,SAAO,SAAS,KAAK,KAAK,KAAK,KAAK,KAAK,CAAE,EAAG;AAC9C,SAAO,QAAQ,KAAK,QAAQ,KAAK,KAAK,KAAK,CAAE;AAC/C;;;AC7CA,IAAMA,mBAAkB;AAAA,EACtB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,gBAA4C;AAAA,EACvD,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,SAASA,iBAAgB;AAAA,EACrC,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAkD;AACjF,UAAM,cAA4B,CAAC;AACnC,UAAM,UAAU,QAAQ,SAAS,SAAS,QAAQ,UAAUA;AAC5D,UAAM,MAAM,UAAU,IAAI;AAE1B,eAAW,UAAU,SAAS;AAC5B,YAAM,UAAU,IAAI,MAAM,MAAM;AAChC,iBAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,cAAM,QAAQ,UAAU,WAAW,KAAK;AACxC,cAAM,MAAM,UAAU,WAAW,MAAM,CAAC;AACxC,YAAI,UAAU,UAAa,QAAQ,OAAW;AAE9C,oBAAY,KAAK;AAAA,UACf,QAAQ;AAAA,UACR,UAAU;AAAA,UACV,SAAS,WAAW,WAAW,KAAK,YAAY,CAAC;AAAA,UACjD,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE;AAAA,UAC7B,MAAM,cAAc;AAAA,QACtB,CAAC;AAAA,MACH;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AACF;;;ACjCA,IAAM,WAAsB;AAAA,EAC1B;AAAA,IACE,IAAI;AAAA,IACJ,SAAS;AAAA,EACX;AAAA,EACA;AAAA,IACE,IAAI;AAAA,IACJ,SAAS;AAAA,EACX;AAAA,EACA;AAAA,IACE,IAAI;AAAA,IACJ,SAAS;AAAA,EACX;AACF;AAEO,IAAM,8BAAwE;AAAA,EACnF,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,gBAAgB,CAAC,EAAE;AAAA,EAC/B,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAgE;AAC/F,UAAM,cAA4B,CAAC;AACnC,UAAM,iBAAiB,IAAI,KAAK,QAAQ,kBAAkB,CAAC,GAAG,IAAI,WAAS,UAAU,KAAK,CAAC,CAAC;AAE5F,eAAW,WAAW,UAAU;AAC9B,YAAM,KAAK,IAAI,OAAO,QAAQ,GAAG,QAAQ,QAAQ,GAAG,KAAK;AACzD,UAAI;AACJ,cAAQ,QAAQ,GAAG,KAAK,IAAI,OAAO,MAAM;AACvC,cAAM,SAAS,MAAM,CAAC;AACtB,YAAI,eAAe,IAAI,UAAU,MAAM,CAAC,EAAG;AAE3C,cAAM,QAAQ,UAAU,MAAM,KAAK;AACnC,cAAM,MAAM,UAAU,MAAM,QAAQ,OAAO,SAAS,CAAC;AACrD,YAAI,UAAU,UAAa,QAAQ,OAAW;AAE9C,oBAAY,KAAK;AAAA,UACf,QAAQ;AAAA,UACR,UAAU;AAAA,UACV,SAAS,GAAG,QAAQ,OAAO,MAAM,MAAM;AAAA,UACvC,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE;AAAA,UAC7B,MAAM,4BAA4B;AAAA,QACpC,CAAC;AAAA,MACH;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AACF;AAEA,SAAS,UAAU,OAAuB;AACxC,SAAO,MAAM,YAAY,EAAE,QAAQ,QAAQ,GAAG,EAAE,KAAK;AACvD;;;ACvDA,IAAM,mBAAmB,CAAC,QAAQ,QAAQ,QAAQ,QAAQ,QAAQ,KAAK;AACvE,IAAM,wBAAwB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,uBAA0D;AAAA,EACrE,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,UAAU,kBAAkB,cAAc,sBAAsB;AAAA,EAC5E,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAyD;AACxF,UAAM,cAA4B,CAAC;AACnC,UAAM,WAAW,QAAQ,UAAU,SAAS,QAAQ,WAAW;AAC/D,UAAM,eAAe,IAAI,KAAK,QAAQ,cAAc,SAAS,QAAQ,eAAe,uBAAuB,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AAC5I,UAAM,gBAAgB,SAAS,IAAI,WAAW,EAAE,KAAK,GAAG;AACxD,QAAI,CAAC,cAAe,QAAO;AAE3B,UAAM,MAAM,UAAU,IAAI;AAC1B,UAAM,UAAU,IAAI,MAAM,WAAW,aAAa,SAAS;AAE3D,eAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,YAAM,iBAAiB,WAAW,KAAK,KAAK,EAAE,MAAM,KAAK,EAAE,CAAC,GAAG,YAAY;AAC3E,UAAI,CAAC,kBAAkB,aAAa,IAAI,cAAc,EAAG;AAEzD,YAAM,QAAQ,mBAAmB,WAAW,UAAU;AACtD,UAAI,CAAC,MAAO;AAEZ,kBAAY,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,UAAU;AAAA,QACV,SAAS,YAAY,WAAW,IAAI;AAAA,QACpC;AAAA,QACA,MAAM,qBAAqB;AAAA,MAC7B,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AACF;AAEA,SAAS,YAAY,OAAuB;AAC1C,SAAO,MAAM,QAAQ,uBAAuB,MAAM;AACpD;;;ACrDA,IAAM,8BAA8B,CAAC,MAAM,OAAO,OAAO,QAAQ,MAAM,QAAQ,OAAO;AAE/E,IAAM,iBAA8C;AAAA,EACzD,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,oBAAoB,4BAA4B;AAAA,EAC5D,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAmD;AAClF,UAAM,cAA4B,CAAC;AACnC,UAAM,cAAc,IAAI,KAAK,QAAQ,oBAAoB,SAAS,QAAQ,qBAAqB,6BAA6B,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AAC7J,UAAM,MAAM,UAAU,IAAI;AAC1B,UAAM,UAAU,IAAI,MAAM,iCAAiC;AAE3D,eAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,YAAM,QAAQ,WAAW,KAAK,KAAK,EAAE,MAAM,KAAK;AAChD,UAAI,MAAM,SAAS,EAAG;AACtB,UAAI,CAAC,YAAY,IAAI,MAAM,CAAC,EAAG,YAAY,CAAC,EAAG;AAE/C,YAAM,QAAQ,UAAU,WAAW,KAAK;AACxC,YAAM,MAAM,UAAU,WAAW,MAAM,CAAC;AACxC,UAAI,UAAU,UAAa,QAAQ,OAAW;AAE9C,kBAAY,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,UAAU;AAAA,QACV,SAAS,iCAAiC,WAAW,IAAI;AAAA,QACzD,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE;AAAA,QAC7B,MAAM,eAAe;AAAA,MACvB,CAAC;AAAA,IACH;AAEA,WAAO,kBAAkB,WAAW;AAAA,EACtC;AACF;AAEA,SAAS,kBAAkB,aAAyC;AAClE,QAAM,OAAO,oBAAI,IAAY;AAC7B,SAAO,YAAY,OAAO,CAAC,eAAe;AACxC,UAAM,MAAM,GAAG,WAAW,MAAM,KAAK,IAAI,WAAW,MAAM,GAAG;AAC7D,QAAI,KAAK,IAAI,GAAG,EAAG,QAAO;AAC1B,SAAK,IAAI,GAAG;AACZ,WAAO;AAAA,EACT,CAAC;AACH;;;AC5CO,IAAM,sBAAwD;AAAA,EACnE,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,gBAAgB,CAAC,EAAE;AAAA,EAC/B,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAwD;AACvF,UAAM,cAA4B,CAAC;AACnC,UAAM,iBAAiB,IAAI,KAAK,QAAQ,kBAAkB,CAAC,GAAG,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AAC/F,UAAM,MAAM,UAAU,IAAI;AAC1B,UAAM,UAAU,IAAI,MAAM,8BAA8B;AAExD,eAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,UAAI,eAAe,IAAI,WAAW,KAAK,YAAY,CAAC,EAAG;AAEvD,YAAM,QAAQ,mBAAmB,WAAW,UAAU;AACtD,UAAI,CAAC,MAAO;AAEZ,kBAAY,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,UAAU;AAAA,QACV,SAAS,8BAA8B,WAAW,IAAI;AAAA,QACtD;AAAA,QACA,MAAM,oBAAoB;AAAA,MAC5B,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AACF;;;AC5BA,IAAM,iBAAiB,CAAC,OAAO,SAAS,OAAO,OAAO;AACtD,IAAM,gBAAgB;AAAA,EACpB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,eAA0C;AAAA,EACrD,IAAI;AAAA,EACJ,aAAa;AAAA,EACb,UAAU,EAAE,QAAQ,gBAAgB,OAAO,cAAc;AAAA,EACzD,MAAM;AAAA,EAEN,MAAM,EAAE,MAAM,WAAW,QAAQ,GAAiD;AAChF,UAAM,cAA4B,CAAC;AACnC,UAAM,SAAS,IAAI,KAAK,QAAQ,QAAQ,SAAS,QAAQ,SAAS,gBAAgB,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AACnH,UAAM,QAAQ,IAAI,KAAK,QAAQ,OAAO,SAAS,QAAQ,QAAQ,eAAe,IAAI,WAAS,MAAM,YAAY,CAAC,CAAC;AAC/G,UAAM,MAAM,UAAU,IAAI;AAC1B,UAAM,UAAU,IAAI,MAAM,uBAAuB;AAEjD,eAAW,cAAc,oBAAoB,MAAM,OAAO,GAAG;AAC3D,YAAM,QAAQ,WAAW,KAAK,KAAK,EAAE,MAAM,KAAK;AAChD,YAAM,QAAQ,MAAM,CAAC,GAAG,YAAY;AACpC,YAAM,OAAO,MAAM,MAAM,SAAS,CAAC,GAAG,YAAY;AAClD,UAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,IAAI,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,EAAG;AAE/D,YAAM,QAAQ,mBAAmB,WAAW,UAAU;AACtD,UAAI,CAAC,MAAO;AAEZ,kBAAY,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,UAAU;AAAA,QACV,SAAS,YAAY,WAAW,KAAK,YAAY,CAAC;AAAA,QAClD;AAAA,QACA,MAAM,aAAa;AAAA,MACrB,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AACF;;;AC/BO,IAAM,eAAkC,oBAAI,IAAI;AAAA,EACrD,CAAC,kCAAkC,2BAAmC;AAAA,EACtE,CAAC,wBAAwB,kBAA0B;AAAA,EACnD,CAAC,mBAAmB,aAAqB;AAAA,EACzC,CAAC,0BAA0B,oBAA4B;AAAA,EACvD,CAAC,oBAAoB,cAAsB;AAAA,EAC3C,CAAC,yBAAyB,mBAA2B;AAAA,EACrD,CAAC,kBAAkB,YAAoB;AACzC,CAAC;","names":["DEFAULT_PHRASES"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faircopy/rules-nlp",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Optional NLP-powered ruleset for faircopy using compromise",
   "type": "module",
   "exports": {
@@ -19,7 +19,7 @@
     "prepublishOnly": "pnpm run build"
   },
   "dependencies": {
-    "@faircopy/core": "1.4.0",
+    "@faircopy/core": "1.6.0",
     "compromise": "^14.15.0"
   },
   "devDependencies": {