All files / src/pipeline/configuration create-external-specs-list.js

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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/**
 * Creates an HTML list of external specifications based on the provided configuration.
 *
 * @param {object} config - The configuration object containing specification details.
 * @param {Array<object>} config.specs - An array of specification objects.
 * @param {Array<object>} config.specs[].external_specs - An array of external specification objects.
 * @param {string} config.specs[].external_specs[].external_spec - The name of the external specification.
 * @param {string} config.specs[].external_specs[].url - The URL of the external specification.
 * @param {string} config.specs[].external_specs[].gh_page - The GitHub page of the external specification.
 *
 * @returns {string} An HTML string representing the list of external specifications.
 *         Returns a message indicating no specifications were found if the configuration is invalid or empty.
 */
 
const Logger = require('../../utils/logger.js');
 
module.exports = function createExternalSpecsList(config) {
    if (!config?.specs?.length || !Array.isArray(config.specs)) {
        Logger.warn('Invalid config format. Expected an object with a specs array.');
        return '<p>No external specifications found.</p>';
    }
 
    let externalSpecs = [];
    config.specs.forEach(spec => {
        if (spec.external_specs && Array.isArray(spec.external_specs)) {
            externalSpecs = externalSpecs.concat(spec.external_specs);
        }
    });
 
    if (externalSpecs.length === 0) {
        return '<p>No external specifications found.</p>';
    }
 
    let html = '<div class="external-specs-list">';
    html += '<ul class="list-unstyled">';
 
    externalSpecs.forEach(spec => {
        html += `
      <li class="mb-2">
        <div class="d-flex align-items-center">
          <i class="bi bi-diagram-3 me-2"></i>
          <a href="${spec.url}" target="_blank" class="text-decoration-none">${spec.external_spec}</a>
          <a href="${spec.gh_page}" target="_blank" class="ms-2 btn btn-sm btn-light">
            <i class="bi bi-github"></i>
          </a>
        </div>
      </li>
    `;
    });
 
    html += '</ul></div>';
    return html;
};