ai-text-check 1.0.0

package/dist/types-BlvvRFG5.d.cts

@@ -0,0 +1,153 @@
+type Severity = "error" | "warn" | "info";
+type Category = "ai" | "grammar" | "readability" | "structure" | "seo" | "typography";
+type EngineName = "polish" | "slop-gate" | "write-good" | "retext" | "is-this-ai-slop" | "veldica" | "clean-writing" | "vale";
+type TextFormat = "auto" | "plain" | "markdown";
+type PresetName = "default" | "strict" | "ai" | "grammar";
+type CheckName = "ai" | "grammar" | "readability" | "structure" | "seo" | "typography";
+type Issue = {
+    rule: string;
+    category: Category;
+    severity: Severity;
+    message: string;
+    engine?: EngineName;
+    line?: number;
+    column?: number;
+    excerpt?: string;
+    suggestion?: string;
+    match?: string;
+};
+type TextStats = {
+    words: number;
+    sentences: number;
+    paragraphs: number;
+    avgSentenceLength: number;
+    avgParagraphLength: number;
+    passiveVoiceHits: number;
+    aiPatternHits: number;
+    fleschReadingEase: number;
+    titleLength: number;
+    descriptionLength: number;
+};
+type CheckReport = {
+    source: string;
+    title: string;
+    format: Exclude<TextFormat, "auto">;
+    score: number;
+    issues: Issue[];
+    stats: TextStats;
+    enginesRun: EngineName[];
+    fixedText?: string;
+};
+type CheckSummary = {
+    reports: CheckReport[];
+    filesChecked: number;
+    filesWithIssues: number;
+    filesFixed: number;
+    averageScore: number;
+    failed: boolean;
+};
+type ChecksConfig = {
+    ai?: boolean;
+    grammar?: boolean;
+    readability?: boolean;
+    structure?: boolean;
+    seo?: boolean;
+    typography?: boolean;
+};
+type EnginesConfig = {
+    polish?: boolean;
+    slopGate?: boolean;
+    writeGood?: boolean;
+    retext?: boolean;
+    isThisAiSlop?: boolean;
+    veldica?: boolean;
+    cleanWriting?: boolean;
+    vale?: boolean;
+};
+type MarkdownConfig = {
+    skipCode?: boolean;
+    skipFrontmatter?: boolean;
+    skipHtml?: boolean;
+    skipTables?: boolean;
+};
+type SeoThresholds = {
+    titleMin?: number;
+    titleMax?: number;
+    descriptionMin?: number;
+    descriptionMax?: number;
+};
+type ReadabilityThresholds = {
+    avgSentenceWarn?: number;
+    longSentenceWords?: number;
+    longParagraphWords?: number;
+    passiveRatio?: number;
+};
+type UserConfig = {
+    preset?: PresetName;
+    checks?: ChecksConfig;
+    engines?: EnginesConfig;
+    format?: TextFormat;
+    failOn?: Severity;
+    minScore?: number;
+    ignoreRules?: string[];
+    include?: string[];
+    exclude?: string[];
+    extensions?: string[];
+    markdown?: MarkdownConfig;
+    seo?: SeoThresholds;
+    readability?: ReadabilityThresholds;
+};
+type ResolvedConfig = {
+    preset: PresetName;
+    checks: Required<ChecksConfig>;
+    engines: Required<EnginesConfig>;
+    format: TextFormat;
+    failOn: Severity;
+    minScore: number;
+    ignoreRules: string[];
+    include: string[];
+    exclude: string[];
+    extensions: string[];
+    markdown: Required<MarkdownConfig>;
+    seo: Required<SeoThresholds>;
+    readability: Required<ReadabilityThresholds>;
+};
+type CheckOptions = {
+    source?: string;
+    format?: TextFormat;
+    applyFixes?: boolean;
+    config?: UserConfig;
+};
+type SanitizeOptions = {
+    dashes?: boolean;
+    smartQuotes?: boolean;
+    ellipses?: boolean;
+    invisibleChars?: boolean;
+    spaces?: boolean;
+    lineStartBullets?: boolean;
+};
+type ReplacementStats = {
+    dashes: number;
+    smartQuotes: number;
+    ellipses: number;
+    invisibleChars: number;
+    spaces: number;
+    lineStartBullets: number;
+    total: number;
+};
+type ClauseReplacer = (substring: string, ...groups: string[]) => string;
+type PatternRule = {
+    id: string;
+    category: Category;
+    pattern: RegExp;
+    message: string;
+    severity?: Severity;
+    suggestion?: string;
+    replacement?: string | ClauseReplacer;
+    autoFix?: boolean;
+    minCount?: number | ((ctx: {
+        words: number;
+    }) => number);
+};
+
+export type { CheckOptions as C, EngineName as E, Issue as I, MarkdownConfig as M, PatternRule as P, ResolvedConfig as R, SanitizeOptions as S, TextFormat as T, UserConfig as U, CheckReport as a, ReplacementStats as b, Severity as c, Category as d, CheckName as e, CheckSummary as f, ChecksConfig as g, EnginesConfig as h, PresetName as i, ReadabilityThresholds as j, SeoThresholds as k, TextStats as l };

