@oorabona/release-it-preset 0.3.0

package/dist/types/extract-changelog.d.ts

@@ -0,0 +1,23 @@
+#!/usr/bin/env tsx
+/**
+ * Extract changelog entry for a specific version
+ *
+ * This script reads CHANGELOG.md and extracts the section for a given version.
+ * Used primarily for generating GitHub release notes.
+ *
+ * Usage:
+ *   tsx extract-changelog.ts <version>
+ *
+ * Example:
+ *   tsx extract-changelog.ts 1.2.3
+ *
+ * Environment variables:
+ *   CHANGELOG_FILE - Path to changelog file (default: CHANGELOG.md)
+ */
+import { readFileSync } from 'node:fs';
+export interface ExtractChangelogDeps {
+    readFileSync: typeof readFileSync;
+    getEnv: (key: string) => string | undefined;
+    getCwd: () => string;
+}
+export declare function extractChangelog(version: string, deps: ExtractChangelogDeps): string;

package/dist/types/init-project.d.ts

@@ -0,0 +1,37 @@
+#!/usr/bin/env tsx
+/**
+ * Initialize a project with release-it-preset
+ *
+ * This script:
+ * - Creates CHANGELOG.md with Keep a Changelog template
+ * - Creates .release-it.json with extends configuration
+ * - Optionally adds scripts to package.json
+ *
+ * Usage:
+ *   tsx init-project.ts [--yes]
+ *
+ * Options:
+ *   --yes    Skip prompts and use defaults
+ */
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+interface Options {
+    yes: boolean;
+}
+export interface InitProjectDeps {
+    existsSync: typeof existsSync;
+    readFileSync: typeof readFileSync;
+    writeFileSync: typeof writeFileSync;
+    prompt: (question: string) => Promise<boolean>;
+    log: (message: string) => void;
+    warn: (message: string) => void;
+}
+export declare function parseArgs(args?: string[]): Options;
+export declare function createChangelog(options: Options, deps: InitProjectDeps): Promise<boolean>;
+export declare function createReleaseItConfig(options: Options, deps: InitProjectDeps): Promise<boolean>;
+export declare function updatePackageJson(options: Options, deps: InitProjectDeps): Promise<boolean>;
+export declare function initProject(options: Options, deps: InitProjectDeps): Promise<{
+    changelog: boolean;
+    releaseIt: boolean;
+    packageJson: boolean;
+}>;
+export {};

package/dist/types/lib/commit-parser.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Conventional commit parsing utilities
+ */
+/**
+ * Regex pattern for matching conventional commits
+ * Matches: type(scope)?: description
+ * Example: feat(api): add new endpoint
+ */
+export declare const CONVENTIONAL_COMMIT_REGEX: RegExp;
+/**
+ * Strict conventional commit types as defined by Conventional Commits specification
+ * Used for strict validation in PR checks
+ */
+export declare const STRICT_CONVENTIONAL_TYPES: readonly ["feat", "fix", "docs", "style", "refactor", "perf", "test", "chore", "build", "ci", "revert"];
+/**
+ * Regex for strict conventional commit validation (only approved types)
+ */
+export declare const STRICT_CONVENTIONAL_COMMIT_REGEX: RegExp;
+/**
+ * Check if a commit message matches conventional commit format (lenient)
+ *
+ * @param message Commit message to check
+ * @returns true if message matches conventional format
+ */
+export declare function isConventionalCommit(message: string): boolean;
+/**
+ * Check if a commit message matches strict conventional commit format
+ *
+ * @param message Commit message to check
+ * @returns true if message matches strict format
+ */
+export declare function isStrictConventionalCommit(message: string): boolean;
+/**
+ * Extract conventional commit parts from a message
+ *
+ * @param message Commit message
+ * @returns Parsed parts or null if not conventional
+ */
+export declare function parseConventionalCommit(message: string): {
+    type: string;
+    scope?: string;
+    breaking: boolean;
+    description: string;
+} | null;

