diff options
Diffstat (limited to 'server/sonar-web/config/esbuild-documentation-plugin.js')
-rw-r--r-- | server/sonar-web/config/esbuild-documentation-plugin.js | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/server/sonar-web/config/esbuild-documentation-plugin.js b/server/sonar-web/config/esbuild-documentation-plugin.js new file mode 100644 index 00000000000..57cf43aa919 --- /dev/null +++ b/server/sonar-web/config/esbuild-documentation-plugin.js @@ -0,0 +1,56 @@ +/* + * SonarQube + * Copyright (C) 2009-2021 SonarSource SA + * mailto:info AT sonarsource DOT com + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +const fs = require('fs-extra'); +const path = require('path'); +const glob = require('glob-promise'); + +module.exports = () => ({ + name: 'doc-plugin', + setup({ onLoad }) { + /** + * @param {string} content + * @param {string} root + * @returns {string} + */ + function handleIncludes(content, root) { + return content.replace(/@include (.+)/, (match, p) => { + const filePath = path.join(root, '..', `${p}.md`); + return fs.readFileSync(filePath, 'utf8'); + }); + } + + onLoad({ filter: /\.directory-loader\.js$/ }, async args => { + const root = path.resolve(path.dirname(process.cwd()), './sonar-docs/src/pages'); + + const files = await glob(root + '/**/*.md'); + + const result = files + .map(file => file.substr(root.length + 1)) + .map(file => ({ + path: file.slice(0, -3), + content: handleIncludes(fs.readFileSync(`${root}/${file}`, 'utf8'), root) + })); + + const contents = `module.exports = ${JSON.stringify(result)};`; + + return { contents }; + }); + } +}); |