fix group name with parenthesis causing scrollspy issue

apidoc · Apr 30, 2023 · e19e4c1 · e19e4c1
1 parent 3e0d7a5
commit e19e4c1
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # apiDoc Changelog
 
+### 1.0.2
+
+* Fix group name with parenthesis causing scrollspy error
+
 ### 1.0.1
 
 * fix version number

diff --git a/lib/core/workers/api_group.js b/lib/core/workers/api_group.js
@@ -85,7 +85,8 @@ function postProcess (parsedFiles, filenames, preProcess, packageInfos, source,
 
         // replace invalid chars for id attribute
         const urlSafeUTF8 = /[^-_.~\p{L}\p{N}\p{M}\p{P}\p{S}\p{Z}\p{C}]+/gu;
-        group = group.replace(urlSafeUTF8, '');
+        // also remove parenthesis as they mess with scrollspy.js
+        group = group.replace(urlSafeUTF8, '').replace(/(\(|\))/g, '');
 
         block.local[target] = group;
       }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "apidoc",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "RESTful web API Documentation Generator",
   "author": "Peter Rottmann <rottmann@inveris.de>",
   "license": "MIT",

diff --git a/test/core/worker_api_group_test.js b/test/core/worker_api_group_test.js
@@ -32,7 +32,7 @@ describe('Worker: apiGroup', function () {
 
     const rootBlock = parsedFiles[0][0];
 
-    assert.strictEqual(rootBlock.local.group, 'Category_(official)');
+    assert.strictEqual(rootBlock.local.group, 'Category_official');
     assert.strictEqual(rootBlock.local.groupTitle, 'Category_(official)');
 
     done();