[plugins] Automatically attach to the global Prism instance (#3987)

DmitrySharabin · web-flow · commit 3d99da878ce8 · 2025-07-15T16:52:34.000+02:00
* Autolinker

* Autoloader

* Command Line

* Copy to Clipboard

* Custom Class

* Data URI Highlight

* Diff Highlight

* Download Button

* File Highlight

* Filter Highlight All

* Highlight Keywords

* Inline Color

* JSONP Highlight

* Keep Markup

* Line Highlight

* Match Braces

* Normalize Whitespace

* Previewers

* Show Invisibles

* Show Language

* Toolbar

* Treeview Icons

* Unescaped Markup

* WPD
diff --git a/src/plugins/autolinker/prism-autolinker.ts b/src/plugins/autolinker/prism-autolinker.ts
@@ -1,7 +1,8 @@
+import prism from '../../global';
 import { tokenizeStrings } from '../../shared/tokenize-strings';
 import type { PluginProto } from '../../types';
 
-export default {
+const Self = {
 	id: 'autolinker',
 	optional: 'diff-highlight',
 	effect (Prism) {
@@ -41,3 +42,7 @@ export default {
 		});
 	},
 } as PluginProto<'autolinker'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/autoloader/prism-autoloader.ts b/src/plugins/autoloader/prism-autoloader.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import { getParentPre } from '../../shared/dom-util';
 import { resolveAlias } from '../../shared/meta/alias-data';
 import { toArray } from '../../util/iterables';
@@ -103,7 +104,7 @@ export class Autoloader {
 	}
 }
 
-export default {
+const Self = {
 	id: 'autoloader',
 	plugin (Prism) {
 		return new Autoloader(Prism);
@@ -167,3 +168,7 @@ export default {
 		});
 	},
 } as PluginProto<'autoloader'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/command-line/prism-command-line.ts b/src/plugins/command-line/prism-command-line.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import { getParentPre } from '../../shared/dom-util';
 import { htmlEncode } from '../../shared/util';
 import type { PluginProto } from '../../types';
@@ -12,7 +13,7 @@ interface CommandLineInfo {
 	continuationLineIndicies?: Set<number>;
 }
 
-export default {
+const Self = {
 	id: 'command-line',
 	effect (Prism) {
 		return Prism.hooks.add({
@@ -209,3 +210,7 @@ export default {
 		});
 	},
 } as PluginProto<'command-line'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/copy-to-clipboard/prism-copy-to-clipboard.ts b/src/plugins/copy-to-clipboard/prism-copy-to-clipboard.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import toolbar from '../toolbar/prism-toolbar';
 import type { PluginProto } from '../../types';
 import type { Toolbar } from '../toolbar/prism-toolbar';
@@ -119,7 +120,7 @@ function getSettings (startElement: Element) {
 	return settings;
 }
 
-export default {
+const Self = {
 	id: 'copy-to-clipboard',
 	require: toolbar,
 	effect (Prism) {
@@ -171,3 +172,7 @@ export default {
 		});
 	},
 } as PluginProto<'copy-to-clipboard'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/custom-class/prism-custom-class.ts b/src/plugins/custom-class/prism-custom-class.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import type { PluginProto } from '../../types';
 
 type ClassMapper = (className: string) => string;
@@ -47,7 +48,7 @@ export class CustomClass {
 	}
 }
 
-export default {
+const Self = {
 	id: 'custom-class',
 	plugin () {
 		return new CustomClass();
@@ -79,3 +80,7 @@ export default {
 		});
 	},
 } as PluginProto<'custom-class'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/data-uri-highlight/prism-data-uri-highlight.ts b/src/plugins/data-uri-highlight/prism-data-uri-highlight.ts
@@ -1,7 +1,8 @@
+import prism from '../../global';
 import { tokenizeStrings } from '../../shared/tokenize-strings';
 import type { PluginProto } from '../../types';
 
-export default {
+const Self = {
 	id: 'data-uri-highlight',
 	optional: 'diff-highlight',
 	effect (Prism) {
@@ -40,3 +41,7 @@ export default {
 		});
 	},
 } as PluginProto<'data-uri-highlight'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/diff-highlight/prism-diff-highlight.ts b/src/plugins/diff-highlight/prism-diff-highlight.ts
@@ -1,10 +1,11 @@
 import { getTextContent, Token } from '../../core/classes/token';
+import prism from '../../global';
 import diff, { PREFIXES } from '../../languages/diff';
 import type { HookEnv } from '../../core/classes/hooks';
 import type { TokenStream } from '../../core/classes/token';
 import type { PluginProto } from '../../types';
 
-export default {
+const Self = {
 	id: 'diff-highlight',
 	require: diff,
 	effect (Prism) {
@@ -117,3 +118,7 @@ export default {
 		});
 	},
 } as PluginProto<'diff-highlight'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/download-button/prism-download-button.ts b/src/plugins/download-button/prism-download-button.ts
@@ -1,9 +1,10 @@
+import prism from '../../global';
 import { getParentPre } from '../../shared/dom-util';
 import toolbar from '../toolbar/prism-toolbar';
 import type { PluginProto } from '../../types';
 import type { Toolbar } from '../toolbar/prism-toolbar';
 
-export default {
+const Self = {
 	id: 'download-button',
 	require: toolbar,
 	effect (Prism) {
@@ -28,3 +29,7 @@ export default {
 		});
 	},
 } as PluginProto<'download-button'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/file-highlight/prism-file-highlight.ts b/src/plugins/file-highlight/prism-file-highlight.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import { setLanguage } from '../../shared/dom-util';
 import type { Prism } from '../../core';
 import type { PluginProto } from '../../types';
@@ -94,7 +95,7 @@ export class FileHighlight {
 	}
 }
 
