@createiq/htmldiff 1.0.2 → 1.0.4-beta.0

package/.claude/settings.local.json

@@ -0,0 +1,15 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(diff -u test/input1.html test/input2.html)",
+      "Bash(npm test -- test/Bug.spec.tsx)",
+      "Bash(timeout 30s npm run test:ci -- test/Bug.spec.tsx)",
+      "Bash(npm run build)",
+      "Bash(timeout 10s npm run test:ci -- test/Bug.spec.tsx)",
+      "Bash(npm run lint)",
+      "Bash(npm run test:ci)",
+      "Bash(npm run bench:ci)"
+    ],
+    "deny": []
+  }
+}

package/.gitlab-ci.yml

@@ -8,7 +8,7 @@ default:
 
 "Run unit tests":
   stage: test
-  image: ${ACR_HOSTNAME}/infra/baseimages/node:22-alpine
+  image: ${ACR_HOSTNAME}/infra/baseimages/node:24-alpine
   before_script:
     - npm ci --prefer-offline --no-audit
   script:
@@ -32,7 +32,7 @@ default:
 
 "Lint":
   stage: test
-  image: ${ACR_HOSTNAME}/infra/baseimages/node:22-alpine
+  image: ${ACR_HOSTNAME}/infra/baseimages/node:24-alpine
   before_script:
     - npm ci --prefer-offline --no-audit
   script:
@@ -49,7 +49,7 @@ default:
 # TODO this runs on gke01-london for firewall reasons to be able to talk to registry.npmjs.org
 "Publish to npm - dry-run":
   stage: deploy
-  image: ${CI_REGISTRY}/infra/baseimages/node:22-alpine
+  image: ${CI_REGISTRY}/infra/baseimages/node:24-alpine
   before_script:
     - npm ci --prefer-offline --no-audit
   script:
@@ -67,7 +67,7 @@ default:
 # TODO this runs on gke01-london for firewall reasons to be able to talk to registry.npmjs.org
 "Publish to npm":
   stage: deploy
-  image: ${CI_REGISTRY}/infra/baseimages/node:22-alpine
+  image: ${CI_REGISTRY}/infra/baseimages/node:24-alpine
   before_script:
     - npm ci --prefer-offline --no-audit
   script:
@@ -83,7 +83,7 @@ default:
 
 .generate_sbom: &generate_sbom
   stage: generate_artifacts
-  image: ${ACR_HOSTNAME}/infra/baseimages/node:22-alpine
+  image: ${ACR_HOSTNAME}/infra/baseimages/node:24-alpine
   before_script:
     - npm ci --prefer-offline --no-audit
   script:

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/biome.json

@@ -49,5 +49,8 @@
     "clientKind": "git",
     "useIgnoreFile": true,
     "defaultBranch": "main"
+  },
+  "files": {
+    "includes": ["**", "!test/*.html"]
   }
 }