nodebb-plugin-markdown 11.0.3 → 11.1.0

package/index.js

@@ -44,11 +44,18 @@ const Markdown = {
 	},
 
 	getConfig: async (config) => {
-		const { defaultHighlightLanguage, highlightTheme } = await meta.settings.get('markdown');
+		let { defaultHighlightLanguage, highlightTheme, hljsLanguages } = await meta.settings.get('markdown');
+
+		try {
+			hljsLanguages = JSON.parse(hljsLanguages);
+		} catch (e) {
+			hljsLanguages = ['common'];
+		}
 
 		config.markdown = {
 			highlight: Markdown.highlight ? 1 : 0,
 			highlightLinesLanguageList: Markdown.config.highlightLinesLanguageList,
+			hljsLanguages,
 			theme: highlightTheme || 'default.css',
 			defaultHighlightLanguage: defaultHighlightLanguage || '',
 		};

package/lib/controllers.js

@@ -1,12 +1,19 @@
 'use strict';
 
+const path = require('path');
+
 const parent = module.parent.exports;
 const posts = require.main.require('./src/posts');
+const file = require.main.require('./src/file');
 const Controllers = {};
 
-Controllers.renderAdmin = function renderAdmin(req, res) {
+Controllers.renderAdmin = async function renderAdmin(req, res) {
+	let hljsLanguages = await file.walk(path.resolve(require.main.path, 'node_modules/highlight.js/lib/languages'));
+	hljsLanguages = hljsLanguages.map(language => path.basename(language, '.js')).filter(language => !language.endsWith('.js'));
+
 	res.render('admin/plugins/markdown', {
 		themes: parent.themes,
+		hljsLanguages,
 	});
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-markdown",
-  "version": "11.0.3",
+  "version": "11.1.0",
   "description": "A Markdown parser for NodeBB",
   "main": "index.js",
   "repository": {

package/public/js/client.js

@@ -240,7 +240,41 @@
 
 	async function highlight(elements) {
 		if (parseInt(config.markdown.highlight, 10)) {
-			const { default: hljs } = await import('highlight.js/lib/common');
+			console.debug('[plugin/markdown] Initializing highlight.js');
+			let hljs;
+			let list;
+			switch(true) {
+				case config.markdown.hljsLanguages.includes('common'): {
+					({ default: hljs} = await import(`highlight.js/lib/common`));
+					list = 'common';
+					break;
+				}
+
+				case config.markdown.hljsLanguages.includes('all'): {
+					({ default: hljs} = await import(`highlight.js`));
+					list = 'all';
+					break;
+				}
+
+				default: {
+					({ default: hljs} = await import(`highlight.js/lib/core`));
+					list = 'core';
+				}
+			}
+
+			if (list !== 'all') {
+				await Promise.all(config.markdown.hljsLanguages.map(async (language) => {
+					if (['common', 'all'].includes(language)) {
+						return;
+					}
+
+					console.debug(`[plugins/markdown] Loading ${language} support`);
+					const { default: lang } = await import('../../node_modules/highlight.js/lib/languages/' + language + '.js');
+					hljs.registerLanguage(language, lang);
+				}));
+			}
+
+			console.debug(`[plugins/markdown] Loading support for line numbers`);
 			window.hljs = hljs;
 			require('highlightjs-line-numbers.js');
 

package/public/templates/admin/plugins/markdown.tpl

@@ -103,11 +103,34 @@
 								<input class="form-control" placeholder="language-" type="text" name="langPrefix" id="langPrefix" />
 							</div>
 
+							<div class="mb-3">
+								<label class="form-label" for="hljsLanguages">Apply syntax highlighting to the following languages</label>
+								<select class="form-select" multiple="true" name="hljsLanguages" id="hljsLanguages" size="20">
+									<optgroup label="Pre-defined lists">
+										<option value="all">All supported languages (greatest file size)</option>
+										<option value="common" selected>Common languages (a good compromise)</option>
+									</optgroup>
+									<optgroup label="Individual languages">
+										{{{ each hljsLanguages }}}
+										<option value="{@value}">{@value}</option>
+										{{{ end }}}
+									</optgroup>
+								</select>
+								<p class="form-text">
+									You can use <code>ctrl</code> and <code>shift</code> to select/deselect multiple
+									items and select/deselect items in ranges. <em>(Default: "Common languages".)</em>
+								</p>
+								<p class="form-text">
+									You are able to mix and match any of the items above, although "All" will include
+									everything anyway.
+								</p>
+							</div>
+
 							<div class="mb-3">
 								<label class="form-label" for="highlightLinesLanguageList">
 									Enable line numbers for the following languages
 								</label>
-								<select class="form-control" multiple="true" name="highlightLinesLanguageList" id="highlightLinesLanguageList" size="20">
+								<select class="form-select" multiple="true" name="highlightLinesLanguageList" id="highlightLinesLanguageList" size="20">
 									<option value="apache,apacheconf">Apache</option>
 									<option value="bash,sh,zsh">Bash</option>
 									<option value="cs,csharp">C#</option>