-export default {
+const Self = {
 	id: 'file-highlight',
 	plugin (Prism) {
 		return new FileHighlight(Prism);
@@ -215,3 +216,7 @@ export default {
 		});
 	},
 } as PluginProto<'file-highlight'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/filter-highlight-all/prism-filter-highlight-all.ts b/src/plugins/filter-highlight-all/prism-filter-highlight-all.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import { getLanguage } from '../../shared/dom-util';
 import type { PluginProto } from '../../types';
 
@@ -72,7 +73,7 @@ export class FilterHighlightAll {
 	}
 }
 
-export default {
+const Self = {
 	id: 'filter-highlight-all',
 	plugin (Prism) {
 		const config = new FilterHighlightAll();
@@ -108,3 +109,7 @@ export default {
 		});
 	},
 } as PluginProto<'filter-highlight-all'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/highlight-keywords/prism-highlight-keywords.ts b/src/plugins/highlight-keywords/prism-highlight-keywords.ts
@@ -1,6 +1,7 @@
+import prism from '../../global';
 import type { PluginProto } from '../../types';
 
-export default {
+const Self = {
 	id: 'highlight-keywords',
 	effect (Prism) {
 		return Prism.hooks.add('wrap', env => {
@@ -11,3 +12,7 @@ export default {
 		});
 	},
 } as PluginProto<'highlight-keywords'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/inline-color/prism-inline-color.ts b/src/plugins/inline-color/prism-inline-color.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import cssExtras from '../../languages/css-extras';
 import { MARKUP_TAG } from '../../shared/languages/patterns';
 import type { PluginProto } from '../../types';
@@ -65,7 +66,7 @@ function validateColor (color: string) {
 	return s.color ? color : undefined;
 }
 
-export default {
+const Self = {
 	id: 'inline-color',
 	require: cssExtras,
 	effect (Prism) {
@@ -102,3 +103,7 @@ export default {
 		});
 	},
 } as PluginProto<'inline-color'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/jsonp-highlight/prism-jsonp-highlight.ts b/src/plugins/jsonp-highlight/prism-jsonp-highlight.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import type { Prism } from '../../core';
 import type { PluginProto } from '../../types';
 import type { Autoloader } from '../autoloader/prism-autoloader';
@@ -188,7 +189,7 @@ export class JsonpHighlight {
 	}
 }
 
-export default {
+const Self = {
 	id: 'jsonp-highlight',
 	plugin (Prism) {
 		const config = new JsonpHighlight(Prism);
@@ -356,3 +357,7 @@ export default {
 		});
 	},
 } as PluginProto<'jsonp-highlight'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/keep-markup/prism-keep-markup.ts b/src/plugins/keep-markup/prism-keep-markup.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import { isActive } from '../../shared/dom-util';
 import type { PluginProto } from '../../types';
 
@@ -14,7 +15,7 @@ interface NodeData {
 	posClose: number;
 }
 
-export default {
+const Self = {
 	id: 'keep-markup',
 	optional: 'normalize-whitespace',
 	effect (Prism) {
@@ -152,3 +153,7 @@ export default {
 		});
 	},
 } as PluginProto<'keep-markup'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/line-highlight/prism-line-highlight.ts b/src/plugins/line-highlight/prism-line-highlight.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import { isActive } from '../../shared/dom-util';
 import { lazy, noop } from '../../shared/util';
 import { combineCallbacks } from '../../util/combine-callbacks';
@@ -221,7 +222,7 @@ export class LineHighlight {
 	}
 }
 
