chaffjs 0.19.0 → 0.21.0

package/src/detectors/registry/katakana-long-vowel.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { katakanaLongVowel } from "../long-vowel.ts";
+
+export const detector: Detector = katakanaLongVowel;

package/src/detectors/registry/known-correction.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { knownCorrection } from "../known-correction.ts";
+
+export const detector: Detector = knownCorrection;

package/src/detectors/registry/kutoten-consistency.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { kutotenConsistency } from "../kutoten-consistency.ts";
+
+export const detector: Detector = kutotenConsistency;

package/src/detectors/registry/latin-abbreviation.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { latinAbbreviation } from "../mark-shape.ts";
+
+export const detector: Detector = latinAbbreviation;

package/src/detectors/registry/latin-spacing.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { latinSpacing } from "../orthography.ts";
+
+export const detector: Detector = latinSpacing;

package/src/detectors/registry/link-text-url-mismatch.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { linkTextUrlMismatch } from "../link-shape.ts";
+
+export const detector: Detector = linkTextUrlMismatch;

package/src/detectors/registry/list-item-form-mix.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { listItemFormMix } from "../list-parallel.ts";
+
+export const detector: Detector = listItemFormMix;

package/src/detectors/registry/mark-consistency.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { markConsistency } from "../mark-shape.ts";
+
+export const detector: Detector = markConsistency;

package/src/detectors/registry/middle-dot.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { middleDot } from "../char-shape.ts";
+
+export const detector: Detector = middleDot;

package/src/detectors/registry/misuse-match.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { misuseMatch } from "../misuse-match.ts";
+
+export const detector: Detector = misuseMatch;

package/src/detectors/registry/modal-conflict.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { modalConflict } from "../modal-conflict.ts";
+
+export const detector: Detector = modalConflict;

package/src/detectors/registry/name-variant.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { nameVariant } from "../name-variant.ts";
+
+export const detector: Detector = nameVariant;

package/src/detectors/registry/ngram-repetition.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { ngramRepetition } from "../signals.ts";
+
+export const detector: Detector = ngramRepetition;

package/src/detectors/registry/no-lead.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { noLead } from "../document-shape.ts";
+
+export const detector: Detector = noLead;

package/src/detectors/registry/nominalization.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { nominalization } from "../nominalization.ts";
+
+export const detector: Detector = nominalization;

package/src/detectors/registry/noun-ending.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { nounEnding } from "../token-shape.ts";
+
+export const detector: Detector = nounEnding;

package/src/detectors/registry/number-style-consistency.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { numberStyleConsistency } from "../number-style.ts";
+
+export const detector: Detector = numberStyleConsistency;

package/src/detectors/registry/number-without-unit.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { numberWithoutUnit } from "../number-unit.ts";
+
+export const detector: Detector = numberWithoutUnit;

package/src/detectors/registry/numbering-gap.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { numberingGap } from "../structure-tree.ts";
+
+export const detector: Detector = numberingGap;

package/src/detectors/registry/one-sentence-paragraph-run.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { oneSentenceParagraphRun } from "../paragraph-run.ts";
+
+export const detector: Detector = oneSentenceParagraphRun;

package/src/detectors/registry/opener-pile.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { openerPile } from "../ai-phrasing.ts";
+
+export const detector: Detector = openerPile;

package/src/detectors/registry/opener-run.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { openerRun } from "../sentence-counts.ts";
+
+export const detector: Detector = openerRun;

package/src/detectors/registry/origin-particle.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { originParticle } from "../clause-shape.ts";
+
+export const detector: Detector = originParticle;

package/src/detectors/registry/orthographic-variant.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { orthographicVariant } from "../orthographic-variant.ts";
+
+export const detector: Detector = orthographicVariant;

package/src/detectors/registry/outside-announced-list.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { outsideAnnouncedList } from "../outside-announced-list.ts";
+
+export const detector: Detector = outsideAnnouncedList;

package/src/detectors/registry/oxford-comma.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { oxfordComma } from "../oxford-comma.ts";
+
+export const detector: Detector = oxfordComma;

package/src/detectors/registry/paragraph-length.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { paragraphLength } from "../structure.ts";
+
+export const detector: Detector = paragraphLength;

package/src/detectors/registry/paragraph-restatement.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { paragraphRestatement } from "../paragraph-restatement.ts";
+
+export const detector: Detector = paragraphRestatement;

package/src/detectors/registry/paragraph-variance.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { paragraphVariance } from "../structure.ts";
+
+export const detector: Detector = paragraphVariance;

package/src/detectors/registry/percent-sum-mismatch.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { percentSumMismatch } from "../structure-tree.ts";
+
+export const detector: Detector = percentSumMismatch;

package/src/detectors/registry/person-mix.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { personMix } from "../person-consistency.ts";
+
+export const detector: Detector = personMix;

package/src/detectors/registry/phrase-count.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { phraseCount } from "../phrase-match.ts";
+
+export const detector: Detector = phraseCount;

