@dimensional-innovations/tool-config 1.0.0

package/src/tools/semantic-release/index.js

@@ -0,0 +1,130 @@
+/**
+ * semantic-release configuration factory
+ *
+ * Creates semantic-release configurations with preset-based defaults.
+ * Supports standard releases, library publishing, and monorepo structures.
+ * Auto-detects Git provider (GitLab, GitHub, Bitbucket) from repository URL.
+ */
+
+import { detectGitProvider } from '../../detectors.js'
+
+import createDefaultPreset from './presets/default.js'
+import createLibraryPreset from './presets/library.js'
+import createMonorepoPreset from './presets/monorepo.js'
+
+/**
+ * Create a semantic-release configuration
+ *
+ * @param {Object} options - Configuration options
+ * @param {string} [options.preset='default'] - Preset to use ('default', 'library', 'monorepo')
+ * @param {string} [options.gitProvider='auto'] - Git provider ('gitlab', 'github', 'bitbucket', 'auto', or null)
+ * @param {string} [options.cwd=process.cwd()] - Working directory for auto-detection
+ * @param {string[]} [options.branches] - Branches to release from (overrides preset)
+ * @param {Array} [options.plugins] - Plugins to use (overrides preset)
+ * @param {Object} [options.overrides] - Additional user overrides to merge into final config
+ * @returns {Object} semantic-release configuration object
+ *
+ * @example
+ * // Use default preset with auto-detected Git provider
+ * export default createReleaseConfig();
+ *
+ * @example
+ * // Use library preset with auto-detected Git provider
+ * export default createReleaseConfig({ preset: 'library' });
+ *
+ * @example
+ * // Explicitly specify Git provider
+ * export default createReleaseConfig({
+ *   preset: 'default',
+ *   gitProvider: 'github'
+ * });
+ *
+ * @example
+ * // Disable Git provider plugin
+ * export default createReleaseConfig({
+ *   preset: 'default',
+ *   gitProvider: null
+ * });
+ *
+ * @example
+ * // With custom branches
+ * export default createReleaseConfig({
+ *   preset: 'default',
+ *   branches: ['main', 'next']
+ * });
+ *
+ * @example
+ * // With plugin overrides
+ * export default createReleaseConfig({
+ *   preset: 'library',
+ *   plugins: [
+ *     '@semantic-release/commit-analyzer',
+ *     '@semantic-release/release-notes-generator',
+ *     '@semantic-release/npm'
+ *   ]
+ * });
+ */
+export function createReleaseConfig(options = {}) {
+  const {
+    preset = 'default',
+    gitProvider: explicitGitProvider = 'auto',
+    cwd = process.cwd(),
+    ...userOverrides
+  } = options
+
+  // Auto-detect Git provider if needed
+  const gitProvider = explicitGitProvider === 'auto' ? detectGitProvider(cwd) : explicitGitProvider
+
+  // Log detected/configured provider
+  if (gitProvider) {
+    console.warn(`📦 semantic-release: Detected ${gitProvider} - using ${gitProvider} plugin`)
+  } else {
+    console.warn('📦 semantic-release: No Git provider detected - skipping provider plugin')
+  }
+
+  // Select preset and generate config
+  let config
+  switch (preset) {
+    case 'library': {
+      config = createLibraryPreset(gitProvider)
+      console.warn('📦 semantic-release: Using library preset')
+      break
+    }
+
+    case 'monorepo': {
+      config = createMonorepoPreset(gitProvider)
+      console.warn('📦 semantic-release: Using monorepo preset')
+      break
+    }
+
+    case 'default': {
+      config = createDefaultPreset(gitProvider)
+      console.warn('📦 semantic-release: Using default preset')
+      break
+    }
+
+    default: {
+      console.warn(`⚠️  Unknown preset "${preset}", using default preset`)
+      config = createDefaultPreset(gitProvider)
+    }
+  }
+
+  // Apply user overrides
+  // Special handling for arrays (branches, plugins)
+  if (userOverrides.branches) {
+    config.branches = userOverrides.branches
+    delete userOverrides.branches
+  }
+
+  if (userOverrides.plugins) {
+    config.plugins = userOverrides.plugins
+    delete userOverrides.plugins
+  }
+
+  // Apply remaining overrides
+  Object.assign(config, userOverrides)
+
+  return config
+}
+
+export default createReleaseConfig

package/src/tools/semantic-release/presets/default.js

