opengrammar-server 2.0.615350

package/src/rules/ruleset-part2-cw-st-nf.json

@@ -0,0 +1,318 @@
+{
+  "version": "1.0.0",
+  "generated_for": "OpenGrammar Engine",
+  "part": "2A_of_3",
+  "categories": [
+    {
+      "code": "CW",
+      "name": "Commonly Confused Words",
+      "rules": [
+        {
+          "rule_id": "CW_001",
+          "subcategory": "Homophones",
+          "title": "affect vs effect",
+          "pattern_description": "affect (verb: to influence) vs effect (noun: result; verb: to bring about)",
+          "examples": {
+            "incorrect": ["The weather will effect my mood.", "The new law had a great affect."],
+            "correct": ["The weather will affect my mood.", "The new law had a great effect."]
+          },
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_002",
+          "subcategory": "Homophones",
+          "title": "accept vs except",
+          "pattern_description": "accept (verb: receive) vs except (prep: excluding)",
+          "examples": {
+            "incorrect": ["I will except your offer.", "Everyone accept John came."],
+            "correct": ["I will accept your offer.", "Everyone except John came."]
+          },
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_003",
+          "subcategory": "Homophones",
+          "title": "complement vs compliment",
+          "pattern_description": "complement (complete/enhance) vs compliment (praise)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_004",
+          "subcategory": "Homophones",
+          "title": "principal vs principle",
+          "pattern_description": "principal (main/head) vs principle (rule/belief)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_005",
+          "subcategory": "Homophones",
+          "title": "stationary vs stationery",
+          "pattern_description": "stationary (not moving) vs stationery (writing materials)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_006",
+          "subcategory": "Homophones",
+          "title": "loose vs lose",
+          "pattern_description": "loose (adjective: not tight) vs lose (verb: to misplace/fail)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_007",
+          "subcategory": "Homophones",
+          "title": "advise vs advice",
+          "pattern_description": "advise (verb) vs advice (noun)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_008",
+          "subcategory": "Homophones",
+          "title": "practise vs practice",
+          "pattern_description": "BrE: practise (verb) / practice (noun). AmE: practice for both.",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_009",
+          "subcategory": "Near-Homophones",
+          "title": "ensure vs insure vs assure",
+          "pattern_description": "ensure (make certain), insure (financial protection), assure (remove doubt from a person)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_010",
+          "subcategory": "Near-Homophones",
+          "title": "farther vs further",
+          "pattern_description": "farther (physical distance), further (degree/metaphorical)",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "CW_011",
+          "subcategory": "Semantic",
+          "title": "imply vs infer",
+          "pattern_description": "imply (speaker suggests), infer (listener deduces)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_012",
+          "subcategory": "Semantic",
+          "title": "emigrate vs immigrate",
+          "pattern_description": "emigrate (leave a country), immigrate (enter a country)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_013",
+          "subcategory": "Semantic",
+          "title": "continual vs continuous",
+          "pattern_description": "continual (repeated with breaks), continuous (uninterrupted)",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "CW_014",
+          "subcategory": "Semantic",
+          "title": "disinterested vs uninterested",
+          "pattern_description": "disinterested (impartial), uninterested (bored/not interested)",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "CW_015",
+          "subcategory": "Semantic",
+          "title": "elicit vs illicit",
+          "pattern_description": "elicit (draw out), illicit (illegal)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_016",
+          "subcategory": "Semantic",
+          "title": "precede vs proceed",
+          "pattern_description": "precede (come before), proceed (move forward)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_017",
+          "subcategory": "Semantic",
+          "title": "adverse vs averse",
+          "pattern_description": "adverse (harmful/unfavorable), averse (reluctant/opposed)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_018",
+          "subcategory": "Semantic",
+          "title": "allusion vs illusion",
+          "pattern_description": "allusion (indirect reference), illusion (false perception)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_019",
+          "subcategory": "Semantic",
+          "title": "cite vs site vs sight",
+          "pattern_description": "cite (quote/reference), site (location), sight (vision/view)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_020",
+          "subcategory": "Semantic",
+          "title": "conscious vs conscience",
+          "pattern_description": "conscious (aware), conscience (moral sense)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_021",
+          "subcategory": "Semantic",
+          "title": "dessert vs desert",
+          "pattern_description": "dessert (sweet food), desert (arid land / abandon)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_022",
+          "subcategory": "Semantic",
+          "title": "whose vs who's",
+          "pattern_description": "whose (possessive), who's (who is/who has)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_023",
+          "subcategory": "Semantic",
+          "title": "weather vs whether",
+          "pattern_description": "weather (climate), whether (if)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_024",
+          "subcategory": "Semantic",
+          "title": "than vs then",
+          "pattern_description": "than (comparison), then (time/sequence)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_025",
+          "subcategory": "Semantic",
+          "title": "lie vs lay",
+          "pattern_description": "lie (recline, intransitive: lie/lay/lain), lay (put down, transitive: lay/laid/laid)",
+          "severity": "error"
+        },
+        {
+          "rule_id": "CW_026",
+          "subcategory": "Semantic",
+          "title": "hanged vs hung",
+          "pattern_description": "hanged (execution), hung (suspended an object)",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "CW_027",
+          "subcategory": "Semantic",
+          "title": "historic vs historical",
+          "pattern_description": "historic (important/famous), historical (relating to history)",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "CW_028",
+          "subcategory": "Semantic",
+          "title": "literal vs figurative",
+          "pattern_description": "Detect misuse of 'literally' for emphasis when meaning is figurative",
+          "severity": "suggestion"
+        }
+      ]
+    },
+    {
+      "code": "ST",
+      "name": "Style & Tone",
+      "rules": [
+        {
+          "rule_id": "ST_001",
+          "subcategory": "Wordiness",
+          "title": "Redundant pairs",
+          "pattern_description": "each and every, first and foremost, null and void, true and accurate, any and all, various and sundry, aid and abet, cease and desist, full and complete",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "ST_002",
+          "subcategory": "Wordiness",
+          "title": "Inflated phrases",
+          "pattern_description": "at this point in time → now, in the final analysis → finally, it goes without saying → (delete), needless to say → (delete), it is worth noting that → (delete), as a matter of fact → in fact, for all intents and purposes → (simplify)",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "ST_003",
+          "subcategory": "Hedging",
+          "title": "Excessive hedging language",
+          "pattern_description": "Detect overuse: sort of, kind of, somewhat, rather, fairly, quite, perhaps, maybe, possibly, seemingly, appears to, tends to, in some cases, to some extent, it could be argued",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "ST_004",
+          "subcategory": "Filler",
+          "title": "Filler words and phrases",
+          "pattern_description": "basically, actually, honestly, literally, essentially, definitely, absolutely, totally, completely, really, very, just, quite, rather, somewhat, pretty (as intensifier)",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "ST_005",
+          "subcategory": "Nominalizations",
+          "title": "Nominalization (hidden verb)",
+          "pattern_description": "make a decision → decide, give consideration to → consider, make an improvement → improve, provide assistance → assist, conduct an investigation → investigate, perform an analysis → analyze, take into consideration → consider, have a discussion → discuss, make a recommendation → recommend, give an indication → indicate, provide an explanation → explain, make a determination → determine",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "ST_006",
+          "subcategory": "Clichés",
+          "title": "Overused clichés",
+          "pattern_description": "at the end of the day, think outside the box, low-hanging fruit, move the needle, synergy, paradigm shift, take it to the next level, game changer, deep dive, circle back, touch base, on the same page, push the envelope, best practices, going forward, leverage (as verb), bandwidth (non-technical), drill down, scalable, actionable, value-add, stakeholders, streamline, optimize",
+          "severity": "suggestion"
+        }
+      ]
+    },
+    {
+      "code": "NF",
+      "name": "Numbers & Formatting",
+      "rules": [
+        {
+          "rule_id": "NF_001",
+          "subcategory": "Number Spelling",
+          "title": "Spell out numbers under 10",
+          "pattern_description": "In formal prose, spell out single-digit numbers (1→one, 2→two ... 9→nine)",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "NF_002",
+          "subcategory": "Number Spelling",
+          "title": "Spell out numbers at sentence start",
+          "pattern_description": "Never start a sentence with a numeral: '100 people came' → 'One hundred people came' or restructure",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "NF_003",
+          "subcategory": "Number Consistency",
+          "title": "Mixed numeral and word forms",
+          "pattern_description": "Don't mix: 'We need 3 chairs and twelve tables' → be consistent",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "NF_004",
+          "subcategory": "Units",
+          "title": "Missing space before unit",
+          "pattern_description": "10kg → 10 kg, 5cm → 5 cm (but 5% is acceptable without space)",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "NF_005",
+          "subcategory": "Date Format",
+          "title": "Ambiguous date formats",
+          "pattern_description": "Warn on MM/DD/YYYY vs DD/MM/YYYY ambiguity when day ≤ 12",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "NF_006",
+          "subcategory": "Abbreviations",
+          "title": "Inconsistent abbreviation use",
+          "pattern_description": "First use should spell out: 'Use Artificial Intelligence (AI) first, then AI thereafter'",
+          "severity": "suggestion"
+        }
+      ]
+    }
+  ],
+  "implementation_notes": {
+    "CW": "Confused word detection benefits from POS tagging. affect/effect requires knowing if verb or noun is expected. Many can be regex with contextual hints.",
+    "ST": "Style rules should be severity:suggestion and respect language_register. Nominalization detection benefits from NLP verb-noun mapping.",
+    "NF": "Number rules need sentence-boundary awareness. Unit detection is regex-friendly."
+  }
+}