package/dist/types-BlvvRFG5.d.ts

@@ -0,0 +1,153 @@
+type Severity = "error" | "warn" | "info";
+type Category = "ai" | "grammar" | "readability" | "structure" | "seo" | "typography";
+type EngineName = "polish" | "slop-gate" | "write-good" | "retext" | "is-this-ai-slop" | "veldica" | "clean-writing" | "vale";
+type TextFormat = "auto" | "plain" | "markdown";
+type PresetName = "default" | "strict" | "ai" | "grammar";
+type CheckName = "ai" | "grammar" | "readability" | "structure" | "seo" | "typography";
+type Issue = {
+    rule: string;
+    category: Category;
+    severity: Severity;
+    message: string;
+    engine?: EngineName;
+    line?: number;
+    column?: number;
+    excerpt?: string;
+    suggestion?: string;
+    match?: string;
+};
+type TextStats = {
+    words: number;
+    sentences: number;
+    paragraphs: number;
+    avgSentenceLength: number;
+    avgParagraphLength: number;
+    passiveVoiceHits: number;
+    aiPatternHits: number;
+    fleschReadingEase: number;
+    titleLength: number;
+    descriptionLength: number;
+};
+type CheckReport = {
+    source: string;
+    title: string;
+    format: Exclude<TextFormat, "auto">;
+    score: number;
+    issues: Issue[];
+    stats: TextStats;
+    enginesRun: EngineName[];
+    fixedText?: string;
+};
+type CheckSummary = {
+    reports: CheckReport[];
+    filesChecked: number;
+    filesWithIssues: number;
+    filesFixed: number;
+    averageScore: number;
+    failed: boolean;
+};
+type ChecksConfig = {
+    ai?: boolean;
+    grammar?: boolean;
+    readability?: boolean;
+    structure?: boolean;
+    seo?: boolean;
+    typography?: boolean;
+};
+type EnginesConfig = {
+    polish?: boolean;
+    slopGate?: boolean;
+    writeGood?: boolean;
+    retext?: boolean;
+    isThisAiSlop?: boolean;
+    veldica?: boolean;
+    cleanWriting?: boolean;
+    vale?: boolean;
+};
+type MarkdownConfig = {
+    skipCode?: boolean;
+    skipFrontmatter?: boolean;
+    skipHtml?: boolean;
+    skipTables?: boolean;
+};
+type SeoThresholds = {
+    titleMin?: number;
+    titleMax?: number;
+    descriptionMin?: number;
+    descriptionMax?: number;
+};
+type ReadabilityThresholds = {
+    avgSentenceWarn?: number;
+    longSentenceWords?: number;
+    longParagraphWords?: number;
+    passiveRatio?: number;
+};
+type UserConfig = {
+    preset?: PresetName;
+    checks?: ChecksConfig;
+    engines?: EnginesConfig;
+    format?: TextFormat;
+    failOn?: Severity;
+    minScore?: number;
+    ignoreRules?: string[];
+    include?: string[];
+    exclude?: string[];
+    extensions?: string[];
+    markdown?: MarkdownConfig;
+    seo?: SeoThresholds;
+    readability?: ReadabilityThresholds;
+};
+type ResolvedConfig = {
+    preset: PresetName;
+    checks: Required<ChecksConfig>;
+    engines: Required<EnginesConfig>;
+    format: TextFormat;
+    failOn: Severity;
+    minScore: number;
+    ignoreRules: string[];
+    include: string[];
+    exclude: string[];
+    extensions: string[];
+    markdown: Required<MarkdownConfig>;
+    seo: Required<SeoThresholds>;
+    readability: Required<ReadabilityThresholds>;
+};
+type CheckOptions = {
+    source?: string;
+    format?: TextFormat;
+    applyFixes?: boolean;
+    config?: UserConfig;
+};
+type SanitizeOptions = {
+    dashes?: boolean;
+    smartQuotes?: boolean;
+    ellipses?: boolean;
+    invisibleChars?: boolean;
+    spaces?: boolean;
+    lineStartBullets?: boolean;
+};
+type ReplacementStats = {
+    dashes: number;
+    smartQuotes: number;
+    ellipses: number;
+    invisibleChars: number;
+    spaces: number;
+    lineStartBullets: number;
+    total: number;
+};
+type ClauseReplacer = (substring: string, ...groups: string[]) => string;
+type PatternRule = {
+    id: string;
+    category: Category;
+    pattern: RegExp;
+    message: string;
+    severity?: Severity;
+    suggestion?: string;
+    replacement?: string | ClauseReplacer;
+    autoFix?: boolean;
+    minCount?: number | ((ctx: {
+        words: number;
+    }) => number);
+};
+
+export type { CheckOptions as C, EngineName as E, Issue as I, MarkdownConfig as M, PatternRule as P, ResolvedConfig as R, SanitizeOptions as S, TextFormat as T, UserConfig as U, CheckReport as a, ReplacementStats as b, Severity as c, Category as d, CheckName as e, CheckSummary as f, ChecksConfig as g, EnginesConfig as h, PresetName as i, ReadabilityThresholds as j, SeoThresholds as k, TextStats as l };

