aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/config/esbuild-documentation-plugin.js
blob: b1b20ddc98da7d82b19dffff0a13540434c33dbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/*
 * SonarQube
 * Copyright (C) 2009-2022 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 };
    });
  }
});