feat: add @bfra.me/semantic-release

.changeset/olive-frogs-attend.md

@@ -0,0 +1,5 @@
+---
+"@bfra.me/semantic-release": minor
+---
+
+Add the `@bfra.me/semantic-release` package.

package.json

@@ -12,7 +12,7 @@
     "lint": "manypkg check && pnpm -r run --parallel lint",
     "check-format": "prettier --check .",
     "format": "prettier --write .",
-    "test": "pnpm -r run --parallel test",
+    "test": "pnpm -r run test",
     "publish-changesets": "changeset publish",
     "version-changesets": "changeset version"
   },

packages/semantic-release/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@bfra.me/semantic-release",
+  "description": "Semantic Release shareable configuration and plugins for bfra.me.",
+  "version": "0.0.0",
+  "author": "Marcus R. Brown <contact@bfra.me>",
+  "license": "MIT",
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./lib/index.js",
+        "types": "./lib/index.d.ts"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "homepage": "https://github.com/bfra-me/works/tree/main/packages/semantic-release#readme",
+  "repository": {
+    "directory": "packages/semantic-release",
+    "type": "git",
+    "url": "https://github.com/bfra-me/works.git"
+  },
+  "bugs": "https://github.com/bfra-me/works/issues",
+  "keywords": [
+    "bfra.me",
+    "typescript",
+    "semantic-release",
+    "config",
+    "shared"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "files": [
+    "lib",
+    "tsconfig.json",
+    "!*.map"
+  ],
+  "devDependencies": {
+    "@bfra.me/semantic-release": "workspace:*",
+    "@bfra.me/tsconfig": "workspace:*",
+    "@swc/core": "1.4.6",
+    "semantic-release": "23.0.2",
+    "tsup": "8.0.2",
+    "type-fest": "4.13.1",
+    "vitest": "1.3.1"
+  },
+  "peerDependencies": {
+    "semantic-release": ">=23"
+  },
+  "scripts": {
+    "build": "tsup-node",
+    "test": "pnpm build && vitest --typecheck"
+  }
+}

packages/semantic-release/readme.md

@@ -0,0 +1,49 @@
+# @bfra.me/semantic-release
+
+> Sharable Semantic Release configuration for bfra.me.
+
+## Install
+
+### NPM
+
+```sh
+npm install --save-dev @bfra.me/semantic-release semantic-release
+```
+
+### PNPM
+
+```sh
+pnpm add --save-dev @bfra.me/semantic-release semantic-release
+```
+
+### Yarn
+
+```sh
+yarn add --dev @bfra.me/semantic-release semantic-release
+```
+
+## Usage
+
+Import the `defineConfig` utility to use in your `semantic-release` config file:
+
+```javascript
+import {defineConfig} from "@bfra.me/semantic-release"
+
+export default defineConfig({
+  branches: ["main"],
+  plugins: [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    "@semantic-release/git",
+  ],
+})
+```
+
+Code editors that support TypeScript type acquisition should be able to provide type hints for the `defineConfig` function.
+
+## License
+
+[MIT](../../LICENSE.md)

packages/semantic-release/src/config.ts

@@ -0,0 +1,11 @@
+import type {SemanticReleaseConfig} from './types'
+
+/**
+ * Define semantic-release global config.
+ *
+ * @param config Semantic Release configuration
+ * @returns Semantic Release configuration
+ */
+export function defineConfig(config: SemanticReleaseConfig) {
+  return config
+}

packages/semantic-release/src/index.ts

@@ -0,0 +1,2 @@
+export * from './config'
+export type * from './types'

packages/semantic-release/src/types/index.d.ts

@@ -0,0 +1,30 @@
+import type {BranchSpec} from 'semantic-release'
+import type {LiteralUnion} from 'type-fest'
+import type {Plugin} from './plugin'
+
+export interface CustomExtends {}
+
+export type KnownExtends = LiteralUnion<
+  '@bfra.me/semantic-release' | 'semantic-release-monorepo' | keyof CustomExtends,
+  string
+>
+
+export type Extends = KnownExtends | KnownExtends[]
+
+export interface SemanticReleaseConfig {
+  extends?: Extends
+
+  branches: ReadonlyArray<BranchSpec> | BranchSpec
+
+  repositoryUrl?: string
+
+  tagFormat?: string
+
+  plugins?: Plugin[]
+
+  dryRun?: boolean
+
+  ci?: boolean | undefined
+
+  [name: string]: unknown
+}

packages/semantic-release/src/types/plugin/index.d.ts