package/package.json

@@ -0,0 +1,115 @@
+{
+  "name": "ai-text-check",
+  "version": "1.0.0",
+  "description": "Detect AI-generated writing tells, grammar issues, and synthetic typography in JavaScript and TypeScript projects.",
+  "license": "MIT",
+  "author": "Pritam Ghosh <contact.meghoshpritam@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meghoshpritam/ai-text-check.git"
+  },
+  "bugs": {
+    "url": "https://github.com/meghoshpritam/ai-text-check/issues"
+  },
+  "homepage": "https://github.com/meghoshpritam/ai-text-check#readme",
+  "keywords": [
+    "ai-detection",
+    "ai-writing",
+    "grammar",
+    "linter",
+    "prose",
+    "markdown",
+    "typescript",
+    "javascript",
+    "vale",
+    "slop-gate",
+    "readability",
+    "content-quality"
+  ],
+  "type": "module",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./node": {
+      "import": {
+        "types": "./dist/node.d.ts",
+        "default": "./dist/node.js"
+      },
+      "require": {
+        "types": "./dist/node.d.cts",
+        "default": "./dist/node.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "ai-text-check": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.map",
+    "vale",
+    "README.md",
+    "LICENSE",
+    "NOTICE",
+    "SOURCES.md",
+    "slop-gate.config.json"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup && node -e \"require('fs').chmodSync('dist/cli.js', 0o755)\"",
+    "clean": "rm -rf dist coverage",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "typecheck": "tsc --noEmit",
+    "check": "npm run typecheck && npm run lint && npm run format:check && npm run test",
+    "prepublishOnly": "npm run check && npm run build"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.35.0",
+    "@types/node": "^22.18.1",
+    "@types/write-good": "^1.0.3",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^16.4.0",
+    "prettier": "^3.6.2",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.43.0",
+    "vitest": "^3.2.4"
+  },
+  "dependencies": {
+    "@veldica/prose-linter": "^1.1.3",
+    "@vvago/vale": "^3.22.0",
+    "clean-writing-lint": "^0.1.0",
+    "is-this-ai-slop": "^0.1.0",
+    "marked": "^15.0.12",
+    "retext-english": "^5.0.0",
+    "retext-passive": "^5.0.0",
+    "retext-readability": "^8.0.0",
+    "retext-repeated-words": "^5.0.0",
+    "retext-simplify": "^8.0.0",
+    "retext-stringify": "^4.0.0",
+    "slop-gate": "^0.5.0",
+    "unified": "^11.0.5",
+    "write-good": "^1.0.8"
+  }
+}