package/dist/types/lib/git-utils.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Git utility functions shared across scripts
+ */
+import type { ExecSyncOptions } from 'node:child_process';
+export interface GitDeps {
+    execSync: (command: string, options?: ExecSyncOptions) => Buffer | string;
+    getEnv: (key: string) => string | undefined;
+    warn?: (message: string) => void;
+}
+/**
+ * Get GitHub repository URL for commit/tag links
+ *
+ * Priority:
+ * 1. GITHUB_REPOSITORY environment variable (format: owner/repo)
+ * 2. Git remote URL (extracted from git config)
+ *
+ * @param deps Dependencies for git operations
+ * @returns Repository URL or empty string if not determinable
+ */
+export declare function getGitHubRepoUrl(deps: GitDeps): string;

package/dist/types/lib/semver-utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Semantic versioning utility functions
+ */
+/**
+ * Validate if a string is a valid semantic version
+ *
+ * @param version Version string to validate (can have optional 'v' prefix)
+ * @returns true if valid semver, false otherwise
+ */
+export declare function isValidSemver(version: string): boolean;
+/**
+ * Validate and normalize a semantic version string
+ *
+ * @param version Version string to validate
+ * @throws Error if version is not valid semver
+ * @returns Normalized version without 'v' prefix
+ */
+export declare function validateAndNormalizeSemver(version: string): string;

package/dist/types/lib/string-utils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * String utility functions shared across scripts
+ */
+/**
+ * Escape special regex characters in a string
+ *
+ * @param input String to escape
+ * @returns Escaped string safe for use in RegExp
+ */
+export declare function escapeRegExp(input: string): string;

package/dist/types/populate-unreleased-changelog.d.ts

@@ -0,0 +1,56 @@
+#!/usr/bin/env tsx
+/**
+ * Populate [Unreleased] section with commits since the last tag
+ *
+ * This script:
+ * - Extracts commits since the last git tag
+ * - Parses conventional commit messages
+ * - Groups commits by type (Added, Fixed, Changed, etc.)
+ * - Updates the [Unreleased] section in CHANGELOG.md
+ * - Generates commit links using the repository URL
+ *
+ * Usage:
+ *   tsx populate-unreleased-changelog.ts
+ *
+ * Environment variables:
+ *   CHANGELOG_FILE - Path to changelog file (default: CHANGELOG.md)
+ *   GITHUB_REPOSITORY - GitHub repo (owner/repo) for commit links
+ *   GIT_REMOTE - Git remote name (default: origin)
+ */
+import type { ExecSyncOptions } from 'node:child_process';
+import { readFileSync, writeFileSync } from 'node:fs';
+/**
+ * Dependencies interface for dependency injection
+ */
+export interface PopulateChangelogDeps {
+    execSync: (command: string, options?: ExecSyncOptions) => Buffer | string;
+    readFileSync: typeof readFileSync;
+    writeFileSync: typeof writeFileSync;
+    getEnv: (key: string) => string | undefined;
+    log: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+}
+export interface CommitPart {
+    type: string;
+    scope?: string;
+    description: string;
+    sha: string;
+    breaking?: boolean;
+}
+/**
+ * Extract all conventional commit patterns from a commit body
+ */
+export declare function extractConventionalCommitParts(commitBody: string, sha: string): CommitPart[];
+/**
+ * Normalize commit types to standard changelog categories
+ */
+export declare function normalizeCommitType(type: string): string | false;
+/**
+ * Parse git log output and extract all conventional commit parts
+ */
+export declare function parseCommitsWithMultiplePrefixes(gitOutput: string, repoUrl: string): string;
+/**
+ * Main function to populate changelog with dependency injection
+ */
+export declare function populateChangelog(deps: PopulateChangelogDeps): void;

package/dist/types/republish-changelog.d.ts