package/src/rules/ruleset-part3-aw-bw-il-rd.json

@@ -0,0 +1,161 @@
+{
+  "version": "1.0.0",
+  "generated_for": "OpenGrammar Engine",
+  "part": "3_of_3",
+  "categories": [
+    {
+      "code": "AW",
+      "name": "Academic Writing",
+      "description": "Rules specific to scholarly, research, and academic prose.",
+      "rules": [
+        {
+          "rule_id": "AW_001",
+          "title": "First person in academic writing",
+          "pattern_description": "Flag 'I think', 'I believe', 'I feel', 'In my opinion' in academic register",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "AW_002",
+          "title": "Contractions in academic writing",
+          "pattern_description": "Flag don't, can't, won't, it's, they're etc. in formal academic text",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "AW_003",
+          "title": "Vague quantifiers",
+          "pattern_description": "Flag 'a lot of', 'lots of', 'tons of', 'a bunch of' — prefer precise data",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "AW_004",
+          "title": "Weasel words",
+          "pattern_description": "some people say, it is believed, studies show, experts say, research suggests — cite specifically",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "AW_005",
+          "title": "Rhetorical questions in papers",
+          "pattern_description": "Questions in academic papers should generally be avoided",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "AW_006",
+          "title": "Informal transitions",
+          "pattern_description": "Plus, Also at sentence start, So, Anyway, Well — use Moreover, Furthermore, Additionally",
+          "severity": "suggestion"
+        }
+      ]
+    },
+    {
+      "code": "BW",
+      "name": "Business Writing",
+      "description": "Rules for professional emails, reports, memos.",
+      "rules": [
+        {
+          "rule_id": "BW_001",
+          "title": "Passive in instructions",
+          "pattern_description": "In instructions, prefer active: 'Submit the report' not 'The report should be submitted'",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "BW_002",
+          "title": "Empty openers",
+          "pattern_description": "I am writing to inform you, This email is to let you know, I wanted to reach out — get to the point",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "BW_003",
+          "title": "Weak verbs",
+          "pattern_description": "utilize→use, implement→do/start, facilitate→help, commence→begin/start, terminate→end, endeavor→try",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "BW_004",
+          "title": "Double negatives for politeness",
+          "pattern_description": "'not uncommon'→'common', 'not unlike'→'similar to', 'not insignificant'→'significant'",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "BW_005",
+          "title": "Overly complex words",
+          "pattern_description": "ameliorate→improve, ascertain→find out, cognizant→aware, elucidate→explain, expedite→speed up, juxtapose→compare, paradigm→model, remuneration→pay, ubiquitous→widespread, veracious→truthful",
+          "severity": "suggestion"
+        }
+      ]
+    },
+    {
+      "code": "IL",
+      "name": "Inclusive Language",
+      "description": "Gender-neutral, disability-aware, culturally sensitive language.",
+      "rules": [
+        {
+          "rule_id": "IL_001",
+          "title": "Gendered job titles",
+          "pattern_description": "chairman→chairperson/chair, fireman→firefighter, policeman→police officer, stewardess→flight attendant, mailman→mail carrier, mankind→humankind, manpower→workforce, man-made→artificial/synthetic",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "IL_002",
+          "title": "Generic 'he'",
+          "pattern_description": "'When a student submits his work' → 'their work' or 'his or her work'",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "IL_003",
+          "title": "Person-first language",
+          "pattern_description": "'disabled person'→'person with a disability', 'autistic child'→'child with autism', 'blind person'→'person who is blind'",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "IL_004",
+          "title": "Ableist language",
+          "pattern_description": "'falling on deaf ears', 'blind spot' (metaphorical), 'lame excuse', 'crippled by', 'suffers from', 'confined to a wheelchair'→'uses a wheelchair'",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "IL_005",
+          "title": "Age-related language",
+          "pattern_description": "'elderly'→'older adults', 'senior citizens'→'older adults'",
+          "severity": "suggestion"
+        }
+      ]
+    },
+    {
+      "code": "RD",
+      "name": "Readability",
+      "description": "Sentence complexity, reading level, clarity metrics.",
+      "rules": [
+        {
+          "rule_id": "RD_001",
+          "title": "Very long sentences",
+          "pattern_description": "Flag sentences over 40 words — suggest breaking up",
+          "severity": "warning"
+        },
+        {
+          "rule_id": "RD_002",
+          "title": "Long paragraphs",
+          "pattern_description": "Flag paragraphs over 150 words",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "RD_003",
+          "title": "Complex word alternatives",
+          "pattern_description": "Suggest simpler synonyms: utilize→use, demonstrate→show, approximately→about, subsequent→next, prior→before, commence→start, terminate→end, sufficient→enough, endeavor→try, nevertheless→still, notwithstanding→despite, heretofore→previously, aforementioned→previous, inasmuch→since, henceforth→from now on, thereby→by this, whereby→by which, therein→in that",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "RD_004",
+          "title": "Consecutive prepositional phrases",
+          "pattern_description": "Flag 3+ prepositional phrases in a row — indicates complexity",
+          "severity": "suggestion"
+        },
+        {
+          "rule_id": "RD_005",
+          "title": "Repeated sentence beginnings",
+          "pattern_description": "Flag when 3+ consecutive sentences start with the same word",
+          "severity": "suggestion"
+        }
+      ]
+    }
+  ]
+}