package/slop-gate.config.json

@@ -0,0 +1,3 @@
+{
+  "rules": ["vocabulary"]
+}

package/vale/styles/AiTextCheck/DiveDeep.yml

@@ -0,0 +1,5 @@
+extends: existence
+message: "Overused AI phrasing around “dive/delve”."
+level: warning
+tokens:
+  - '\b(?:delve|delving|dive deep|dives into|deep dive)\b'

package/vale/styles/AiTextCheck/Furthermore.yml

@@ -0,0 +1,5 @@
+extends: existence
+message: "Stock AI transition (“furthermore”, “moreover”)."
+level: warning
+tokens:
+  - '\b(?:furthermore|moreover|additionally|in addition,?)\b'

package/vale/styles/AiTextCheck/ImportantToNote.yml

@@ -0,0 +1,5 @@
+extends: existence
+message: "Filler lead-in (“it is important to note”)."
+level: warning
+tokens:
+  - '\b(?:it(?:''s|’s) (?:important|worth|crucial) to note that|it should be noted that)\b'

package/vale/styles/AiTextCheck/InTodaysWorld.yml

@@ -0,0 +1,5 @@
+extends: existence
+message: "Generic opener (“in today's world”)."
+level: warning
+tokens:
+  - '\bin today(?:''s|’s) (?:fast-paced |digital |modern |ever-evolving |ever-changing |rapidly changing )*world\b'

package/vale/styles/AiTextCheck/LeverageUtilize.yml

@@ -0,0 +1,5 @@
+extends: existence
+message: "Corporate verb (“leverage”, “utilize”). Prefer “use”."
+level: warning
+tokens:
+  - '\b(?:leverage|leveraging|utilize|utilizing)\b'

package/vale/styles/AiTextCheck/meta.json

@@ -0,0 +1,3 @@
+{
+  "vale_version": ">=2.0.0"
+}

package/vale/styles/Google/AMPM.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: "Use 'AM' or 'PM' (preceded by a space)."
+link: "https://developers.google.com/style/word-list"
+level: error
+nonword: true
+tokens:
+  - '\d{1,2}[AP]M\b'
+  - '\d{1,2} ?[ap]m\b'
+  - '\d{1,2} ?[aApP]\.[mM]\.'

package/vale/styles/Google/Acronyms.yml

