Skip to content

Commit fd1563b

Browse files
refactor: use getDevHubUrl & getDocUrl helpers
- Replace all occurrences of `generateDocsHref` with `getDocUrl`, - Replace all occurrences of `generateDevHubHref` with `getDevHubUrl`, - Change import paths from `utils.js` to `dev-hub-url.js`, - Remove all trailing slashes. Fixes #1579
1 parent 76a8962 commit fd1563b

35 files changed

+121
-118
lines changed

.storybook/manager.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import { addons } from 'storybook/manager-api';
33
// eslint-disable-next-line import-x/extensions
44
import { create } from 'storybook/theming';
5-
import { generateDocsHref } from '../src/lib/utils.js';
5+
import { getDocUrl } from '../src/lib/dev-hub-url.js';
66
import { enhanceStoryName } from '../src/stories/lib/story-names.js';
77

88
// We could create an addon to provide a control that would switch between dark / light
@@ -12,7 +12,7 @@ const isDarkMode = window.matchMedia('(prefers-color-scheme: dark)').matches;
1212
const cleverTheme = create({
1313
base: isDarkMode ? 'dark' : 'light',
1414
brandTitle: 'Clever Cloud components',
15-
brandUrl: generateDocsHref(),
15+
brandUrl: getDocUrl(),
1616
brandImage: isDarkMode ? 'imgs/logo-clever-dark.svg' : 'imgs/logo-clever-light.svg',
1717
});
1818

src/components/cc-addon-credentials-beta/cc-addon-credentials-beta.smart-keycloak.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1+
import { getDocUrl } from '../../lib/dev-hub-url.js';
12
import { notifyError, notifySuccess } from '../../lib/notifications.js';
23
import { defineSmartComponent } from '../../lib/smart/define-smart-component.js';
3-
import { generateDocsHref } from '../../lib/utils.js';
44
import { i18n } from '../../translations/translation.js';
55
import '../cc-smart-container/cc-smart-container.js';
66
import { CcAddonCredentialsBetaClient } from './cc-addon-credentials-beta.client.js';
@@ -30,7 +30,7 @@ const LOADING_STATE = {
3030
],
3131
docLink: {
3232
text: i18n('cc-addon-credentials-beta.doc-link.keycloak'),
33-
href: generateDocsHref('/addons/keycloak/#secured-multi-instances'),
33+
href: getDocUrl('/addons/keycloak/#secured-multi-instances'),
3434
},
3535
},
3636
},

src/components/cc-addon-credentials-beta/cc-addon-credentials-beta.smart-otoroshi.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
import { getDocUrl } from '../../lib/dev-hub-url.js';
12
import { fakeString } from '../../lib/fake-strings.js';
23
import { notifyError, notifySuccess } from '../../lib/notifications.js';
34
import { defineSmartComponent } from '../../lib/smart/define-smart-component.js';
4-
import { generateDocsHref } from '../../lib/utils.js';
55
import { i18n } from '../../translations/translation.js';
66
import '../cc-smart-container/cc-smart-container.js';
77
import { CcAddonCredentialsBetaClient } from './cc-addon-credentials-beta.client.js';
@@ -29,7 +29,7 @@ const LOADING_STATE = {
2929
],
3030
docLink: {
3131
text: i18n('cc-addon-credentials-beta.doc-link.otoroshi-ng'),
32-
href: generateDocsHref('/addons/otoroshi/#use-otoroshi-in-a-network-group'),
32+
href: getDocUrl('/addons/otoroshi/#use-otoroshi-in-a-network-group'),
3333
},
3434
},
3535
api: {
@@ -58,7 +58,7 @@ const LOADING_STATE = {
5858
],
5959
docLink: {
6060
text: i18n('cc-addon-credentials-beta.doc-link.otoroshi-api'),
61-
href: generateDocsHref('/addons/otoroshi/#manage-otoroshi-from-its-api'),
61+
href: getDocUrl('/addons/otoroshi/#manage-otoroshi-from-its-api'),
6262
},
6363
},
6464
},

src/components/cc-addon-header/cc-addon-header.smart-keycloak.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1+
import { getDocUrl } from '../../lib/dev-hub-url.js';
12
import { fakeString } from '../../lib/fake-strings.js';
23
import { notify, notifyError } from '../../lib/notifications.js';
34
import { defineSmartComponent } from '../../lib/smart/define-smart-component.js';
4-
import { generateDocsHref } from '../../lib/utils.js';
55
import { i18n } from '../../translations/translation.js';
66
import '../cc-smart-container/cc-smart-container.js';
77
import { CcAddonHeaderClient } from './cc-addon-header.client.js';
88
import './cc-addon-header.js';
99

10-
const DOCS_URL = generateDocsHref(`/addons/keycloak`);
10+
const DOCS_URL = getDocUrl(`/addons/keycloak`);
1111
const PROVIDER_ID = 'keycloak';
1212

