Run Prettier on plugins + remove .prettierignore + tweak VS Code settings (#3983)

Author: DmitrySharabin

.prettierignore

@@ -1,5 +1,6 @@
 {
 	"editor.formatOnSave": true,
+	"editor.formatOnSaveMode": "file",
 	"editor.defaultFormatter": "esbenp.prettier-vscode",
 	"prettier.enable": true
 }

.vscode/settings.json

@@ -96,8 +96,8 @@
 		"mocha-chai-jest-snapshot": "^1.1.6",
 		"npm-run-all": "^4.1.5",
 		"prettier": "^3.5.3",
-		"prettier-plugin-brace-style": "^0.7.2",
-		"prettier-plugin-merge": "^0.7.3",
+		"prettier-plugin-brace-style": "^0.7.3",
+		"prettier-plugin-merge": "^0.7.4",
 		"prettier-plugin-space-before-function-paren": "^0.0.8",
 		"refa": "^0.9.1",
 		"regexp-ast-analysis": "^0.5.1",

package-lock.json

@@ -1,3 +1,3 @@
 .token a {
 	color: inherit;
-}
+}

package.json

@@ -4,29 +4,29 @@ import type { PluginProto } from '../../types';
 export default {
 	id: 'autolinker',
 	optional: 'diff-highlight',
-	effect(Prism) {
-		function balanced(chars: string) {
+	effect (Prism) {
+		function balanced (chars: string) {
 			return String.raw`(?:${chars}|\((?:${chars})*\))`;
 		}
 
 		const url = RegExp(
-			/\b(?:[a-z]{3,7}:\/\/|tel:)/.source
-			+ `${balanced(/[\w\-+%~/.:=&!$'*,;@]/.source)}+`
-			+ `(?:\\?${balanced(/[\w\-+%~/.:=&!$'*,;@?]/.source)}*)?`
-			+ `(?:#${balanced(/[\w\-+%~/.:=&!$'*,;@?#]/.source)}*)?`
+			/\b(?:[a-z]{3,7}:\/\/|tel:)/.source +
+				`${balanced(/[\w\-+%~/.:=&!$'*,;@]/.source)}+` +
+				`(?:\\?${balanced(/[\w\-+%~/.:=&!$'*,;@?]/.source)}*)?` +
+				`(?:#${balanced(/[\w\-+%~/.:=&!$'*,;@?#]/.source)}*)?`
 		);
 		const email = /\b\S+@[\w.]+[a-z]{2}/;
 
 		const links = {
 			'url-link': url,
-			'email-link': email
+			'email-link': email,
 		};
 
 		return Prism.hooks.add({
-			'after-tokenize': (env) => {
-				tokenizeStrings(env.tokens, (code) => Prism.tokenize(code, links));
+			'after-tokenize': env => {
+				tokenizeStrings(env.tokens, code => Prism.tokenize(code, links));
 			},
-			'wrap': (env) => {
+			'wrap': env => {
 				if (env.type.endsWith('-link')) {
 					let href = env.content;
 
@@ -37,7 +37,7 @@ export default {
 					env.tag = 'a';
 					env.attributes.href = href;
 				}
-			}
+			},
 		});
-	}
+	},
 } as PluginProto<'autolinker'>;

src/plugins/autolinker/prism-autolinker.css

@@ -4,23 +4,26 @@ import { toArray } from '../../util/iterables';
 import type { Prism } from '../../core';
 import type { ComponentProto, PluginProto } from '../../types';
 
-function getDefaultSrcPath() {
+function getDefaultSrcPath () {
 	if (typeof document !== 'undefined') {
 		const script = document.currentScript as HTMLScriptElement | null;
 		if (script) {
-			const autoloaderFile = /\bplugins\/autoloader\/prism-autoloader\.(?:min\.)?js(?:\?[^\r\n/]*)?$/i;
+			const autoloaderFile =
+				/\bplugins\/autoloader\/prism-autoloader\.(?:min\.)?js(?:\?[^\r\n/]*)?$/i;
 			const prismFile = /(^|\/)[\w-]+\.(?:min\.)?m?js(?:\?[^\r\n/]*)?$/i;
 
 			const autoloaderPath = script.getAttribute('data-autoloader-path');
 			if (autoloaderPath != null) {
 				// data-autoloader-path is set, so just use it
 				return autoloaderPath.trim().replace(/\/?$/, '/');
-			} else {
+			}
+			else {
 				const src = script.src;
 				if (autoloaderFile.test(src)) {
 					// the script is the original autoloader script in the usual Prism project structure
 					return src.replace(autoloaderFile, '/');
-				} else if (prismFile.test(src)) {
+				}
+				else if (prismFile.test(src)) {
 					// the script is part of a bundle like a custom prism.js from the download page
 					return src.replace(prismFile, '$1/');
 				}
@@ -31,7 +34,7 @@ function getDefaultSrcPath() {
 	return './';
 }
 
-function pathJoin(dir: string, file: string) {
+function pathJoin (dir: string, file: string) {
 	return dir.replace(/\/$/, '') + '/' + file;
 }
 
@@ -41,7 +44,7 @@ const ignoredLanguages: ReadonlySet<string> = new Set(['none']);
  * @param Prism The Prism instance
  * @param name The name of the language
  */
-function isLoaded(Prism: Prism, name: string) {
+function isLoaded (Prism: Prism, name: string) {
 	// resolve alias
 	const id = resolveAlias(name);
 	return Prism.components.has(id) || ignoredLanguages.has(id);
@@ -56,56 +59,60 @@ export class Autoloader {
 	/**
 	 * @package
 	 */
-	constructor(Prism: Prism) {
+	constructor (Prism: Prism) {
 		this.Prism = Prism;
 	}
 
 	/**
 	 * Loads all given languages concurrently.
 	 */
-	async loadLanguages(languages: string | readonly string[]): Promise<void> {
+	async loadLanguages (languages: string | readonly string[]): Promise<void> {
 		const toLoad = toArray(languages)
 			.map(resolveAlias)
-			.filter((id) => !isLoaded(this.Prism, id));
-
-		await Promise.all(toLoad.map((id) => {
-			const path = pathJoin(this.srcPath, `languages/${id}.js`);
-
-			let promise = this._importCache.get(path);
-			if (promise === undefined) {
-				promise = import(path).then((exports) => {
-					// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-					const proto = exports.default as ComponentProto;
-					this.Prism.components.add(proto);
-				});
-				this._importCache.set(path, promise);
-			}
-			return promise;
-		}));
+			.filter(id => !isLoaded(this.Prism, id));
+
+		await Promise.all(
+			toLoad.map(id => {
+				const path = pathJoin(this.srcPath, `languages/${id}.js`);
+
+				let promise = this._importCache.get(path);
+				if (promise === undefined) {
+					promise = import(path).then(exports => {
+						// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+						const proto = exports.default as ComponentProto;
+						this.Prism.components.add(proto);
+					});
+					this._importCache.set(path, promise);
+				}
+				return promise;
+			})
+		);
 	}
 
 	/**
 	 * Loads all given languages concurrently.
 	 *
 	 * This function simply invokes {@link Autoloader#loadLanguages} and logs errors to `console.error`.
 	 */
-	preloadLanguages(languages: string | readonly string[]): void {
-		this.loadLanguages(languages).catch((reason) => {
-			console.error(`Failed to preload languages (${toArray(languages).join(', ')}): ${String(reason)}`);
+	preloadLanguages (languages: string | readonly string[]): void {
+		this.loadLanguages(languages).catch(reason => {
+			console.error(
+				`Failed to preload languages (${toArray(languages).join(', ')}): ${String(reason)}`
+			);
 		});
 	}
 }
 
 export default {
 	id: 'autoloader',
-	plugin(Prism) {
+	plugin (Prism) {
 		return new Autoloader(Prism);
 	},
-	effect(Prism) {
+	effect (Prism) {
 		/**
 		 * Returns all additional dependencies of the given element defined by the `data-dependencies` attribute.
 		 */
-		function getDependencies(element: Element) {
+		function getDependencies (element: Element) {
 			let deps = element.getAttribute('data-dependencies')?.trim();
 			if (!deps) {
 				const parent = getParentPre(element);
@@ -119,13 +126,15 @@ export default {
 		/**
 		 * Maps the given name to a list of components that have to be loaded.
 		 */
-		function mapDependency(name: string) {
+		function mapDependency (name: string) {
 			if (!name || ignoredLanguages.has(name)) {
 				return [];
-			} else if (/^diff-./i.test(name)) {
+			}
+			else if (/^diff-./i.test(name)) {
 				// the "diff-xxxx" format is used by the Diff Highlight plugin
 				return ['diff', name.slice('diff-'.length)];
-			} else {
+			}
+			else {
 				return [name];
 			}
 		}
@@ -140,7 +149,7 @@ export default {
 				deps.push(...mapDependency(name));
 			}
 
-			deps = deps.filter((name) => !isLoaded(Prism, name));
+			deps = deps.filter(name => !isLoaded(Prism, name));
 			if (deps.length === 0) {
 				// all dependencies are already loaded
 				return;
@@ -149,10 +158,12 @@ export default {
 			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)}`);
+				reason => {
+					console.error(
+						`Failed to load languages (${deps.join(', ')}): ${String(reason)}`
+					);
 				}
 			);
 		});
-	}
+	},
 } as PluginProto<'autoloader'>;

src/plugins/autolinker/prism-autolinker.ts

@@ -16,7 +16,7 @@
 
 .command-line-prompt > span:before {
 	opacity: 0.7;
-	content: ' ';
+	content: " ";
 	display: block;
 	padding-right: 0.8em;
 }