feat: configurable contentPreservingTags

Author: t7ru

README.md

@@ -11,7 +11,7 @@ You can find a live demo [here](https://wikistxr.t7ru.link/).
 - Very fast!
 - Easily portable to every modern browser environments.
 - Wikitext-aware tokenization (templates, links, tables, comments, tags, magic words, etc.).
-- Configurable protocols, redirect keywords, and extension tags.
+- Configurable protocols, redirect keywords, extension tags, etc.
 - HTML output with granular CSS classes (`getDefaultStyles()` provided).
 - Incremental mode caches line tokens and state for fast live editing.
 
@@ -48,10 +48,11 @@ document.head.appendChild(styleTag);
 
 ### Configuration
 ```typescript
-const editor = new WikitextEditor({
+const highlighter = new WikitextHighlighter({
   urlProtocols: /^(?:http|https|mailto)/i,
   redirectKeywords: ['REDIRECT', 'RINVIA'],
-  extensionTags: ['nowiki', 'ref', 'gallery']
+  extensionTags: ['nowiki', 'ref', 'gallery'],
+  contentPreservingTags: ['nowiki', 'pre', 'tabber']
 });
 ```
 

src/lib/constants.ts

@@ -32,7 +32,7 @@ export const DEFAULT_EXTENSION_TAGS = [
   "source",
 ];
 
-export const CONTENT_PRESERVING_TAGS = [
+export const DEFAULT_CONTENT_PRESERVING_TAGS = [
   "nowiki",
   "pre",
   "syntaxhighlight",
@@ -75,7 +75,7 @@ const generateSectionStyles = () => {
 };
 
 const generateExtensionTagStyles = () => {
-  return CONTENT_PRESERVING_TAGS.map(
+  return DEFAULT_CONTENT_PRESERVING_TAGS.map(
     (tag) => `.wt-ext-${tag} { background-color: ${COLORS.lightGrayBg}; }`
   ).join("\n  ");
 };

src/lib/highlighter.ts

@@ -9,7 +9,7 @@ import {
   DEFAULT_URL_PROTOCOLS,
   DEFAULT_REDIRECT_KEYWORDS,
   DEFAULT_EXTENSION_TAGS,
-  CONTENT_PRESERVING_TAGS,
+  DEFAULT_CONTENT_PRESERVING_TAGS,
   DEFAULT_STYLES
 } from './constants';
 import { createSpan } from './utils';
@@ -26,6 +26,7 @@ export class WikitextHighlighter {
   protected urlProtocols: RegExp;
   protected redirectRegex: RegExp;
   protected extensionTags: string[];
+  protected contentPreservingTags: string[];
   protected tokenizer: WikitextTokenizer;
 
   constructor(config: HighlightConfig = {}) {
@@ -36,11 +37,12 @@ export class WikitextHighlighter {
       'i'
     );
     this.extensionTags = config.extensionTags || DEFAULT_EXTENSION_TAGS;
+    this.contentPreservingTags = config.contentPreservingTags || DEFAULT_CONTENT_PRESERVING_TAGS;
     this.tokenizer = new WikitextTokenizer(
       this.urlProtocols,
       this.redirectRegex,
       this.extensionTags,
-      CONTENT_PRESERVING_TAGS
+      this.contentPreservingTags
     );
   }
 

src/lib/index.ts

@@ -8,5 +8,6 @@ export {
   DEFAULT_URL_PROTOCOLS,
   DEFAULT_REDIRECT_KEYWORDS,
   DEFAULT_EXTENSION_TAGS,
+  DEFAULT_CONTENT_PRESERVING_TAGS,
   DEFAULT_STYLES,
 } from "./constants";

src/lib/types.ts

@@ -11,6 +11,7 @@ export interface HighlightConfig {
   urlProtocols?: RegExp;
   redirectKeywords?: string[];
   extensionTags?: string[];
+  contentPreservingTags?: string[];
 }
 
 export interface ClosingResult {