1313
/**

src/components/cc-addon-header/cc-addon-header.smart-matomo.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1+
import { getDocUrl } from '../../lib/dev-hub-url.js';
12
import { fakeString } from '../../lib/fake-strings.js';
23
import { notify, notifyError } from '../../lib/notifications.js';
34
import { defineSmartComponent } from '../../lib/smart/define-smart-component.js';
4-
import { generateDocsHref } from '../../lib/utils.js';
55
import { i18n } from '../../translations/translation.js';
66
import '../cc-smart-container/cc-smart-container.js';
77
import { CcAddonHeaderClient } from './cc-addon-header.client.js';
88
import './cc-addon-header.js';
99

10-
const DOCS_URL = generateDocsHref(`/addons/matomo`);
10+
const DOCS_URL = getDocUrl(`/addons/matomo`);
1111
const PROVIDER_ID = 'matomo';
1212

1313
/**

src/components/cc-addon-header/cc-addon-header.smart-metabase.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1+
import { getDocUrl } from '../../lib/dev-hub-url.js';
12
import { fakeString } from '../../lib/fake-strings.js';
23
import { notify, notifyError } from '../../lib/notifications.js';
34
import { defineSmartComponent } from '../../lib/smart/define-smart-component.js';
4-
import { generateDocsHref } from '../../lib/utils.js';
55
import { i18n } from '../../translations/translation.js';
66
import '../cc-smart-container/cc-smart-container.js';
77
import { CcAddonHeaderClient } from './cc-addon-header.client.js';
88
import './cc-addon-header.js';
99

10-
const DOCS_URL = generateDocsHref(`/addons/metabase`);
10+
const DOCS_URL = getDocUrl(`/addons/metabase`);
1111
const PROVIDER_ID = 'metabase';
1212

1313
/**

src/components/cc-addon-header/cc-addon-header.smart-otoroshi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1+
import { getDocUrl } from '../../lib/dev-hub-url.js';
12
import { fakeString } from '../../lib/fake-strings.js';
23
import { notify, notifyError } from '../../lib/notifications.js';
34
import { defineSmartComponent } from '../../lib/smart/define-smart-component.js';
4-
import { generateDocsHref } from '../../lib/utils.js';
55
import { i18n } from '../../translations/translation.js';
66
import '../cc-smart-container/cc-smart-container.js';
77
import { CcAddonHeaderClient } from './cc-addon-header.client.js';
88
import './cc-addon-header.js';
99

10-
const DOCS_URL = generateDocsHref(`/addons/otoroshi`);
10+
const DOCS_URL = getDocUrl(`/addons/otoroshi`);
1111
const PROVIDER_ID = 'otoroshi';
1212

1313
/**

src/components/cc-addon-info/cc-addon-info.client.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import { get as getAddon } from '@clevercloud/client/esm/api/v2/addon.js';
44
import { getGrafanaOrganisation } from '@clevercloud/client/esm/api/v4/saas.js';
55
// @ts-expect-error FIXME: remove when clever-client exports types
66
import { ONE_SECOND } from '@clevercloud/client/esm/with-cache.js';
7+
import { getDevHubUrl } from '../../lib/dev-hub-url.js';
78
import { sendToApi } from '../../lib/send-to-api.js';
8-
import { generateDevHubHref } from '../../lib/utils.js';
99

1010
/**
1111
* @typedef {import('./cc-addon-info.types.js').AddonInfoStateLoaded} AddonInfoStateLoaded
@@ -178,7 +178,7 @@ export function formatVersionState(operatorVersionInfo) {
178178
installed: operatorVersionInfo.installed,
179179
available: operatorVersionInfo.available.filter((version) => version !== operatorVersionInfo.installed),
180180
latest: operatorVersionInfo.latest,
181-
changelogLink: `${generateDevHubHref('/changelog')}`,
181+
changelogLink: `${getDevHubUrl('/changelog')}`,
182182
};
183183
}
184184

src/components/cc-addon-info/cc-addon-info.smart-keycloak.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { getAssetUrl } from '../../lib/assets-url.js';
2+
import { getDocUrl } from '../../lib/dev-hub-url.js';
23
import { notifyError, notifySuccess } from '../../lib/notifications.js';
34
import { defineSmartComponent } from '../../lib/smart/define-smart-component.js';
4-
import { generateDocsHref } from '../../lib/utils.js';
55
import { i18n } from '../../translations/translation.js';
66
import '../cc-smart-container/cc-smart-container.js';
77
import { CcAddonInfoClient, formatVersionState } from './cc-addon-info.client.js';
@@ -72,7 +72,7 @@ defineSmartComponent({
7272
updateComponent('state', LOADING_STATE);
7373
updateComponent('docLink', {
7474
text: i18n('cc-addon-info.doc-link.keycloak'),
75-
href: generateDocsHref('/addons/keycloak'),
75+
href: getDocUrl('/addons/keycloak'),
7676
});
7777

7878
api

src/components/cc-addon-info/cc-addon-info.smart-matomo.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { getAssetUrl } from '../../lib/assets-url.js';
2+
import { getDocUrl } from '../../lib/dev-hub-url.js';
23
import { sendToApi } from '../../lib/send-to-api.js';
34
import { defineSmartComponent } from '../../lib/smart/define-smart-component.js';
4-
import { generateDocsHref } from '../../lib/utils.js';
55
import { i18n } from '../../translations/translation.js';
66
import '../cc-smart-container/cc-smart-container.js';
77
import { CcAddonInfoClient } from './cc-addon-info.client.js';
@@ -87,7 +87,7 @@ defineSmartComponent({
8787
updateComponent('state', LOADING_STATE);
8888
updateComponent('docLink', {
8989
text: i18n('cc-addon-info.doc-link.matomo'),
90-
href: generateDocsHref('/addons/matomo'),
90+
href: getDocUrl('/addons/matomo'),
9191
});
9292

9393
api

0 commit comments

Comments
 (0)