package/src/detectors/registry/phrase-density.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { phraseDensity } from "../lexicon.ts";
+
+export const detector: Detector = phraseDensity;

package/src/detectors/registry/phrase-match.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { phraseMatch } from "../phrase-match.ts";
+
+export const detector: Detector = phraseMatch;

package/src/detectors/registry/preamble-length.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { preambleLength } from "../structure.ts";
+
+export const detector: Detector = preambleLength;

package/src/detectors/registry/preferred-term.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { preferredTerm } from "../orthography.ts";
+
+export const detector: Detector = preferredTerm;

package/src/detectors/registry/proper-noun-density.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { properNounDensity } from "../team.ts";
+
+export const detector: Detector = properNounDensity;

package/src/detectors/registry/ra-nuki.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { raNuki } from "../ra-nuki.ts";
+
+export const detector: Detector = raNuki;

package/src/detectors/registry/reference-title-mismatch.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { referenceTitleMismatch } from "../reference-text.ts";
+
+export const detector: Detector = referenceTitleMismatch;

package/src/detectors/registry/reference-topic-missing.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { referenceTopicMissing } from "../reference-text.ts";
+
+export const detector: Detector = referenceTopicMissing;

package/src/detectors/registry/relative-date-mismatch.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { relativeDateMismatch } from "../relative-dates.ts";
+
+export const detector: Detector = relativeDateMismatch;

package/src/detectors/registry/repeated-conjunction.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { repeatedConjunction } from "../lexicon.ts";
+
+export const detector: Detector = repeatedConjunction;

package/src/detectors/registry/repeated-head.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { repeatedHead } from "../repeated-head.ts";
+
+export const detector: Detector = repeatedHead;

package/src/detectors/registry/request-without-deadline.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { requestWithoutDeadline } from "../request-owner.ts";
+
+export const detector: Detector = requestWithoutDeadline;

package/src/detectors/registry/required-sections.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { requiredSections } from "../team.ts";
+
+export const detector: Detector = requiredSections;

package/src/detectors/registry/requirement-modal.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { requirementModal } from "../requirement-modal.ts";
+
+export const detector: Detector = requirementModal;

package/src/detectors/registry/requirement-smell.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { requirementSmell } from "../requirement-smell.ts";
+
+export const detector: Detector = requirementSmell;

package/src/detectors/registry/rule-of-three.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { ruleOfThree } from "../structure.ts";
+
+export const detector: Detector = ruleOfThree;

package/src/detectors/registry/section-uniformity.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { sectionUniformity } from "../structure.ts";
+
+export const detector: Detector = sectionUniformity;

package/src/detectors/registry/sentence-comma-count.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { sentenceCommaCount } from "../sentence-counts.ts";
+
+export const detector: Detector = sentenceCommaCount;

package/src/detectors/registry/sentence-conjunctive-count.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { sentenceConjunctiveCount } from "../sentence-counts.ts";
+
+export const detector: Detector = sentenceConjunctiveCount;

package/src/detectors/registry/sentence-ending.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { sentenceEnding } from "../sentence-ending.ts";
+
+export const detector: Detector = sentenceEnding;

package/src/detectors/registry/sentence-length.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { sentenceLength } from "../sentence-length.ts";
+
+export const detector: Detector = sentenceLength;

package/src/detectors/registry/sentence-rhythm.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { sentenceRhythm } from "../sentence-rhythm.ts";
+
+export const detector: Detector = sentenceRhythm;

package/src/detectors/registry/sentence-spacing.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { sentenceSpacing } from "../mark-shape.ts";
+
+export const detector: Detector = sentenceSpacing;

package/src/detectors/registry/sentence-word-count.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { sentenceWordCount } from "../sentence-counts.ts";
+
+export const detector: Detector = sentenceWordCount;

package/src/detectors/registry/shell-prompt.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { shellPrompt } from "../technical-docs.ts";
+
+export const detector: Detector = shellPrompt;

package/src/detectors/registry/space-before-punctuation.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { spaceBeforePunctuation } from "../space-before-punctuation.ts";
+
+export const detector: Detector = spaceBeforePunctuation;

package/src/detectors/registry/spelling-variety.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { spellingVariety } from "../spelling-variety.ts";
+
+export const detector: Detector = spellingVariety;

package/src/detectors/registry/step-statement.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { stepStatement } from "../technical-docs.ts";
+
+export const detector: Detector = stepStatement;

package/src/detectors/registry/stock-transition.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { openerDensity } from "../ai-phrasing.ts";
+
+export const detector: Detector = openerDensity;

package/src/detectors/registry/stray-space.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { straySpace } from "../stray-space.ts";
+
+export const detector: Detector = straySpace;

package/src/detectors/registry/summary-fact-mismatch.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { summaryFactMismatch } from "../fact-consistency.ts";
+
+export const detector: Detector = summaryFactMismatch;

package/src/detectors/registry/table-header-variant.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { tableHeaderVariant } from "../table-header.ts";
+
+export const detector: Detector = tableHeaderVariant;

