wsc: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Commands

npm run dev          # Start dev server at localhost:5173
npm run build        # Build for production (Cloudflare Workers)
npm run check        # Type check (svelte-kit sync + svelte-check)
npm test             # Run all tests (vitest run)
npm run test:watch   # Run tests in watch mode
npm run test:coverage # Coverage report (istanbul)

Run a single test file: npx vitest run tests/core/detector.test.ts

MCP Server (separate package in mcp-server/)

cd mcp-server && npm ci && npm run build   # Build standalone MCP server

CLI (separate package in cli/)

cd cli && npm ci && npm run build   # Build CLI
node cli/dist/cli/index.js check "**/*.md"  # Run check

Architecture

Writing Style Checker (WSC) — detects 8 types of writing issues. Six interfaces: web editor, HTTP API, remote MCP, local MCP, CLI, and GitHub Action.

Core Detection Engine (src/core/)

• detector.ts — 8 detector functions: detectWeaselWords, detectPassiveVoice, detectDuplicateWords, detectLongSentences, detectNominalizations, detectHedging, detectAdverbs, detectAiTells, plus removeDuplicateWord. All return match positions (index + length). Weasel words, nominalizations, hedging, adverbs, and AI tells accept optional custom word lists for config support.
• words.ts — Word lists: 95 weasel words (allWeaselWords), 260 irregular verbs, 13 auxiliary verbs, 245 nominalizations (with suggestions), 100 hedging phrases, 139 filler adverbs, 99 abbreviations, 98 AI tells vocabulary entries (with optional inflected variants and reasons), 83 AI tells phrases (with reasons), 12 AI tells structural regex patterns (aiTellsPatterns, named + removable via config removePatterns).
• config.ts — Browser-safe config types (WscConfig), DEFAULT_CONFIG, mergeConfig(), applyWordListOverrides(), applyNominalizationOverrides(), validateConfig(). No Node.js imports.
• config-node.ts — Node-only: loadConfigFromFile(), findConfigFile(). Uses node:fs/promises and node:path. Only imported by mcp-server and CLI.
• markdown.ts — maskMarkdown() blanks non-prose Markdown regions (fenced code, inline code spans, tables, headings, HTML comments) while preserving length and line layout, so offsets still map back to the original text. isMarkdownFile() checks a path's extension.
• analyzer.ts — analyzeText(text, config?, options?: AnalyzeOptions) — the single entry point all consumers call. AnalyzeOptions.markdown runs the text through maskMarkdown() before detection. Runs enabled detectors with config overrides, returns AnalysisResult.
• index.ts — Public re-exports (does NOT export config-node functions).