@@ -0,0 +1,39 @@
+#!/usr/bin/env tsx
+/**
+ * Republish changelog script
+ *
+ * This script handles republishing an existing version without bumping.
+ * Used when a git tag exists but the package was never published to npm.
+ *
+ * Unlike normal changelog update, this script:
+ * - Uses the existing tag version from package.json
+ * - Moves [Unreleased] content to the correct version entry
+ * - Handles the case where the version entry might already exist
+ *
+ * Usage:
+ *   tsx republish-changelog.ts
+ *
+ * Environment variables:
+ *   CHANGELOG_FILE - Path to changelog file (default: CHANGELOG.md)
+ *   GITHUB_REPOSITORY - GitHub repo (owner/repo) for commit links
+ *   GIT_REMOTE - Git remote name (default: origin)
+ */
+import type { ExecSyncOptions } from 'node:child_process';
+import { readFileSync, writeFileSync } from 'node:fs';
+export interface RepublishChangelogDeps {
+    execSync: (command: string, options?: ExecSyncOptions) => Buffer | string;
+    readFileSync: typeof readFileSync;
+    writeFileSync: typeof writeFileSync;
+    getEnv: (key: string) => string | undefined;
+    getCwd: () => string;
+    getDate: () => string;
+    log: (message: string) => void;
+    warn: (message: string) => void;
+}
+export interface UpdateReferenceLinksResult {
+    changelog: string;
+    addedUnreleasedLink: boolean;
+    addedVersionLinks: string[];
+}
+export declare function updateReferenceLinks(changelog: string, versionLabels: string[], linkTarget: string, unreleasedLine: string): UpdateReferenceLinksResult;
+export declare function republishChangelog(version: string, deps: RepublishChangelogDeps): void;

package/dist/types/retry-publish.d.ts

@@ -0,0 +1,33 @@
+#!/usr/bin/env tsx
+/**
+ * Retry publish script
+ *
+ * This script retries publishing an existing version to npm and GitHub Releases.
+ * Used when the initial publish failed but the Git tag was already created.
+ *
+ * Safety features:
+ * - Checks out the exact commit of the latest tag
+ * - Doesn't modify any Git history
+ * - Restores the original branch after publishing
+ * - Verifies the tag exists before proceeding
+ *
+ * Usage:
+ *   tsx retry-publish.ts
+ *   # Then run: release-it --config retry-publish.js
+ */
+import type { ExecSyncOptions } from 'node:child_process';
+import { readFileSync } from 'node:fs';
+export interface RetryPublishDeps {
+    execSync: (command: string, options?: ExecSyncOptions) => Buffer | string;
+    log: (message: string) => void;
+    warn: (message: string) => void;
+    readFileSync: typeof readFileSync;
+}
+export interface RetryPublishResult {
+    currentBranch: string;
+    latestTag: string;
+    tagCommit: string;
+    hasUncommittedChanges: boolean;
+    packageVersion?: string;
+}
+export declare function retryPublish(deps: RetryPublishDeps): RetryPublishResult;

package/dist/types/validate-release.d.ts