-export default {
+const Self = {
 	id: 'line-highlight',
 	optional: 'line-numbers',
 	plugin (Prism) {
@@ -352,3 +353,7 @@ export default {
 		return combineCallbacks(removeEventListeners, beforeSanityHook, completeHook);
 	},
 } as PluginProto<'line-highlight'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/match-braces/prism-match-braces.ts b/src/plugins/match-braces/prism-match-braces.ts
@@ -1,8 +1,9 @@
+import prism from '../../global';
 import { getParentPre, isActive } from '../../shared/dom-util';
 import type { PluginProto } from '../../types';
 import type { CustomClass } from '../custom-class/prism-custom-class';
 
-export default {
+const Self = {
 	id: 'match-braces',
 	effect (Prism) {
 		function mapClassName (name: string) {
@@ -202,3 +203,7 @@ export default {
 		});
 	},
 } as PluginProto<'match-braces'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/normalize-whitespace/prism-normalize-whitespace.ts b/src/plugins/normalize-whitespace/prism-normalize-whitespace.ts
@@ -1,3 +1,4 @@
+import prism from '../../global';
 import { getParentPre, isActive } from '../../shared/dom-util';
 import type { PluginProto } from '../../types';
 
@@ -150,7 +151,7 @@ export class NormalizeWhitespace {
 	}
 }
 
-export default {
+const Self = {
 	id: 'normalize-whitespace',
 	optional: 'unescaped-markup',
 	plugin () {
@@ -231,3 +232,7 @@ export default {
 		});
 	},
 } as PluginProto<'normalize-whitespace'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/previewers/prism-previewers.ts b/src/plugins/previewers/prism-previewers.ts
@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import prism from '../../global';
 import cssExtras from '../../languages/css-extras';
 import { forEach } from '../../util/iterables';
 import type { PluginProto } from '../../types';
@@ -199,7 +199,6 @@ export class PreviewerCollection {
 }
 
 // TODO: Filthy hack to be able to load this script
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const Prism = { languages: {} as Record<string, any> };
 
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
@@ -773,7 +772,7 @@ const previewers = {
 /* eslint-enable @typescript-eslint/no-unsafe-assignment */
 /* eslint-enable @typescript-eslint/no-unsafe-member-access */
 
-export default {
+const Self = {
 	id: 'previewers',
 	require: cssExtras,
 	plugin () {
@@ -829,3 +828,7 @@ export default {
 		});
 	},
 } as PluginProto<'previewers'>;
+
+export default Self;
+
+prism.components.add(Self);
diff --git a/src/plugins/show-invisibles/prism-show-invisibles.ts b/src/plugins/show-invisibles/prism-show-invisibles.ts
diff --git a/src/plugins/show-language/prism-show-language.ts b/src/plugins/show-language/prism-show-language.ts
diff --git a/src/plugins/toolbar/prism-toolbar.ts b/src/plugins/toolbar/prism-toolbar.ts
diff --git a/src/plugins/treeview-icons/prism-treeview-icons.ts b/src/plugins/treeview-icons/prism-treeview-icons.ts
diff --git a/src/plugins/unescaped-markup/prism-unescaped-markup.ts b/src/plugins/unescaped-markup/prism-unescaped-markup.ts
diff --git a/src/plugins/wpd/prism-wpd.ts b/src/plugins/wpd/prism-wpd.ts
