@adobe/helix-html-pipeline 1.5.5 → 1.5.6

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.5.6](https://github.com/adobe/helix-html-pipeline/compare/v1.5.5...v1.5.6) (2022-05-17)
+
+
+### Bug Fixes
+
+* avoid leading digits in heading ids ([#60](https://github.com/adobe/helix-html-pipeline/issues/60)) ([b2af7bf](https://github.com/adobe/helix-html-pipeline/commit/b2af7bf23f8479ba31c410d5b0a3316bbe071481)), closes [#59](https://github.com/adobe/helix-html-pipeline/issues/59)
+
 ## [1.5.5](https://github.com/adobe/helix-html-pipeline/compare/v1.5.4...v1.5.5) (2022-05-16)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "1.5.5",
+  "version": "1.5.6",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/PipelineContent.d.ts

@@ -10,8 +10,8 @@
  * governing permissions and limitations under the License.
  */
 import {Node} from "unist";
-import GithubSlugger from 'github-slugger';
 import { Root } from 'hast';
+import { IDSlugger } from './utils/id-slugger.js';
 
 declare enum SourceType {
   CONTENT = 'content',
@@ -58,7 +58,7 @@ declare class PipelineContent {
   /**
    * slugger to use for heading id calculations
    */
-  slugger: GithubSlugger;
+  slugger: IDSlugger;
 
   /**
    * document specific metadata

package/src/PipelineContent.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import GithubSlugger from 'github-slugger';
+import { IDSlugger } from './utils/id-slugger.js';
 
 /**
  * State of the pipeline
@@ -22,7 +22,7 @@ export class PipelineContent {
   constructor() {
     Object.assign(this, {
       sourceBus: 'content',
-      slugger: new GithubSlugger(),
+      slugger: new IDSlugger(),
     });
   }
 }

package/src/utils/id-slugger.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2022 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import GithubSlugger from 'github-slugger';
+
+export class IDSlugger {
+  constructor() {
+    this.occurrences = {};
+  }
+
+  /**
+   * Generate a unique slug.
+   * @param  {string} value String of text to slugify
+   * @return {string}       A unique slug string
+   */
+  slug(value) {
+    let id = GithubSlugger.slug(value)
+      // remove leading numbers
+      .replace(/^\d+-+/, '');
+
+    // resolve collisions
+    const original = id;
+    while (id in this.occurrences) {
+      this.occurrences[original] += 1;
+      id = `${original}-${this.occurrences[original]}`;
+    }
+    this.occurrences[id] = 0;
+    return id;
+  }
+}