@@ -0,0 +1,43 @@
+#!/usr/bin/env tsx
+/**
+ * Validate project is ready for release
+ *
+ * This script checks:
+ * - CHANGELOG.md exists and is well-formatted
+ * - [Unreleased] section has content
+ * - Working directory is clean (unless --allow-dirty)
+ * - npm authentication works (npm whoami)
+ * - Current branch is allowed (if GIT_REQUIRE_BRANCH is set)
+ *
+ * Usage:
+ *   tsx validate-release.ts [--allow-dirty]
+ *
+ * Exit codes:
+ *   0 - All validations passed
+ *   1 - Validation failed
+ */
+import type { ExecSyncOptions } from 'node:child_process';
+import { existsSync, readFileSync } from 'node:fs';
+export interface ValidationResult {
+    name: string;
+    passed: boolean;
+    message?: string;
+}
+export interface ValidateOptions {
+    allowDirty: boolean;
+}
+export interface ValidateReleaseDeps {
+    execSync: (command: string, options?: ExecSyncOptions) => Buffer | string;
+    existsSync: typeof existsSync;
+    readFileSync: typeof readFileSync;
+    getEnv: (key: string) => string | undefined;
+}
+export declare function parseArgs(argv: string[]): ValidateOptions;
+export declare function validateChangelogExists(deps: ValidateReleaseDeps): ValidationResult;
+export declare function validateChangelogFormat(deps: ValidateReleaseDeps): ValidationResult;
+export declare function validateUnreleasedHasContent(deps: ValidateReleaseDeps): ValidationResult;
+export declare function validateWorkingDirectoryClean(deps: ValidateReleaseDeps, options: ValidateOptions): ValidationResult;
+export declare function validateNpmAuth(deps: ValidateReleaseDeps): ValidationResult;
+export declare function validateBranch(deps: ValidateReleaseDeps): ValidationResult;
+export declare function validateGitRepo(deps: ValidateReleaseDeps): ValidationResult;
+export declare function validateRelease(deps: ValidateReleaseDeps, options: ValidateOptions): ValidationResult[];

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@oorabona/release-it-preset",
+  "version": "0.3.0",
+  "description": "Shared release-it configuration and scripts for the organisation",
+  "type": "module",
+  "keywords": [
+    "release-it",
+    "release",
+    "version",
+    "changelog",
+    "conventional-commits",
+    "keep-a-changelog"
+  ],
+  "author": "Olivier Orabona",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/oorabona/release-it-preset.git"
+  },
+  "bugs": {
+    "url": "https://github.com/oorabona/release-it-preset/issues"
+  },
+  "homepage": "https://github.com/oorabona/release-it-preset#readme",
+  "bin": {
+    "release-it-preset": "bin/cli.js"
+  },
+  "exports": {
+    "./config/default": "./config/default.js",
+    "./config/hotfix": "./config/hotfix.js",
+    "./config/changelog-only": "./config/changelog-only.js",
+    "./config/manual-changelog": "./config/manual-changelog.js",
+    "./config/no-changelog": "./config/no-changelog.js",
+    "./config/republish": "./config/republish.js",
+    "./config/retry-publish": "./config/retry-publish.js",
+    "./scripts/*": {
+      "types": "./dist/types/*.d.ts",
+      "default": "./dist/scripts/*.js"
+    }
+  },
+  "files": [
+    "bin",
+    "config",
+    "dist/scripts",
+    "dist/types",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "release-it-preset": "node ./bin/cli.js",
+    "release": "pnpm run release:default",
+    "release:default": "node ./bin/cli.js default",
+    "release:default:dry-run": "node ./bin/cli.js default --dry-run",
+    "release:no-changelog": "node ./bin/cli.js no-changelog",
+    "release:changelog-only": "node ./bin/cli.js changelog-only",
+    "release:manual-changelog": "node ./bin/cli.js manual-changelog",
+    "release:hotfix": "node ./bin/cli.js hotfix",
+    "release:republish": "node ./bin/cli.js republish",
+    "release:retry-publish": "node ./bin/cli.js retry-publish",
+    "release:update": "node ./bin/cli.js update",
+    "release:validate": "node ./bin/cli.js validate",
+    "release:validate:allow-dirty": "node ./bin/cli.js validate --allow-dirty",
+    "release:check": "node ./bin/cli.js check",
+    "build": "tsc -p tsconfig.json",
+    "clean": "rimraf dist || rm -rf dist",
+    "lint": "biome check --write .",
+    "lint:check": "biome check .",
+    "test": "vitest run",
+    "test:unit": "vitest run tests/unit/*.test.ts",
+    "test:unit:watch": "vitest tests/unit/*.test.ts",
+    "test:unit:coverage": "vitest run tests/unit/*.test.ts --coverage",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui",
+    "prepublishOnly": "pnpm build && echo 'Running prepublish checks...' && test -f README.md && test -f LICENSE"
+  },
+  "peerDependencies": {
+    "release-it": "^19.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.2.5",
+    "@types/node": "^22.10.5",
+    "@vitest/coverage-v8": "^3.2.4",
+    "nano-staged": "^0.8.0",
+    "rimraf": "^6.0.1",
+    "tsx": "^4.20.6",
+    "typescript": "^5.7.3",
+    "vitest": "^3.2.4"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "packageManager": "pnpm@10.17.1"
+}