issues #1, #2

Author: wibblemonkey

CHANGELOG.md

@@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2018-12-02
+
+- Added support for Azure DevOps Wiki style `[[_TOC_]]` token - [Issue #2](https://github.com/wibblemonkey/vscode-markdown-auto-toc/issues/2)
+- Fixed issue with HTML/Markdown tokens leaking into table of contents items - [Issue #1](https://github.com/wibblemonkey/vscode-markdown-auto-toc/issues/1)
+
 ## [0.2.0] - 2018-11-28
 
 ### Changed

README.md

@@ -14,17 +14,21 @@ for the table of contents itself and override the default HTML class applied to
 the `<div/>` container elements for both the table of contents and the title
 header.
 
+The extension also supports the Azure DevOps Wiki style table of contents token
+`[[_TOC_]]`. This is enabled by default but can be turned off if desired.
+
 ## Extension Settings
 
 This extension contributes the following settings:
 
-Name                                  | Default Value        | Description
---------------------------------------|----------------------|------------------------------------------------------------------------------------
-`markdownAutoTOC.maximumHeadingLevel` | 2                    | The maximum heading level to include in the generated table of contents
-`markdownAutoTOC.containerClass`      | toc-container        | The HTML class to apply to the generated `<div/>` for the table of contents.
-`markdownAutoTOC.header`              | true                 | Include a heading above the generated table of contents.
-`markdownAutoTOC.headerClass`         | toc-container-header | The HTML class to apply to the generated `<div/>` for the table of contents header.
-`markdownAutoTOC.headerContent`       | Contents             | The header text to display above the table of contents.
+Name                                                 | Default Value        | Description
+-----------------------------------------------------|----------------------|------------------------------------------------------------------------------------
+`markdownAutoTOC.maximumHeadingLevel`                | 2                    | The maximum heading level to include in the generated table of contents
+`markdownAutoTOC.containerClass`                     | toc-container        | The HTML class to apply to the generated `<div/>` for the table of contents.
+`markdownAutoTOC.header`                             | true                 | Include a heading above the generated table of contents.
+`markdownAutoTOC.headerClass`                        | toc-container-header | The HTML class to apply to the generated `<div/>` for the table of contents header.
+`markdownAutoTOC.headerContent`                      | Contents             | The header text to display above the table of contents.
+`markdownAutoTOC.enableAzureDevOpsWikiCompatibility` | true                 | Allow `[[_TOC_]]` as the token to generate the table of contents.
 
 ## Known Issues
 

extension.js

@@ -2,6 +2,8 @@
 
 const vscode = require('vscode');
 const htmlEncode = require('js-htmlencode').htmlEncode;
+const removeMarkdown = require('remove-markdown');
+const striptags = require('striptags');
 
 const validHtmlClass = /^[a-z][a-z0-9_-]*$/i;
 
@@ -25,6 +27,8 @@ function buildMarkdownItTableOfContentsOptions(configuration) {
     options["includeLevel"] = buildIncludeLevelOptionFromConfiguration(configuration);
     options["containerClass"] = buildContainerClassOptionFromConfiguration(configuration);
     options["containerHeaderHtml"] = buildContainerHeaderHtmlOptionFromConfiguration(configuration);
+    options["markerPattern"] = buildMarkerPatternOptionFromConfiguration(configuration);
+    options["format"] = sanitizeHeading;
 
     return options;
 }
@@ -45,3 +49,12 @@ function buildContainerHeaderHtmlOptionFromConfiguration(configuration) {
     }
     return option;
 }
+
+function buildMarkerPatternOptionFromConfiguration(configuration) {
+    var token = configuration.enableAzureDevOpsWikiCompatibility ? "(toc|_toc_)" : "toc";
+    return new RegExp(`^\\[\\[${token}\\]\\]`, "im");
+}
+
+function sanitizeHeading(heading) {
+    return removeMarkdown(striptags(heading));
+}

package-lock.json

@@ -2,7 +2,7 @@
     "name": "markdown-auto-toc",
     "displayName": "Markdown AutoTOC",
     "description": "Adds support for inserting an auto-generated table of contents to VS Code's built-in markdown preview using the [[TOC]] syntax.",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "publisher": "wibblemonkey",
     "keywords": [
         "markdown",
@@ -75,6 +75,11 @@
                     "type": "string",
                     "default": "Contents",
                     "description": "The header text to display above the table of contents."
+                },
+                "markdownAutoTOC.enableAzureDevOpsWikiCompatibility": {
+                    "type": "boolean",
+                    "default": true,
+                    "markdownDescription": "Allow `[[_TOC_]]` as the token to generate the table of contents."
                 }
             }
         },
@@ -93,6 +98,8 @@
     },
     "dependencies": {
         "js-htmlencode": "^0.3.0",
-        "markdown-it-table-of-contents": "^0.4.3"
+        "markdown-it-table-of-contents": "^0.4.3",
+        "remove-markdown": "^0.3.0",
+        "striptags": "^3.1.1"
     }
 }