Remove known plugins + type safety

LeaVerou · DmitrySharabin · commit eedc845504aa · 2025-06-27T01:14:00.000+02:00
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -27,6 +27,10 @@ const config = [
 		languageOptions: {
 			ecmaVersion: 'latest',
 			sourceType: 'module',
+			globals: {
+				...globals.browser,
+				...globals.node,
+			},
 		},
 		rules: {
 			'no-use-before-define': ['warn', { 'functions': false, 'classes': false }],
@@ -152,16 +156,6 @@ const config = [
 			'@typescript-eslint/no-explicit-any': 'off',
 		},
 	},
-	{
-		// Core
-		files: ['src/core/**/*.ts'],
-		languageOptions: {
-			globals: {
-				...globals.browser,
-				...globals.node,
-			},
-		},
-	},
 	{
 		// Browser-specific parts
 		files: ['src/auto-start.ts'],
diff --git a/scripts/build.ts b/scripts/build.ts
@@ -331,7 +331,7 @@ async function buildTypes () {
 	await mkdir('./types');
 
 	// Copy existing type definitions
-	const typeFiles = ['types.d.ts', 'known-plugins.d.ts'];
+	const typeFiles = ['types.d.ts'];
 
 	await Promise.all(
 		typeFiles.map(file => copyFile(path.join(SRC_DIR, file), path.join('./types', file)))
diff --git a/src/core/classes/prism.ts b/src/core/classes/prism.ts
@@ -4,7 +4,6 @@ import { highlightElement } from '../highlight-element';
 import { Registry } from '../registry';
 import { tokenize } from '../tokenize/tokenize';
 import { Hooks } from './hooks';
-import type { KnownPlugins } from '../../known-plugins';
 import type { Grammar } from '../../types';
 import type { HighlightOptions } from '../highlight';
 import type { HighlightAllOptions } from '../highlight-all';
@@ -18,7 +17,7 @@ import type { TokenStream } from './token';
 export default class Prism {
 	hooks = new Hooks();
 	components = new Registry(this);
-	plugins: Partial<Record<string, unknown> & KnownPlugins> = {};
+	plugins: Record<string, unknown> = {};
 
 	/**
 	 * See {@link highlightAll}.
diff --git a/src/known-plugins.d.ts b/src/known-plugins.d.ts
diff --git a/src/languages/markdown.ts b/src/languages/markdown.ts
@@ -3,6 +3,7 @@ import { insertBefore, withoutTokenize } from '../util/language-util';
 import markup from './markup';
 import type { Grammar, GrammarToken, LanguageProto } from '../types';
 import type { Prism } from '../core/prism';
+import type { Autoloader } from '../plugins/autoloader/prism-autoloader';
 
 export default {
 	id: 'markdown',
@@ -360,7 +361,8 @@ export default {
 				const id = `md-${new Date().valueOf()}-${Math.floor(Math.random() * 1e16)}`;
 				env.attributes['id'] = id;
 
-				Prism.plugins.autoloader.loadLanguages(codeLang).then(
+				const autoloader = Prism.plugins.autoloader as Autoloader;
+				autoloader.loadLanguages(codeLang).then(
 					() => {
 						const element = document.getElementById(id);
 						if (element) {
diff --git a/src/plugins/autoloader/prism-autoloader.ts b/src/plugins/autoloader/prism-autoloader.ts
@@ -146,7 +146,8 @@ export default {
 				return;
 			}
 
-			Prism.plugins.autoloader.loadLanguages(deps).then(
+			const autoloader = Prism.plugins.autoloader as Autoloader;
+			autoloader.loadLanguages(deps).then(
 				() => Prism.highlightElement(element),
 				(reason) => {
 					console.error(`Failed to load languages (${deps.join(', ')}): ${String(reason)}`);
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,5 +1,6 @@
 import toolbar from '../toolbar/prism-toolbar';
 import type { PluginProto } from '../../types';
+import type { Toolbar } from '../toolbar/prism-toolbar';
 
 interface CopyInfo {
 	getText: () => string;
@@ -118,8 +119,7 @@ export default {
 	id: 'copy-to-clipboard',
 	require: toolbar,
 	effect(Prism) {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		const toolbar = Prism.plugins.toolbar!;
+		const toolbar = Prism.plugins.toolbar as Toolbar;
 
 		return toolbar.registerButton('copy-to-clipboard', (env) => {
 			const element = env.element;
diff --git a/src/plugins/custom-class/prism-custom-class.ts b/src/plugins/custom-class/prism-custom-class.ts
@@ -53,7 +53,7 @@ export default {
 		return new CustomClass();
 	},
 	effect(Prism) {
-		const customClass = Prism.plugins.customClass;
+		const customClass = Prism.plugins.customClass as CustomClass;
 
 		return Prism.hooks.add('wrap', (env) => {
 			if (customClass['adder']) {
diff --git a/src/plugins/download-button/prism-download-button.ts b/src/plugins/download-button/prism-download-button.ts
@@ -1,13 +1,13 @@
 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 {
 	id: 'download-button',
 	require: toolbar,
 	effect(Prism) {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		const toolbar = Prism.plugins.toolbar!;
+		const toolbar = Prism.plugins.toolbar as Toolbar;
 
 		return toolbar.registerButton('download-file', (env) => {
 			const pre = getParentPre(env.element);
diff --git a/src/plugins/file-highlight/prism-file-highlight.ts b/src/plugins/file-highlight/prism-file-highlight.ts
@@ -1,6 +1,7 @@
 import { setLanguage } from '../../shared/dom-util';
 import type { Prism } from '../../core';
 import type { PluginProto } from '../../types';
+import type { Autoloader } from '../autoloader/prism-autoloader';
 
 const FAILURE_MESSAGE = (status: number, message: string) => {
 	return `✖ Error ${status} while fetching file: ${message}`;
@@ -145,7 +146,7 @@ export default {
 				setLanguage(pre, language);
 
 				// preload the language
-				const autoloader = Prism.plugins.autoloader;
+				const autoloader = Prism.plugins.autoloader as Autoloader;
 				if (autoloader) {
 					autoloader.preloadLanguages(language);
 				}
diff --git a/src/plugins/filter-highlight-all/prism-filter-highlight-all.ts b/src/plugins/filter-highlight-all/prism-filter-highlight-all.ts
@@ -101,7 +101,7 @@ export default {
 		return config;
 	},
 	effect(Prism) {
-		const config = Prism.plugins.filterHighlightAll;
+		const config = Prism.plugins.filterHighlightAll as FilterHighlightAll;
 
 		return Prism.hooks.add('before-all-elements-highlight', (env) => {
 			env.elements = env.elements.filter((e: Element) => config.everyFilter(e));
diff --git a/src/plugins/jsonp-highlight/prism-jsonp-highlight.ts b/src/plugins/jsonp-highlight/prism-jsonp-highlight.ts
@@ -1,5 +1,6 @@
 import type { Prism } from '../../core';
 import type { PluginProto } from '../../types';
+import type { Autoloader } from '../autoloader/prism-autoloader';
 
 function getGlobal(): Record<string, unknown> {
 	return typeof window === 'object' ? window as never : {};
@@ -241,7 +242,7 @@ export default {
 		return config;
 	},
 	effect(Prism) {
-		const config = Prism.plugins.jsonpHighlight;
+		const config = Prism.plugins.jsonpHighlight as JsonpHighlight;
 
 
 		const LOADING_MESSAGE = 'Loading…';
@@ -282,7 +283,7 @@ export default {
 				code.className = 'language-' + language;
 
 				// preload the language
-				const autoloader = Prism.plugins.autoloader;
+				const autoloader = Prism.plugins.autoloader as Autoloader;
 				if (autoloader) {
 					autoloader.preloadLanguages(language);
 				}
diff --git a/src/plugins/line-highlight/prism-line-highlight.ts b/src/plugins/line-highlight/prism-line-highlight.ts
@@ -3,6 +3,7 @@ import { combineCallbacks } from '../../util/combine-callbacks';
 import { lazy, noop } from '../../shared/util';
 import type { Prism } from '../../core';
 import type { PluginProto } from '../../types';
+import type { LineNumbers } from '../line-numbers/prism-line-numbers';
 
 const LINE_NUMBERS_CLASS = 'line-numbers';
 const LINKABLE_LINE_NUMBERS_CLASS = 'linkable-line-numbers';
@@ -126,8 +127,9 @@ export class LineHighlight {
 
 			// if the line-numbers plugin is enabled, then there is no reason for this plugin to display the line numbers
 			if (hasLineNumbers && this.Prism.plugins.lineNumbers) {
-				const startNode = this.Prism.plugins.lineNumbers.getLine(pre, start);
-				const endNode = this.Prism.plugins.lineNumbers.getLine(pre, end);
+				const lineNumbers = this.Prism.plugins.lineNumbers as LineNumbers;
+				const startNode = lineNumbers.getLine(pre, start);
+				const endNode = lineNumbers.getLine(pre, end);
 
 				if (startNode) {
 					const top = `${startNode.offsetTop + codePreOffset}px`;
@@ -185,7 +187,8 @@ export class LineHighlight {
 			const start = parseInt(pre.getAttribute('data-start') || '1');
 
 			// iterate all line number spans
-			this.Prism.plugins.lineNumbers.getLines(pre)?.forEach((lineSpan, i) => {
+			const lineNumbers = this.Prism.plugins.lineNumbers as LineNumbers;
+			lineNumbers.getLines(pre)?.forEach((lineSpan, i) => {
 				const lineNumber = i + start;
 				lineSpan.onclick = () => {
 					const hash = `${id}.${lineNumber}`;
@@ -266,18 +269,20 @@ export default {
 				pre.setAttribute('data-line', '');
 			}
 
-			const mutateDom = Prism.plugins.lineHighlight.highlightLines(pre, range, 'temporary ');
+			const lineHighlight = Prism.plugins.lineHighlight as LineHighlight;
+			const mutateDom = lineHighlight.highlightLines(pre, range, 'temporary ');
 			mutateDom();
 
-			if (Prism.plugins.lineHighlight.scrollIntoView) {
+			if (lineHighlight.scrollIntoView) {
 				document.querySelector('.temporary.line-highlight')?.scrollIntoView();
 			}
 		};
 		const onResize = () => {
 			$$('pre')
 				.filter(isActiveFor)
 				.map((pre) => {
-					return Prism.plugins.lineHighlight.highlightLines(pre);
+					const lineHighlight = Prism.plugins.lineHighlight as LineHighlight;
+					return lineHighlight.highlightLines(pre);
 				})
 				.forEach(callFunction);
 		};
@@ -326,7 +331,8 @@ export default {
 				clearTimeout(fakeTimer as never);
 			}
 
-			const mutateDom = Prism.plugins.lineHighlight.highlightLines(pre);
+			const lineHighlight = Prism.plugins.lineHighlight as LineHighlight;
+			const mutateDom = lineHighlight.highlightLines(pre);
 			mutateDom();
 			fakeTimer = setTimeout(applyHash, 1);
 		});
diff --git a/src/plugins/line-numbers/prism-line-numbers.ts b/src/plugins/line-numbers/prism-line-numbers.ts
@@ -203,7 +203,8 @@ export default {
 
 		let lastWidth = NaN;
 		const listener = () => {
-			if (Prism.plugins.lineNumbers.assumeViewportIndependence && lastWidth === window.innerWidth) {
+			const lineNumbers = Prism.plugins.lineNumbers as LineNumbers;
+			if (lineNumbers.assumeViewportIndependence && lastWidth === window.innerWidth) {
 				return;
 			}
 			lastWidth = window.innerWidth;
diff --git a/src/plugins/match-braces/prism-match-braces.ts b/src/plugins/match-braces/prism-match-braces.ts
@@ -1,11 +1,12 @@
 import { getParentPre, isActive } from '../../shared/dom-util';
 import type { PluginProto } from '../../types';
+import type { CustomClass } from '../custom-class/prism-custom-class';
 
 export default {
 	id: 'match-braces',
 	effect(Prism) {
 		function mapClassName(name: string) {
-			const customClass = Prism.plugins.customClass;
+			const customClass = Prism.plugins.customClass as CustomClass;
 			if (customClass) {
 				return customClass.apply(name);
 			} else {
diff --git a/src/plugins/normalize-whitespace/prism-normalize-whitespace.ts b/src/plugins/normalize-whitespace/prism-normalize-whitespace.ts
@@ -159,7 +159,7 @@ export default {
 		});
 	},
 	effect(Prism) {
-		const Normalizer = Prism.plugins.normalizeWhitespace;
+		const Normalizer = Prism.plugins.normalizeWhitespace as NormalizeWhitespace;
 
 		return Prism.hooks.add('before-sanity-check', (env) => {
 			if (!env.code) {
diff --git a/src/plugins/previewers/prism-previewers.ts b/src/plugins/previewers/prism-previewers.ts
@@ -718,7 +718,8 @@ export default {
 		*/
 
 		return Prism.hooks.add('after-highlight', (env) => {
-			Prism.plugins.previewers.initEvents(env.element, env.language);
+			const previewers = Prism.plugins.previewers as PreviewerCollection;
+			previewers.initEvents(env.element, env.language);
 		});
 	}
 } as PluginProto<'previewers'>;
diff --git a/src/plugins/show-language/prism-show-language.ts b/src/plugins/show-language/prism-show-language.ts
@@ -2,13 +2,13 @@ import { getParentPre } from '../../shared/dom-util';
 import { getTitle } from '../../shared/meta/title-data';
 import toolbar from '../toolbar/prism-toolbar';
 import type { PluginProto } from '../../types';
+import type { Toolbar } from '../toolbar/prism-toolbar';
 
 export default {
 	id: 'show-language',
 	require: toolbar,
 	effect(Prism) {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		const toolbar = Prism.plugins.toolbar!;
+		const toolbar = Prism.plugins.toolbar as Toolbar;
 
 		return toolbar.registerButton('show-language', (env) => {
 			const pre = getParentPre(env.element);
diff --git a/src/plugins/toolbar/prism-toolbar.ts b/src/plugins/toolbar/prism-toolbar.ts
@@ -201,6 +201,7 @@ export default {
 		return toolbar;
 	},
 	effect(Prism) {
-		return Prism.hooks.add('complete', Prism.plugins.toolbar.hook);
+		const toolbar = Prism.plugins.toolbar as Toolbar;
+		return Prism.hooks.add('complete', toolbar.hook);
 	}
 } as PluginProto<'toolbar'>;
diff --git a/src/types.d.ts b/src/types.d.ts
@@ -1,6 +1,5 @@
 import type { Prism } from './core/prism';
 import type { TokenStream } from './core/classes/token';
-import type { KnownPlugins } from './known-plugins';
 
 export interface GrammarOptions {
 	readonly getLanguage: (id: string) => Grammar;
@@ -18,9 +17,7 @@ export interface LanguageProto<Id extends string = string> extends ComponentProt
 	grammar: Grammar | ((options: GrammarOptions) => Grammar);
 	plugin?: undefined;
 }
-type PluginType<Name extends string> = Name extends keyof KnownPlugins
-	? KnownPlugins[Name]
-	: unknown;
+type PluginType<Name extends string> = unknown;
 export interface PluginProto<Id extends string = string> extends ComponentProtoBase<Id> {
 	grammar?: undefined;
 	plugin?: (
diff --git a/tests/plugins/custom-class/basic-functionality.ts b/tests/plugins/custom-class/basic-functionality.ts

Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,8 @@ export default {`
`146`	`146`	`return;`
`147`	`147`	`}`
`148`	`148`
`149`		`- Prism.plugins.autoloader.loadLanguages(deps).then(`
	`149`	`+ const autoloader = Prism.plugins.autoloader as Autoloader;`
	`150`	`+ autoloader.loadLanguages(deps).then(`
`150`	`151`	`() => Prism.highlightElement(element),`
`151`	`152`	`(reason) => {`
`152`	`153`	console.error(`Failed to load languages (${deps.join(', ')}): ${String(reason)}`);