package/src/rules/types.ts

@@ -0,0 +1,79 @@
+import type { Issue } from '../shared-types.js';
+
+export type RuleCategory = 'spelling' | 'grammar' | 'style' | 'clarity';
+
+export interface BaseRule {
+  id: string;
+  category: RuleCategory;
+  reason: string;
+}
+
+export interface RegexRule extends BaseRule {
+  type: 'regex';
+  pattern: RegExp;
+  suggestion: string | ((match: RegExpExecArray) => string);
+  /**
+   * Execute regex on text and return any matching issues.
+   */
+  check: (text: string) => Issue[];
+}
+
+export interface NLPRule extends BaseRule {
+  type: 'nlp';
+  /**
+   * Returns a suggestion based on the NLP match.
+   */
+  suggestion: string;
+  /**
+   * Execute compromise match logic on the parsed document.
+   */
+  check: (text: string, doc: any) => Issue[];
+}
+
+export type Rule = RegexRule | NLPRule;
+
+/**
+ * Helper to easily create Regex-based rules.
+ */
+export function createRegexRule({
+  id,
+  category,
+  reason,
+  pattern,
+  suggestion,
+}: Omit<RegexRule, 'type' | 'check'>): RegexRule {
+  return {
+    id,
+    type: 'regex',
+    category,
+    reason,
+    pattern,
+    suggestion,
+    check: (text: string): Issue[] => {
+      const issues: Issue[] = [];
+      let match: RegExpExecArray | null;
+
+      // Ensure the regex has the 'g' flag if we want all matches
+      const checkPattern = new RegExp(
+        pattern.source,
+        pattern.flags.includes('g') ? pattern.flags : pattern.flags + 'g',
+      );
+
+      while ((match = checkPattern.exec(text)) !== null) {
+        issues.push({
+          type: category,
+          original: match[0],
+          suggestion:
+            typeof suggestion === 'function'
+              ? suggestion(match)
+              : match[0].replace(pattern, suggestion),
+          reason,
+          offset: match.index,
+          length: match[0].length,
+          id: `${id}-${match.index}`,
+        });
+      }
+      return issues;
+    },
+  };
+}