@@ -0,0 +1,37 @@
+/**
+ * Default semantic-release configuration
+ *
+ * Standard release process with:
+ * - Automatic versioning based on conventional commits
+ * - Changelog generation
+ * - NPM publishing
+ * - Git hosting provider releases (GitLab, GitHub, etc.)
+ * - Git tagging
+ *
+ * @param {string} gitProvider - Git provider ('gitlab', 'github', 'bitbucket', or null)
+ * @returns {Object} semantic-release configuration
+ */
+export default function createDefaultPreset(gitProvider = null) {
+  const plugins = [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    '@semantic-release/changelog',
+    '@semantic-release/npm'
+  ]
+
+  // Add provider-specific plugin
+  if (gitProvider === 'gitlab') {
+    plugins.push('@semantic-release/gitlab')
+  } else if (gitProvider === 'github') {
+    plugins.push('@semantic-release/github')
+  }
+  // Bitbucket and others don't have official plugins
+
+  // Always add git plugin last
+  plugins.push('@semantic-release/git')
+
+  return {
+    branches: ['main'],
+    plugins
+  }
+}

package/src/tools/semantic-release/presets/library.js

@@ -0,0 +1,58 @@
+/**
+ * Library-specific semantic-release configuration
+ *
+ * Optimized for published NPM libraries:
+ * - Publishes to NPM registry
+ * - Creates Git provider releases without comments
+ * - Generates changelog
+ * - Tags releases in Git
+ *
+ * Differences from default:
+ * - Explicit pkgRoot configuration
+ * - Disabled provider comments (less noise for library releases)
+ * - Disabled released labels (library-specific optimization)
+ *
+ * @param {string} gitProvider - Git provider ('gitlab', 'github', 'bitbucket', or null)
+ * @returns {Object} semantic-release configuration
+ */
+export default function createLibraryPreset(gitProvider = null) {
+  const plugins = [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    '@semantic-release/changelog',
+    [
+      '@semantic-release/npm',
+      {
+        pkgRoot: '.'
+      }
+    ]
+  ]
+
+  // Add provider-specific plugin with library-optimized settings
+  if (gitProvider === 'gitlab') {
+    plugins.push([
+      '@semantic-release/gitlab',
+      {
+        successComment: false,
+        releasedLabels: false
+      }
+    ])
+  } else if (gitProvider === 'github') {
+    plugins.push([
+      '@semantic-release/github',
+      {
+        successComment: false,
+        releasedLabels: false
+      }
+    ])
+  }
+  // Bitbucket and others don't have official plugins
+
+  // Always add git plugin last
+  plugins.push('@semantic-release/git')
+
+  return {
+    branches: ['main'],
+    plugins
+  }
+}

package/src/tools/semantic-release/presets/monorepo.js

@@ -0,0 +1,48 @@
+/**
+ * Monorepo semantic-release configuration
+ *
+ * Optimized for monorepo structures with multiple packages:
+ * - Supports publishing multiple packages
+ * - Handles workspace dependencies
+ * - Per-package versioning
+ * - Generates aggregated changelog
+ *
+ * Configuration:
+ * - pkgRoot set to 'packages/*' for workspace structure
+ * - Suitable for lerna, pnpm workspaces, npm workspaces
+ *
+ * Note: You may need to run semantic-release separately for each package
+ * or use semantic-release-monorepo plugin for advanced scenarios
+ *
+ * @param {string} gitProvider - Git provider ('gitlab', 'github', 'bitbucket', or null)
+ * @returns {Object} semantic-release configuration
+ */
+export default function createMonorepoPreset(gitProvider = null) {
+  const plugins = [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    '@semantic-release/changelog',
+    [
+      '@semantic-release/npm',
+      {
+        pkgRoot: 'packages/*'
+      }
+    ]
+  ]
+
+  // Add provider-specific plugin
+  if (gitProvider === 'gitlab') {
+    plugins.push('@semantic-release/gitlab')
+  } else if (gitProvider === 'github') {
+    plugins.push('@semantic-release/github')
+  }
+  // Bitbucket and others don't have official plugins
+
+  // Always add git plugin last
+  plugins.push('@semantic-release/git')
+
+  return {
+    branches: ['main'],
+    plugins
+  }
+}

package/src/tools/semantic-release/templates/.gitlab-ci.yml

@@ -0,0 +1,85 @@
+# GitLab CI/CD Template for @dimensional-innovations/tool-config
+#
+# Copy this file to your project root:
+#   cp node_modules/@dimensional-innovations/tool-config/src/tools/semantic-release/templates/.gitlab-ci.yml .gitlab-ci.yml
+#
+# Then configure these CI/CD variables in GitLab:
+#   - GL_TOKEN: GitLab Personal Access Token (for releases)
+#   - NPM_TOKEN: npm token (for publishing packages)
+
+stages:
+  - lint
+  - test
+  - release
+
+# Cache node_modules across jobs
+cache:
+  key:
+    files:
+      - package-lock.json
+  paths:
+    - node_modules/
+    - .npm/
+
+# Default settings for all jobs
+default:
+  image: node:22-alpine
+  before_script:
+    - npm ci --cache .npm --prefer-offline
+
+# Lint job - runs ESLint, Prettier, Stylelint
+lint:
+  stage: lint
+  script:
+    - npm run lint
+    - npm run prettier
+    - npm run style || true # Allow failure if no CSS files
+  only:
+    - branches
+    - merge_requests
+
+# Test job - runs test suite with coverage
+test:
+  stage: test
+  script:
+    - npm run test:coverage
+  coverage: '/All files[^|]*\|[^|]*\s+([\d\.]+)/'
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/cobertura-coverage.xml
+    paths:
+      - coverage/
+    expire_in: 30 days
+  only:
+    - branches
+    - merge_requests
+
+# Release job - runs semantic-release on main branch
+release:
+  stage: release
+  script:
+    - npm run release
+  only:
+    - main
+  except:
+    - schedules
+  when: manual # Remove this line to make releases automatic
+
+# Optional: Test on multiple Node versions
+# test:node-20:
+#   extends: test
+#   image: node:20-alpine
+
+# Optional: Deploy documentation
+# pages:
+#   stage: deploy
+#   script:
+#     - npm run docs:build
+#     - mv docs public
+#   artifacts:
+#     paths:
+#       - public
+#   only:
+#     - main