package/src/detectors/registry/title-case-mix.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { titleCaseMix } from "../en-shape.ts";
+
+export const detector: Detector = titleCaseMix;

package/src/detectors/registry/title-length.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { titleLength } from "../document-shape.ts";
+
+export const detector: Detector = titleLength;

package/src/detectors/registry/topic-predicate-distance.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { topicPredicateDistance } from "../sentence-load.ts";
+
+export const detector: Detector = topicPredicateDistance;

package/src/detectors/registry/total-mismatch.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { totalMismatch } from "../structure-tree.ts";
+
+export const detector: Detector = totalMismatch;

package/src/detectors/registry/unbalanced-bracket.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { unbalancedBracket } from "../unbalanced-bracket.ts";
+
+export const detector: Detector = unbalancedBracket;

package/src/detectors/registry/undefined-acronym.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { undefinedAcronym } from "../signals.ts";
+
+export const detector: Detector = undefinedAcronym;

package/src/detectors/registry/unfilled-placeholder.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { unfilledPlaceholder } from "../ai-phrasing.ts";
+
+export const detector: Detector = unfilledPlaceholder;

package/src/detectors/registry/unit-mismatch.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { unitMismatch } from "../unit-consistency.ts";
+
+export const detector: Detector = unitMismatch;

package/src/detectors/registry/unknown-word.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { unknownWord } from "../unknown-word.ts";
+
+export const detector: Detector = unknownWord;

package/src/detectors/registry/unpaired-parallel.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { unpairedParallel } from "../clause-shape.ts";
+
+export const detector: Detector = unpairedParallel;

package/src/detectors/registry/unqualified-superlative.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { unqualifiedSuperlative } from "../lexicon.ts";
+
+export const detector: Detector = unqualifiedSuperlative;

package/src/detectors/registry/unused-definition.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { unusedDefinition } from "../definition-use.ts";
+
+export const detector: Detector = unusedDefinition;

package/src/detectors/registry/url-run-on.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { urlRunOn } from "../url-run-on.ts";
+
+export const detector: Detector = urlRunOn;

package/src/detectors/registry/use-before-definition.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { useBeforeDefinition } from "../definition-use.ts";
+
+export const detector: Detector = useBeforeDefinition;

package/src/detectors/registry/vague-density.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { vagueDensity } from "../lexicon.ts";
+
+export const detector: Detector = vagueDensity;

package/src/detectors/registry/vague-figure-pointer.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { vagueFigurePointer } from "../vague-figure-pointer.ts";
+
+export const detector: Detector = vagueFigurePointer;

package/src/detectors/registry/vague-link-text.ts

@@ -0,0 +1,4 @@
+import type { Detector } from "../../plugin.ts";
+import { vagueLinkText } from "../vague-link-text.ts";
+
+export const detector: Detector = vagueLinkText;

package/src/detectors/registry-files.ts

@@ -0,0 +1,12 @@
+/** A file in detectors/registry/ and the how_to_find it serves: its name without the extension. */
+export type RegistryEntry = { readonly file: string; readonly howToFind: string };
+
+/**
+ * The registry files among a directory's names, in name order. Only names ending in the extension of the running module
+ * count: from src that is .ts, from dist .js, where the .d.ts and .map files beside them are not detectors.
+ */
+export const registryEntries = (names: readonly string[], extension: string): RegistryEntry[] =>
+  names
+    .filter((name) => name.endsWith(extension) && !name.endsWith(`.d${extension}`) && name.length > extension.length)
+    .toSorted((left, right) => left.localeCompare(right, "en"))
+    .map((file) => ({ file, howToFind: file.slice(0, -extension.length) }));

package/src/detectors/registry-load.ts

@@ -0,0 +1,23 @@
+import { existsSync, readdirSync } from "node:fs";
+import { createRequire } from "node:module";
+import { join } from "node:path";
+import { registryEntries } from "./registry-files.ts";
+
+// require (not import) keeps a registry ready synchronously, without a top-level await in every importer.
+const requireModule = createRequire(import.meta.url);
+
+const detectorOf = (loaded: unknown): unknown => (typeof loaded === "object" && loaded !== null && "detector" in loaded ? loaded.detector : undefined);
+
+/**
+ * The detectors of a registry directory, one file per how_to_find, each exporting a function named detector.
+ * extension is that of the running module (.ts from src, .js from dist). A directory that is not there holds none.
+ */
+export const loadRegistry = <T>(dir: string, extension: string, isDetector: (value: unknown) => value is T): Readonly<Record<string, T>> =>
+  Object.fromEntries(
+    registryEntries(existsSync(dir) ? readdirSync(dir) : [], extension).map(({ file, howToFind }) => {
+      const path = join(dir, file);
+      const detector = detectorOf(requireModule(path));
+      if (!isDetector(detector)) throw new Error(`chaff: ${path} must export a function named detector`);
+      return [howToFind, detector];
+    }),
+  );