nodebb-plugin-markdown 11.0.3 → 12.0.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, highlightLinesLanguageList } = 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,
+			highlightLinesLanguageList,
+			hljsLanguages,
 			theme: highlightTheme || 'default.css',
 			defaultHighlightLanguage: defaultHighlightLanguage || '',
 		};
@@ -79,7 +86,6 @@ const Markdown = {
 
 			langPrefix: 'language-',
 			highlight: true,
-			highlightLinesLanguageList: [],
 			highlightTheme: 'default.css',
 
 			probe: true,
@@ -95,7 +101,7 @@ const Markdown = {
 			checkboxes: true,
 			multimdTables: true,
 		};
-		const notCheckboxes = ['langPrefix', 'highlightTheme', 'highlightLinesLanguageList', 'probeCacheSize'];
+		const notCheckboxes = ['langPrefix', 'highlightTheme', 'probeCacheSize'];
 
 		meta.settings.get('markdown', (err, options) => {
 			if (err) {
@@ -116,17 +122,6 @@ const Markdown = {
 			_self.highlight = _self.config.highlight;
 			delete _self.config.highlight;
 
-			if (typeof _self.config.highlightLinesLanguageList === 'string') {
-				try {
-					_self.config.highlightLinesLanguageList = JSON.parse(_self.config.highlightLinesLanguageList);
-				} catch (e) {
-					winston.warn('[plugins/markdown] Invalid config for highlightLinesLanguageList, blanking.');
-					_self.config.highlightLinesLanguageList = [];
-				}
-
-				_self.config.highlightLinesLanguageList = _self.config.highlightLinesLanguageList.join(',').split(',');
-			}
-
 			parser = new MarkdownIt(_self.config);
 
 			Markdown.updateParserRules(parser);

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": "12.0.0",
   "description": "A Markdown parser for NodeBB",
   "main": "index.js",
   "repository": {

package/public/js/admin.js

@@ -16,7 +16,6 @@ define('admin/plugins/markdown', ['settings', 'alerts'], function (Settings, ale
 
 				langPrefix: 'language-',
 				highlight: true,
-				highlightLinesLanguageList: [],
 				highlightTheme: 'default.css',
 
 				probe: true,

package/public/js/client.js

@@ -240,7 +240,55 @@
 
 	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;
+			let aliasMap = new Map();
+			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';
+				}
+			}
+			console.debug(`[plugins/markdown] Loaded ${list} hljs library`);
+
+			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);
+				}));
+			}
+
+			// Build alias set
+			hljs.listLanguages().forEach((language) => {
+				const { aliases } = hljs.getLanguage(language);
+				if (aliases && Array.isArray(aliases)) {
+					aliases.forEach((alias) => {
+						aliasMap.set(alias, language);
+					});
+				}
+
+				aliasMap.set(language, language);
+			});
+
+			console.debug(`[plugins/markdown] Loading support for line numbers`);
 			window.hljs = hljs;
 			require('highlightjs-line-numbers.js');
 
@@ -255,14 +303,16 @@
 				window.hljs.highlightElement(block);
 
 				// Check detected language against whitelist and add lines if enabled
-				if (block.className.split(' ').map(function (className) {
-					if (className.indexOf('language-') === 0) {
-						className = className.slice(9);
+				const classIterator = block.classList.values();
+				for(className of classIterator) {
+					if (className.startsWith('language-')) {
+						const language = className.split('-')[1];
+						if (aliasMap.has(language) && config.markdown.highlightLinesLanguageList.includes(aliasMap.get(language))) {
+							$(block).attr('data-lines', 1);
+							window.hljs.lineNumbersBlock(block);
+						}
+						break;
 					}
-					return config.markdown.highlightLinesLanguageList.includes(className) || config.markdown.highlightLinesLanguageList.includes(className);
-				}).some(Boolean)) {
-					$(block).attr('data-lines', 1);
-					window.hljs.lineNumbersBlock(block);
 				}
 			});
 		}

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

@@ -103,34 +103,37 @@
 								<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">
-									<option value="apache,apacheconf">Apache</option>
-									<option value="bash,sh,zsh">Bash</option>
-									<option value="cs,csharp">C#</option>
-									<option value="cpp,c,cc,h,c++,h++,hpp">C++</option>
-									<option value="css">CSS</option>
-									<option value="coffeescript,coffee,cson,iced">CoffeeScript</option>
-									<option value="diff,patch">Diff</option>
-									<option value="xml,html,xhtml,rss,atom,xjb,xsd,xsl,plist">HTML</option>
-									<option value="http,https">HTTP</option>
-									<option value="ini,toml">Ini</option>
-									<option value="json">JSON</option>
-									<option value="java">Java</option>
-									<option value="javascript,js,jsx">Javascript</option>
-									<option value="makefile,mk,mak">Makefile</option>
-									<option value="markdown,md,mkdown,mkd">Markdown</option>
-									<option value="nginx,nginxconf">Nginx</option>
-									<option value="objectivec,objc,obj-c">Objective C</option>
-									<option value="php,php3,php4,php5,php6">PHP</option>
-									<option value="perl,pl,pm">Perl</option>
-									<option value="python,py,gyp">Python</option>
-									<option value="ruby,rb,gemspec,podspec,thor,irb">Ruby</option>
-									<option value="sql">SQL</option>
-									<option value="shell,console">Shell</option>
+								<select class="form-select" multiple="true" name="highlightLinesLanguageList" id="highlightLinesLanguageList" size="20">
+									{{{ each hljsLanguages }}}
+									<option value="{@value}">{@value}</option>
+									{{{ end }}}
 								</select>
 								<p class="form-text">
 									You can use <code>ctrl</code> and <code>shift</code> to select/deselect multiple