@createiq/htmldiff 1.0.0

package/.gitlab-ci.yml

@@ -0,0 +1,71 @@
+stages:
+  - test
+  - deploy
+
+default:
+  interruptible: true
+
+"Run unit tests":
+  stage: test
+  image: ${CI_REGISTRY}/infra/baseimages/node:22-alpine
+  script:
+    - npm i
+    - VITEST_MAX_THREADS=4 npm run test:ci -- --coverage
+  allow_failure: false
+  needs: []
+  artifacts:
+    when: always
+    reports:
+      junit:
+        - junit.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/cobertura-coverage.xml
+  coverage: /All files[^\|]*\|[^\|]*\s+([\d\.]+)/
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH == "main" && $CI_PIPELINE_TRIGGERED != "true"
+    - if: $CI_COMMIT_BRANCH == "prod" && $CI_PIPELINE_TRIGGERED != "true"
+
+"Lint":
+  stage: test
+  image: ${CI_REGISTRY}/infra/baseimages/node:22-alpine
+  script:
+    - npm i
+    - npm run lint
+    - npm run format
+  allow_failure: false
+  needs: []
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH == "main" && $CI_PIPELINE_TRIGGERED != "true"
+    - if: $CI_COMMIT_BRANCH == "prod" && $CI_PIPELINE_TRIGGERED != "true"
+
+"Publish to npm - dry-run":
+  stage: deploy
+  image: ${CI_REGISTRY}/infra/baseimages/node:22-alpine
+  script:
+    - npm i
+    - npm run build
+    # Use the default registry for publishing
+    - npm --verbose config --global delete registry
+    - NODE_EXTRA_CA_CERTS=/etc/ssl/certs/ca-certificates.crt HTTPS_PROXY=$PROJENV_HTTPS_PROXY NO_PROXY=$PROJENV_NO_PROXY npm publish --access public --dry-run
+  allow_failure: false
+  # No needs, only run if the test stage passes
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH == "main" && $CI_PIPELINE_TRIGGERED != "true"
+
+"Publish to npm":
+  stage: deploy
+  image: ${CI_REGISTRY}/infra/baseimages/node:22-alpine
+  script:
+    - npm i
+    - npm run build
+    # Use the default registry for publishing
+    - npm --verbose config --global delete registry
+    - NODE_EXTRA_CA_CERTS=/etc/ssl/certs/ca-certificates.crt HTTPS_PROXY=$PROJENV_HTTPS_PROXY NO_PROXY=$PROJENV_NO_PROXY npm publish --access public
+  allow_failure: false
+  # No needs, only run if the test stage passes
+  rules:
+    - if: $CI_COMMIT_BRANCH == "prod" && $CI_PIPELINE_TRIGGERED != "true"

package/.node-version

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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Linklaters Business Services t/a CreateiQ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+## Project Description
+
+A library for comparing two HTML files/snippets and highlighting the differences using simple HTML.
+
+This HTML Diff implementation is a TypeScript port of the C# port found [here](https://github.com/Rohland/htmldiff.net), which is a port of the ruby implementation found [here](https://github.com/myobie/htmldiff).

package/biome.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 120,
+    "attributePosition": "auto"
+  },
+  "organizeImports": { "enabled": true },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "suspicious": {
+        "noConfusingVoidType": "off"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "jsxQuoteStyle": "double",
+      "quoteProperties": "asNeeded",
+      "trailingCommas": "es5",
+      "semicolons": "asNeeded",
+      "arrowParentheses": "asNeeded",
+      "bracketSpacing": true,
+      "bracketSameLine": false,
+      "quoteStyle": "single",
+      "attributePosition": "auto"
+    }
+  },
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true,
+    "defaultBranch": "main"
+  }
+}