@@ -0,0 +1,48 @@
+import type {LiteralUnion} from 'type-fest'
+import type {PluginSpec} from './plugin-spec'
+import type {SemanticReleasePlugins} from './semantic-release'
+
+/**
+ * This is a special exported interface for other packages to declare
+ * additional types that should bail out for eslint rules. For example
+ * `semantic-release-license` can declare it like so in its `d.ts`:
+ *
+ * ```ts
+ * declare module '@bfra-me/semantic-release' {
+ *   export interface CustomPluginConfig {
+ *     /**
+ *      * The path to your license path.
+ *      *
+ *      * \@see [Options](https://github.com/cbhq/semantic-release-license/tree/latest#options)
+ *      *\/
+ *     'semantic-release-license': {
+ *       license: {
+ *         path?: string;
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export interface CustomPluginConfig {}
+
+type WrapPlugin<T extends {[key: string]: any}> = {
+  [K in keyof T]: T[K] extends PluginSpec ? T[K] : PluginSpec<[K, T[K]]>
+}
+
+type CustomPlugins = WrapPlugin<CustomPluginConfig>
+
+export interface KnownPlugins extends CustomPlugins, SemanticReleasePlugins {}
+
+// Extract the TConfig type from a PluginNameAndConfig
+export type PluginConfig<TSpec extends PluginSpec> = TSpec extends [string, infer TConfig]
+  ? TConfig
+  : never
+
+export type PluginName = LiteralUnion<keyof KnownPlugins, string>
+
+export type Plugin<TLookup extends any = PluginName> = TLookup extends keyof KnownPlugins
+  ? PluginSpec<[TLookup, PluginConfig<KnownPlugins[TLookup]>]>
+  : TLookup extends string
+    ? PluginSpec<[TLookup, {[key: string]: unknown}]>
+    : PluginSpec<TLookup>

packages/semantic-release/src/types/plugin/plugin-spec.d.ts

@@ -0,0 +1,3 @@
+export type PluginSpec<TSpec extends any[] = any[]> = TSpec extends [infer TName, (infer TConfig)?]
+  ? TName | [TName, TConfig]
+  : never

packages/semantic-release/src/types/plugin/semantic-release/index.d.ts

@@ -0,0 +1,53 @@
+import type {PluginSpec} from '../plugin-spec'
+
+export interface CommitAnalyzerPluginConfig {
+  /**
+   * Preset value.
+   */
+  preset?: string
+  releaseRules?: {
+    type: string
+    scope: string
+    release: string
+  }[]
+}
+
+export type CommitAnalyzerPluginSpec = PluginSpec<
+  ['@semantic-release/commit-analyzer', CommitAnalyzerPluginConfig]
+>
+
+export interface ReleaseNotesGeneratorPluginConfig {
+  /**
+   * Preset value.
+   */
+  preset?: string
+}
+
+export type ReleaseNotesGeneratorPluginSpec = PluginSpec<
+  ['@semantic-release/release-notes-generator', ReleaseNotesGeneratorPluginConfig]
+>
+
+export interface NpmPluginConfig {
+  npmPublish?: boolean
+}
+
+export type NpmPluginSpec = PluginSpec<['@semantic-release/npm', NpmPluginConfig]>
+
+export interface GitHubPluginConfig {
+  /**
+   * Some assets
+   */
+  assets?: string
+}
+
+export type GitHubPluginSpec = PluginSpec<['@semantic-release/github', GitHubPluginConfig]>
+
+export interface SemanticReleasePlugins {
+  '@semantic-release/commit-analyzer': CommitAnalyzerPluginSpec
+
+  '@semantic-release/release-notes-generator': ReleaseNotesGeneratorPluginSpec
+
+  '@semantic-release/npm': NpmPluginSpec
+
+  '@semantic-release/github': GitHubPluginSpec
+}

packages/semantic-release/test/define-config.test-d.ts

@@ -0,0 +1,12 @@
+import {describe, expectTypeOf, test} from 'vitest'
+import {defineConfig} from '@bfra.me/semantic-release'
+import type {SemanticReleaseConfig} from '@bfra.me/semantic-release'
+
+describe('defineConfig', {}, () => {
+  test('minimal config', () => {
+    const config = defineConfig({
+      branches: 'main',
+    })
+    expectTypeOf(config).toEqualTypeOf<SemanticReleaseConfig>()
+  })
+})

packages/semantic-release/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@bfra.me/tsconfig",
+  "compilerOptions": {
+    "composite": false,
+    "incremental": false,
+    "noEmit": true,
+    "outDir": "lib"
+  },
+  "exclude": ["lib", "node_modules"]
+}

packages/semantic-release/tsup.config.ts

@@ -0,0 +1,12 @@
+import {defineConfig} from 'tsup'
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  format: ['esm'],
+  dts: true,
+  clean: true,
+  sourcemap: true,
+  minify: true,
+  outDir: 'lib',
+  splitting: true,
+})