@xrow/docusaurus-gitlab 4.161.0

package/README.md

@@ -0,0 +1,26 @@
+# Docusaurus GitLab helpers
+
+GitLab CI helper functions for Docusaurus configuration.
+
+```ts
+import gitlab from '@xrow/docusaurus-gitlab';
+
+const pagesUrl = gitlab.gitLabPagesUrl();
+
+export default {
+  title: gitlab.gitLabTitle(),
+  tagline: gitlab.gitLabTagline(),
+  url: pagesUrl.url,
+  baseUrl: pagesUrl.baseUrl,
+  presets: [
+    [
+      '@docusaurus/preset-classic',
+      {
+        docs: {
+          editUrl: gitlab.gitlabEditUrl(),
+        },
+      },
+    ],
+  ],
+};
+```

package/index.cjs

@@ -0,0 +1,46 @@
+function envValue(name) {
+  return typeof process !== 'undefined' && process.env ? process.env[name] : undefined;
+}
+
+function textOrDefault(value, fallback) {
+  return typeof value === 'string' && value.trim() ? value : fallback;
+}
+
+function gitLabPagesUrl(pagesUrl = envValue('CI_PAGES_URL')) {
+  const parsedPagesUrl = new URL(pagesUrl || 'https://example.com/');
+
+  return {
+    url: parsedPagesUrl.origin,
+    baseUrl: parsedPagesUrl.pathname.replace(/\/?$/, '/'),
+  };
+}
+
+function gitLabTitle(title = envValue('CI_PROJECT_TITLE')) {
+  return textOrDefault(title, 'Default Project Title');
+}
+
+function gitLabTagline(tagline = envValue('CI_PROJECT_DESCRIPTION')) {
+  return textOrDefault(tagline, 'Default Project Description');
+}
+
+function gitlabEditUrl(
+  projectUrl = envValue('CI_PROJECT_URL'),
+  defaultBranch = envValue('CI_DEFAULT_BRANCH'),
+) {
+  if (!projectUrl || !defaultBranch) {
+    return undefined;
+  }
+
+  const normalizedProjectUrl = projectUrl.replace(/\/+$/, '');
+  const encodedBranch = encodeURIComponent(defaultBranch);
+
+  return `${normalizedProjectUrl}/-/edit/${encodedBranch}/`;
+}
+
+module.exports = {
+  gitLabPagesUrl,
+  gitLabTitle,
+  gitLabTagline,
+  gitlabEditUrl,
+  gitLabEditUrl: gitlabEditUrl,
+};

package/index.d.ts

@@ -0,0 +1,25 @@
+export interface GitLabPagesUrl {
+  url: string;
+  baseUrl: string;
+}
+
+export function gitLabPagesUrl(pagesUrl?: string): GitLabPagesUrl;
+
+export function gitLabTitle(title?: string): string;
+
+export function gitLabTagline(tagline?: string): string;
+
+export function gitlabEditUrl(projectUrl?: string, defaultBranch?: string): string | undefined;
+
+export const gitLabEditUrl: typeof gitlabEditUrl;
+
+export interface DocusaurusGitLabHelpers {
+  gitLabPagesUrl: typeof gitLabPagesUrl;
+  gitLabTitle: typeof gitLabTitle;
+  gitLabTagline: typeof gitLabTagline;
+  gitlabEditUrl: typeof gitlabEditUrl;
+}
+
+declare const gitlab: DocusaurusGitLabHelpers;
+
+export default gitlab;

package/index.js

@@ -0,0 +1,49 @@
+function envValue(name) {
+  return typeof process !== 'undefined' && process.env ? process.env[name] : undefined;
+}
+
+function textOrDefault(value, fallback) {
+  return typeof value === 'string' && value.trim() ? value : fallback;
+}
+
+export function gitLabPagesUrl(pagesUrl = envValue('CI_PAGES_URL')) {
+  const parsedPagesUrl = new URL(pagesUrl || 'https://example.com/');
+
+  return {
+    url: parsedPagesUrl.origin,
+    baseUrl: parsedPagesUrl.pathname.replace(/\/?$/, '/'),
+  };
+}
+
+export function gitLabTitle(title = envValue('CI_PROJECT_TITLE')) {
+  return textOrDefault(title, 'Default Project Title');
+}
+
+export function gitLabTagline(tagline = envValue('CI_PROJECT_DESCRIPTION')) {
+  return textOrDefault(tagline, 'Default Project Description');
+}
+
+export function gitlabEditUrl(
+  projectUrl = envValue('CI_PROJECT_URL'),
+  defaultBranch = envValue('CI_DEFAULT_BRANCH'),
+) {
+  if (!projectUrl || !defaultBranch) {
+    return undefined;
+  }
+
+  const normalizedProjectUrl = projectUrl.replace(/\/+$/, '');
+  const encodedBranch = encodeURIComponent(defaultBranch);
+
+  return `${normalizedProjectUrl}/-/edit/${encodedBranch}/`;
+}
+
+export const gitLabEditUrl = gitlabEditUrl;
+
+const gitlab = {
+  gitLabPagesUrl,
+  gitLabTitle,
+  gitLabTagline,
+  gitlabEditUrl,
+};
+
+export default gitlab;

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@xrow/docusaurus-gitlab",
+  "version": "4.161.0",
+  "description": "GitLab CI helper functions for Docusaurus configuration.",
+  "type": "module",
+  "main": "index.cjs",
+  "module": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./index.cjs"
+    }
+  },
+  "scripts": {
+    "test": "node --test"
+  },
+  "files": [
+    "index.js",
+    "index.cjs",
+    "index.d.ts"
+  ],
+  "license": "MIT"
+}