@@ -0,0 +1,64 @@
+extends: conditional
+message: "Spell out '%s', if it's unfamiliar to the audience."
+link: "https://developers.google.com/style/abbreviations"
+level: suggestion
+ignorecase: false
+# Ensures that the existence of 'first' implies the existence of 'second'.
+first: '\b([A-Z]{3,5})\b'
+second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
+# ... with the exception of these:
+exceptions:
+  - API
+  - ASP
+  - CLI
+  - CPU
+  - CSS
+  - CSV
+  - DEBUG
+  - DOM
+  - DPI
+  - FAQ
+  - GCC
+  - GDB
+  - GET
+  - GPU
+  - GTK
+  - GUI
+  - HTML
+  - HTTP
+  - HTTPS
+  - IDE
+  - JAR
+  - JSON
+  - JSX
+  - LESS
+  - LLDB
+  - NET
+  - NOTE
+  - NVDA
+  - OSS
+  - PATH
+  - PDF
+  - PHP
+  - POST
+  - RAM
+  - REPL
+  - RSA
+  - SCM
+  - SCSS
+  - SDK
+  - SQL
+  - SSH
+  - SSL
+  - SVG
+  - TBD
+  - TCP
+  - TODO
+  - URI
+  - URL
+  - USB
+  - UTF
+  - XML
+  - XSS
+  - YAML
+  - ZIP

package/vale/styles/Google/Colons.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "'%s' should be in lowercase."
+link: "https://developers.google.com/style/colons"
+nonword: true
+level: warning
+scope: sentence
+tokens:
+  - '(?<!:[^ ]+?):\s[A-Z]'

package/vale/styles/Google/Contractions.yml

@@ -0,0 +1,30 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: "https://developers.google.com/style/contractions"
+level: suggestion
+ignorecase: true
+action:
+  name: replace
+swap:
+  are not: aren't
+  cannot: can't
+  could not: couldn't
+  did not: didn't
+  do not: don't
+  does not: doesn't
+  has not: hasn't
+  have not: haven't
+  how is: how's
+  is not: isn't
+  it is: it's
+  should not: shouldn't
+  that is: that's
+  they are: they're
+  was not: wasn't
+  we are: we're
+  we have: we've
+  were not: weren't
+  what is: what's
+  when is: when's
+  where is: where's
+  will not: won't

package/vale/styles/Google/DateFormat.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: "Use 'July 31, 2016' format, not '%s'."
+link: "https://developers.google.com/style/dates-times"
+ignorecase: true
+level: error
+nonword: true
+tokens:
+  - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}'
+  - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'

package/vale/styles/Google/Ellipses.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: "In general, don't use an ellipsis."
+link: "https://developers.google.com/style/ellipses"
+nonword: true
+level: warning
+action:
+  name: remove
+tokens:
+  - '\.\.\.'

package/vale/styles/Google/EmDash.yml

@@ -0,0 +1,12 @@
+extends: existence
+message: "Don't put a space before or after a dash."
+link: "https://developers.google.com/style/dashes"
+nonword: true
+level: error
+action:
+  name: edit
+  params:
+    - trim
+    - " "
+tokens:
+  - '\s[—–]\s'

package/vale/styles/Google/Exclamation.yml

@@ -0,0 +1,12 @@
+extends: existence
+message: "Don't use exclamation points in text."
+link: "https://developers.google.com/style/exclamation-points"
+nonword: true
+level: error
+action:
+  name: edit
+  params:
+    - trim_right
+    - "!"
+tokens:
+  - '\w+!(?:\s|$)'

package/vale/styles/Google/FirstPerson.yml

@@ -0,0 +1,13 @@
+extends: existence
+message: "Avoid first-person pronouns such as '%s'."
+link: "https://developers.google.com/style/pronouns#personal-pronouns"
+ignorecase: true
+level: warning
+nonword: true
+tokens:
+  - (?:^|\s)I\s
+  - (?:^|\s)I,\s
+  - \bI'm\b
+  - \bme\b
+  - \bmy\b
+  - \bmine\b

package/vale/styles/Google/Gender.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: "Don't use '%s' as a gender-neutral pronoun."
+link: "https://developers.google.com/style/pronouns#gender-neutral-pronouns"
+level: error
+ignorecase: true
+tokens:
+  - he/she
+  - s/he
+  - \(s\)he