BookStack Code Mirror - bookstack/blob - resources/js/services/code.js

   1 import CodeMirror from "codemirror";
   2 import Clipboard from "clipboard/dist/clipboard.min";
   3
   4 // Modes
   5 import 'codemirror/mode/css/css';
   6 import 'codemirror/mode/clike/clike';
   7 import 'codemirror/mode/diff/diff';
   8 import 'codemirror/mode/go/go';
   9 import 'codemirror/mode/htmlmixed/htmlmixed';
  10 import 'codemirror/mode/javascript/javascript';
  11 import 'codemirror/mode/julia/julia';
  12 import 'codemirror/mode/lua/lua';
  13 import 'codemirror/mode/haskell/haskell';
  14 import 'codemirror/mode/markdown/markdown';
  15 import 'codemirror/mode/mllike/mllike';
  16 import 'codemirror/mode/nginx/nginx';
  17 import 'codemirror/mode/php/php';
  18 import 'codemirror/mode/powershell/powershell';
  19 import 'codemirror/mode/properties/properties';
  20 import 'codemirror/mode/python/python';
  21 import 'codemirror/mode/ruby/ruby';
  22 import 'codemirror/mode/rust/rust';
  23 import 'codemirror/mode/shell/shell';
  24 import 'codemirror/mode/sql/sql';
  25 import 'codemirror/mode/toml/toml';
  26 import 'codemirror/mode/xml/xml';
  27 import 'codemirror/mode/yaml/yaml';
  28
  29 // Addons
  30 import 'codemirror/addon/scroll/scrollpastend';
  31
  32 const modeMap = {
  33     css: 'css',
  34     c: 'text/x-csrc',
  35     java: 'text/x-java',
  36     scala: 'text/x-scala',
  37     kotlin: 'text/x-kotlin',
  38     'c++': 'text/x-c++src',
  39     'c#': 'text/x-csharp',
  40     csharp: 'text/x-csharp',
  41     diff: 'diff',
  42     go: 'go',
  43     haskell: 'haskell',
  44     hs: 'haskell',
  45     html: 'htmlmixed',
  46     ini: 'ini',
  47     javascript: 'javascript',
  48     json: {name: 'javascript', json: true},
  49     js: 'javascript',
  50     jl: 'julia',
  51     julia: 'julia',
  52     lua: 'lua',
  53     md: 'markdown',
  54     mdown: 'markdown',
  55     markdown: 'markdown',
  56     ml: 'mllike',
  57     nginx: 'nginx',
  58     powershell: 'powershell',
  59     properties: 'properties',
  60     ocaml: 'mllike',
  61     php: 'php',
  62     py: 'python',
  63     python: 'python',
  64     ruby: 'ruby',
  65     rust: 'rust',
  66     rb: 'ruby',
  67     rs: 'rust',
  68     shell: 'shell',
  69     sh: 'shell',
  70     bash: 'shell',
  71     toml: 'toml',
  72     sql: 'text/x-sql',
  73     xml: 'xml',
  74     yaml: 'yaml',
  75     yml: 'yaml',
  76 };
  77
  78 /**
  79  * Highlight pre elements on a page
  80  */
  81 function highlight() {
  82     let codeBlocks = document.querySelectorAll('.page-content pre, .comment-box .content pre');
  83     for (let i = 0; i < codeBlocks.length; i++) {
  84         highlightElem(codeBlocks[i]);
  85     }
  86 }
  87
  88 /**
  89  * Add code highlighting to a single element.
  90  * @param {HTMLElement} elem
  91  */
  92 function highlightElem(elem) {
  93     let innerCodeElem = elem.querySelector('code[class^=language-]');
  94     let mode = '';
  95     if (innerCodeElem !== null) {
  96         let langName = innerCodeElem.className.replace('language-', '');
  97         mode = getMode(langName);
  98     }
  99     elem.innerHTML = elem.innerHTML.replace(/<br\s*[\/]?>/gi ,'\n');
 100     let content = elem.textContent.trim();
 101
 102     let cm = CodeMirror(function(elt) {
 103         elem.parentNode.replaceChild(elt, elem);
 104     }, {
 105         value: content,
 106         mode:  mode,
 107         lineNumbers: true,
 108         theme: getTheme(),
 109         readOnly: true
 110     });
 111
 112     addCopyIcon(cm);
 113 }
 114
 115 /**
 116  * Add a button to a CodeMirror instance which copies the contents to the clipboard upon click.
 117  * @param cmInstance
 118  */
 119 function addCopyIcon(cmInstance) {
 120     const copyIcon = `<svg viewBox="0 0 24 24" width="16" height="16" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"/><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`;
 121     const copyButton = document.createElement('div');
 122     copyButton.classList.add('CodeMirror-copy');
 123     copyButton.innerHTML = copyIcon;
 124     cmInstance.display.wrapper.appendChild(copyButton);
 125
 126     const clipboard = new Clipboard(copyButton, {
 127         text: function(trigger) {
 128             return cmInstance.getValue()
 129         }
 130     });
 131
 132     clipboard.on('success', event => {
 133         copyButton.classList.add('success');
 134         setTimeout(() => {
 135             copyButton.classList.remove('success');
 136         }, 240);
 137     });
 138 }
 139
 140 /**
 141  * Search for a codemirror code based off a user suggestion
 142  * @param suggestion
 143  * @returns {string}
 144  */
 145 function getMode(suggestion) {
 146     suggestion = suggestion.trim().replace(/^\./g, '').toLowerCase();
 147     return (typeof modeMap[suggestion] !== 'undefined') ? modeMap[suggestion] : '';
 148 }
 149
 150 /**
 151  * Ge the theme to use for CodeMirror instances.
 152  * @returns {*|string}
 153  */
 154 function getTheme() {
 155     return window.codeTheme || 'base16-light';
 156 }
 157
 158 /**
 159  * Create a CodeMirror instance for showing inside the WYSIWYG editor.
 160  *  Manages a textarea element to hold code content.
 161  * @param {HTMLElement} elem
 162  * @returns {{wrap: Element, editor: *}}
 163  */
 164 function wysiwygView(elem) {
 165     let doc = elem.ownerDocument;
 166     let codeElem = elem.querySelector('code');
 167
 168     let lang = (elem.className || '').replace('language-', '');
 169     if (lang === '' && codeElem) {
 170         lang = (codeElem.className || '').replace('language-', '')
 171     }
 172
 173     elem.innerHTML = elem.innerHTML.replace(/<br\s*[\/]?>/gi ,'\n');
 174     let content = elem.textContent;
 175     let newWrap = doc.createElement('div');
 176     let newTextArea = doc.createElement('textarea');
 177
 178     newWrap.className = 'CodeMirrorContainer';
 179     newWrap.setAttribute('data-lang', lang);
 180     newWrap.setAttribute('dir', 'ltr');
 181     newTextArea.style.display = 'none';
 182     elem.parentNode.replaceChild(newWrap, elem);
 183
 184     newWrap.appendChild(newTextArea);
 185     newWrap.contentEditable = false;
 186     newTextArea.textContent = content;
 187
 188     let cm = CodeMirror(function(elt) {
 189         newWrap.appendChild(elt);
 190     }, {
 191         value: content,
 192         mode:  getMode(lang),
 193         lineNumbers: true,
 194         theme: getTheme(),
 195         readOnly: true
 196     });
 197     setTimeout(() => {
 198         cm.refresh();
 199     }, 300);
 200     return {wrap: newWrap, editor: cm};
 201 }
 202
 203 /**
 204  * Create a CodeMirror instance to show in the WYSIWYG pop-up editor
 205  * @param {HTMLElement} elem
 206  * @param {String} modeSuggestion
 207  * @returns {*}
 208  */
 209 function popupEditor(elem, modeSuggestion) {
 210     let content = elem.textContent;
 211
 212     return CodeMirror(function(elt) {
 213         elem.parentNode.insertBefore(elt, elem);
 214         elem.style.display = 'none';
 215     }, {
 216         value: content,
 217         mode:  getMode(modeSuggestion),
 218         lineNumbers: true,
 219         theme: getTheme(),
 220         lineWrapping: true
 221     });
 222 }
 223
 224 /**
 225  * Set the mode of a codemirror instance.
 226  * @param cmInstance
 227  * @param modeSuggestion
 228  */
 229 function setMode(cmInstance, modeSuggestion) {
 230       cmInstance.setOption('mode', getMode(modeSuggestion));
 231 }
 232
 233 /**
 234  * Set the content of a cm instance.
 235  * @param cmInstance
 236  * @param codeContent
 237  */
 238 function setContent(cmInstance, codeContent) {
 239     cmInstance.setValue(codeContent);
 240     setTimeout(() => {
 241         cmInstance.refresh();
 242     }, 10);
 243 }
 244
 245 /**
 246  * Get a CodeMirror instace to use for the markdown editor.
 247  * @param {HTMLElement} elem
 248  * @returns {*}
 249  */
 250 function markdownEditor(elem) {
 251     let content = elem.textContent;
 252
 253     return CodeMirror(function (elt) {
 254         elem.parentNode.insertBefore(elt, elem);
 255         elem.style.display = 'none';
 256     }, {
 257         value: content,
 258         mode: "markdown",
 259         lineNumbers: true,
 260         theme: getTheme(),
 261         lineWrapping: true,
 262         scrollPastEnd: true,
 263     });
 264 }
 265
 266 /**
 267  * Get the 'meta' key dependant on the user's system.
 268  * @returns {string}
 269  */
 270 function getMetaKey() {
 271     let mac = CodeMirror.keyMap["default"] == CodeMirror.keyMap.macDefault;
 272     return mac ? "Cmd" : "Ctrl";
 273 }
 274
 275 export default {
 276     highlight: highlight,
 277     wysiwygView: wysiwygView,
 278     popupEditor: popupEditor,
 279     setMode: setMode,
 280     setContent: setContent,
 281     markdownEditor: markdownEditor,
 282     getMetaKey: getMetaKey,
 283 };