package/src/tools/semantic-release/templates/bitbucket-pipelines.yml

@@ -0,0 +1,100 @@
+# Bitbucket Pipelines Template for @dimensional-innovations/tool-config
+#
+# Copy this file to your project root:
+#   cp node_modules/@dimensional-innovations/tool-config/src/tools/semantic-release/templates/bitbucket-pipelines.yml bitbucket-pipelines.yml
+#
+# Then configure these repository variables in Bitbucket:
+#   - NPM_TOKEN: npm token (for publishing packages)
+
+image: node:22
+
+definitions:
+  caches:
+    npm: ~/.npm
+
+pipelines:
+  default:
+    - step:
+        name: Lint
+        caches:
+          - npm
+        script:
+          - npm ci
+          - npm run lint
+          - npm run prettier
+          - npm run style || true # Allow failure if no CSS files
+
+    - step:
+        name: Test
+        caches:
+          - npm
+        script:
+          - npm ci
+          - npm run test:coverage
+        artifacts:
+          - coverage/**
+
+  branches:
+    main:
+      - step:
+          name: Lint
+          caches:
+            - npm
+          script:
+            - npm ci
+            - npm run lint
+            - npm run prettier
+            - npm run style || true
+
+      - step:
+          name: Test
+          caches:
+            - npm
+          script:
+            - npm ci
+            - npm run test:coverage
+          artifacts:
+            - coverage/**
+
+      - step:
+          name: Release
+          caches:
+            - npm
+          script:
+            - npm ci
+            - npm run release
+          trigger: manual # Remove this line to make releases automatic
+
+  pull-requests:
+    '**':
+      - step:
+          name: Lint & Test
+          caches:
+            - npm
+          script:
+            - npm ci
+            - npm run lint
+            - npm run prettier
+            - npm run style || true
+            - npm run test
+# Optional: Test on multiple Node versions
+# definitions:
+#   services:
+#     docker:
+#       memory: 2048
+#
+# pipelines:
+#   default:
+#     - parallel:
+#       - step:
+#           name: Test (Node 20)
+#           image: node:20
+#           script:
+#             - npm ci
+#             - npm test
+#       - step:
+#           name: Test (Node 22)
+#           image: node:22
+#           script:
+#             - npm ci
+#             - npm test

package/src/tools/semantic-release/templates/github-workflow.yml

@@ -0,0 +1,107 @@
+# GitHub Actions Workflow Template for @dimensional-innovations/tool-config
+#
+# Copy this file to your project:
+#   mkdir -p .github/workflows
+#   cp node_modules/@dimensional-innovations/tool-config/src/tools/semantic-release/templates/github-workflow.yml .github/workflows/ci.yml
+#
+# Then configure these secrets in GitHub:
+#   - GITHUB_TOKEN: Automatically provided by GitHub Actions
+#   - NPM_TOKEN: npm token (for publishing packages)
+
+name: CI/CD
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npm run lint
+
+      - name: Run Prettier
+        run: npm run prettier
+
+      - name: Run Stylelint
+        run: npm run style || true # Allow failure if no CSS files
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests with coverage
+        run: npm run test:coverage
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage/coverage-final.json
+          fail_ci_if_error: false
+
+  release:
+    name: Release
+    needs: [lint, test]
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm run release
+# Optional: Test on multiple Node versions
+#   test-matrix:
+#     name: Test (Node ${{ matrix.node-version }})
+#     runs-on: ubuntu-latest
+#     strategy:
+#       matrix:
+#         node-version: [20, 22]
+#     steps:
+#       - uses: actions/checkout@v4
+#       - name: Setup Node.js ${{ matrix.node-version }}
+#         uses: actions/setup-node@v4
+#         with:
+#           node-version: ${{ matrix.node-version }}
+#           cache: 'npm'
+#       - run: npm ci
+#       - run: npm test