aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/apps/documentation/utils.ts
blob: 114c670ee6e7228876cd7006601b3eacaaaa6e58 (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
/*
 * SonarQube
 * Copyright (C) 2009-2018 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.
 */
export interface DocumentationEntry {
  children: DocumentationEntry[];
  name: string;
  order: string;
  relativeName: string;
  scope?: 'sonarcloud';
  title: string;
}

export function activeOrChildrenActive(root: string, entry: DocumentationEntry) {
  return root.indexOf(getEntryRoot(entry.relativeName)) === 0;
}

export function getEntryRoot(name: string) {
  if (name.endsWith('index')) {
    return name
      .split('/')
      .slice(0, -1)
      .join('/');
  }
  return name;
}

export function getEntryChildren(entries: DocumentationEntry[], root?: string) {
  return entries.filter(entry => {
    const parts = entry.relativeName.split('/');
    const depth = root ? root.split('/').length : 0;
    return (
      (!root || entry.relativeName.indexOf(root) === 0) &&
      ((parts.length === depth + 1 && parts[depth] !== 'index') || parts[depth + 1] === 'index')
    );
  });
}