@shelf/table-of-contents 1.2.0 → 1.3.1

package/lib/default-settings.js

@@ -1,4 +1,4 @@
-import defaults from 'lodash.defaults';
+const DEFAULT_TEMPLATE = '<h<%= level %><%= attrs %>><a href="#<%= anchor %>" name="<%= anchor %>"><wbr /></a><%= header %></h<%= level %>>';
 export const DEFAULT_SETTINGS = {
     // DEFAULTS FOR toc.process()
     //
@@ -15,7 +15,7 @@ export const DEFAULT_SETTINGS = {
     anchorMin: 2,
     anchorMax: 6,
     // Anchorized header template.
-    header: '<h<%= level %><%= attrs %>><a href="#<%= anchor %>" name="<%= anchor %>"><%= header %></a></h<%= level %>>',
+    header: DEFAULT_TEMPLATE,
     // DEFAULTS FOR toc.toc()
     //
     // TOC part templates.
@@ -28,5 +28,5 @@ export const DEFAULT_SETTINGS = {
     TOC: '<div class="toc"><%= toc %></div>',
 };
 export function getSettings(settingsOverride) {
-    return defaults({}, settingsOverride, DEFAULT_SETTINGS);
+    return { ...DEFAULT_SETTINGS, ...settingsOverride };
 }

package/lib/helpers/anchorize.js

@@ -1,9 +1,13 @@
-import template from 'lodash.template';
+import { template } from 'lodash-es';
 import { getSettings } from '../default-settings.js';
 import { untag } from './untag.js';
 import { unique } from './unique.js';
 import { anchor } from './anchor.js';
-import { getDataWithoutNestedAnchors } from './getDataWithoutNestedAnchors.js';
+import { decode } from 'entities';
+function normalizeHeaderText(text) {
+    // Decode HTML entities, convert NBSP to regular spaces, collapse inner whitespace, and trim.
+    return decode(text).replace(/\u00a0/g, ' ').replace(/\s+/g, ' ').trim();
+}
 // Parse HTML, returning an array of header objects and anchorized HTML.
 export function anchorize(src, settingsOverride) {
     // Normalize options and compile template(s).
@@ -19,6 +23,10 @@ export function anchorize(src, settingsOverride) {
         const tocLevel = level >= settingsOverride.tocMin && level <= settingsOverride.tocMax;
         // @ts-ignore
         const anchorLevel = level >= settingsOverride.anchorMin && level <= settingsOverride.anchorMax;
+        const untaggedHeader = untag(header);
+        const decodedHeader = decode(untaggedHeader).replace(/\u00a0/g, ' ');
+        const normalizedText = normalizeHeaderText(untaggedHeader);
+        const anchorSource = normalizedText || decodedHeader.trim() || untaggedHeader || 'section';
         let data;
         if (tocLevel || anchorLevel) {
             // This data is passed into the specified "header" template function.
@@ -30,9 +38,9 @@ export function anchorize(src, settingsOverride) {
                 // Header HTML contents.
                 header: header,
                 // Un-tagged header HTML contents.
-                text: untag(header),
+                text: normalizedText,
                 // Unique anchor name for this header.
-                anchor: unique(names, anchor(header)),
+                anchor: unique(names, anchor(anchorSource)),
                 // All HTML (including tags) matched by the "headers" RegExp.
                 all: all,
             };
@@ -41,7 +49,7 @@ export function anchorize(src, settingsOverride) {
             headers.push(data);
         }
         if (anchorLevel) {
-            return getDataWithoutNestedAnchors(data, headerTemplate);
+            return headerTemplate(data);
         }
         return all;
     });

package/lib/helpers/toc.js

@@ -1,4 +1,4 @@
-import template from 'lodash.template';
+import { template } from 'lodash-es';
 import { getSettings } from '../default-settings.js';
 export function toc(headers, settingsOverride) {
     settingsOverride = getSettings(settingsOverride);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shelf/table-of-contents",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Fork of node-toc to reduce bundle size & rewritten in TypeScript",
   "license": "MIT",
   "author": {
@@ -16,60 +16,57 @@
   "files": [
     "lib"
   ],
-  "scripts": {
-    "build": "rm -rf lib/ && tsc",
-    "coverage": "yarn test --coverage",
-    "lint": "eslint . --ext .js,.ts,.json --fix",
-    "lint:ci": "eslint . --ext .js,.ts,.json",
-    "lint:size": "size-limit",
-    "prepack": "yarn build",
-    "test": "TZ=UTC jest src",
-    "test:watch": "TZ=UTC jest src --watch",
-    "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch"
-  },
-  "lint-staged": {
-    "*.{html,md,yml}": [
-      "prettier --write"
-    ],
-    "*.{js,ts,json}": [
-      "eslint --fix"
-    ]
-  },
   "prettier": "@shelf/prettier-config",
   "dependencies": {
-    "entities": "4.5.0",
-    "lodash.defaults": "4.2.0",
-    "lodash.template": "4.5.0",
-    "slug": "8.2.3"
+    "entities": "5.0.0",
+    "lodash-es": "4.17.21",
+    "slug": "9.1.0"
   },
   "devDependencies": {
-    "@shelf/eslint-config": "3.10.0",
+    "@shelf/eslint-config": "3.15.1",
     "@shelf/prettier-config": "1.0.0",
-    "@shelf/tsconfig": "0.0.11",
-    "@size-limit/esbuild-why": "11.0.0",
-    "@size-limit/preset-small-lib": "11.0.0",
-    "@swc/core": "1.3.96",
-    "@swc/jest": "0.2.29",
-    "@types/jest": "29.5.8",
-    "@types/lodash.defaults": "4.2.9",
-    "@types/lodash.template": "4.5.3",
+    "@shelf/tsconfig": "0.1.0",
+    "@size-limit/esbuild-why": "11.2.0",
+    "@size-limit/preset-small-lib": "11.2.0",
+    "@swc/core": "1.11.8",
+    "@swc/jest": "0.2.37",
+    "@types/jest": "29.5.14",
+    "@types/lodash-es": "4.17.12",
     "@types/node": "20.8.9",
-    "@types/slug": "5.0.7",
-    "eslint": "8.53.0",
-    "husky": "8.0.3",
+    "@types/slug": "5.0.9",
+    "eslint": "8.57.1",
+    "husky": "9.1.7",
     "jest": "29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "lint-staged": "15.1.0",
-    "prettier": "3.1.0",
-    "size-limit": "11.0.0",
+    "lint-staged": "15.5.1",
+    "prettier": "3.5.3",
+    "size-limit": "11.2.0",
     "ts-jest-resolver": "2.0.1",
-    "typescript": "5.2.2"
+    "typescript": "5.8.3"
   },
   "engines": {
     "node": ">=14"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "lint-staged": {
+    "*.{html,md,yml}": [
+      "prettier --write"
+    ],
+    "*.{js,ts,json}": [
+      "eslint --fix"
+    ]
+  },
+  "scripts": {
+    "build": "rm -rf lib/ && tsc",
+    "coverage": "yarn test --coverage",
+    "lint": "eslint . --ext .js,.ts,.json --fix",
+    "lint:ci": "eslint . --ext .js,.ts,.json",
+    "lint:size": "size-limit",
+    "test": "TZ=UTC jest src",
+    "test:watch": "TZ=UTC jest src --watch",
+    "type-check": "tsc --noEmit",
+    "type-check:watch": "npm run type-check -- --watch"
   }
-}
+}

package/.husky/_/husky.sh

@@ -1,29 +0,0 @@
-#!/bin/sh
-if [ -z "$husky_skip_init" ]; then
-  debug () {
-    [ "$HUSKY_DEBUG" = "1" ] && echo "husky (debug) - $1"
-  }
-
-  readonly hook_name="$(basename "$0")"
-  debug "starting $hook_name..."
-
-  if [ "$HUSKY" = "0" ]; then
-    debug "HUSKY env variable is set to 0, skipping hook"
-    exit 0
-  fi
-
-  if [ -f ~/.huskyrc ]; then
-    debug "sourcing ~/.huskyrc"
-    . ~/.huskyrc
-  fi
-
-  export readonly husky_skip_init=1
-  sh -e "$0" "$@"
-  exitCode="$?"
-
-  if [ $exitCode != 0 ]; then
-    echo "husky - $hook_name hook exited with code $exitCode (error)"
-  fi
-
-  exit $exitCode
-fi

package/lib/helpers/getDataWithoutNestedAnchors.d.ts

@@ -1,3 +0,0 @@
-import { type TemplateExecutor } from 'lodash';
-import type { Header } from '../types.js';
-export declare const getDataWithoutNestedAnchors: (data: Header, headerTemplate: TemplateExecutor) => string;

package/lib/helpers/getDataWithoutNestedAnchors.js

@@ -1,23 +0,0 @@
-const parser = new DOMParser();
-const hasAnchorTagsInHeader = (data) => {
-    const doc = parser.parseFromString(data.all, 'text/html');
-    // Extract any existing anchor tags from the header variable
-    const anchorElement = doc.querySelector('a');
-    return anchorElement?.outerHTML;
-};
-export const getDataWithoutNestedAnchors = (data, headerTemplate) => {
-    const results = headerTemplate(data);
-    if (!hasAnchorTagsInHeader(data)) {
-        return results;
-    }
-    // separately parse the results to get the anchor tag
-    const doc = parser.parseFromString(data.all, 'text/html');
-    const anchor = document.createElement('a');
-    anchor.setAttribute('href', `#${data.anchor}`);
-    anchor.setAttribute('name', `${data.anchor}`);
-    anchor.innerHTML = '<wbr>';
-    const headerNode = doc.querySelector(`h${data.level}`);
-    headerNode?.prepend(anchor);
-    const html = doc.body.innerHTML;
-    return html || results;
-};