@createiq/htmldiff 1.0.2 → 1.0.3

package/CLAUDE.md

@@ -0,0 +1,51 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Development Commands
+
+- **Build**: `npm run build` - Builds ESM and CJS modules using tsup
+- **Test**: `npm test` - Runs tests in watch mode using Vitest
+- **Test CI**: `npm run test:ci` - Runs tests once for CI environments
+- **Test Debug**: `npm run test-debug` - Runs tests with debugging enabled
+- **Lint**: `npm run lint` - Runs Biome linter with error-on-warnings
+- **Lint Fix**: `npm run lint:fix` - Runs linter and auto-fixes issues
+- **Format**: `npm run format` - Checks code formatting with Biome
+- **Format Fix**: `npm run format:fix` - Auto-formats code with Biome
+
+## Architecture
+
+This is a TypeScript HTML diff library that compares two HTML snippets and highlights differences. It's a port of the C# HtmlDiff.NET library.
+
+### Core Components
+
+- **HtmlDiff** (`src/HtmlDiff.ts`): Main class with `execute()` static method and configurable instance options
+- **WordSplitter** (`src/WordSplitter.ts`): Converts HTML to word arrays for comparison
+- **MatchFinder** (`src/MatchFinder.ts`): Finds matching blocks between old and new text
+- **Operation** (`src/Operation.ts`): Represents diff operations (Equal, Insert, Delete, Replace)
+- **Action** (`src/Action.ts`): Enum for operation types
+- **Match** (`src/Match.ts`): Represents matched text blocks
+- **Utils** (`src/Utils.ts`): Utility functions for HTML tag handling
+
+### Key Features
+
+- Configurable diff accuracy via `repeatingWordsAccuracy` (0-1)
+- Whitespace difference handling via `ignoreWhitespaceDifferences`
+- Orphan match filtering via `orphanMatchThreshold`
+- Block expressions for grouping text (dates, etc.)
+- Special handling for HTML formatting tags
+
+### Build System
+
+- **tsup**: Builds ESM/CJS modules from `src/HtmlDiff.ts` entry point
+- **Biome**: Handles linting and formatting (replaces ESLint/Prettier)
+- **Vitest**: Test runner with coverage reporting
+- **Husky**: Git hooks with lint-staged for pre-commit checks
+
+### Testing
+
+Tests are in `/test` directory using Vitest. Run `npm test` for watch mode or `npm run test:ci` for single run. Coverage reports generated with Istanbul provider.
+
+### Release Process
+
+Releases happen via merge requests to `prod` branch from `main`. Version must be bumped in package.json following semver.

package/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+node = "22"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@createiq/htmldiff",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "TypeScript port of htmldiff.net",
   "type": "module",
   "author": "Mathew Mannion <mathew.mannion@linklaters.com>",
@@ -16,16 +16,16 @@
     "node": ">=20.0.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.1.1",
-    "@cyclonedx/cyclonedx-npm": "4.0.0",
+    "@biomejs/biome": "2.2.6",
+    "@cyclonedx/cyclonedx-npm": "4.0.3",
     "@tsconfig/recommended": "1.0.10",
-    "@types/node": "22.16.4",
+    "@types/node": "22.18.11",
     "@vitest/coverage-istanbul": "3.2.4",
     "@vitest/ui": "3.2.4",
     "husky": "9.1.7",
-    "lint-staged": "16.1.2",
+    "lint-staged": "16.2.4",
     "tsup": "8.5.0",
-    "typescript": "5.8.3",
+    "typescript": "5.9.3",
     "vitest": "3.2.4"
   },
   "scripts": {

package/.node-version

@@ -1 +0,0 @@
-22.11.0