@elsikora/git-branch-lint 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ElsiKora
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Bogdan Kolesnyk (bogdan.kolesnyk@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,154 @@
+<p align="center">
+  <img src="https://6jft62zmy9nx2oea.public.blob.vercel-storage.com/git-branch-lint-0rauIZprtXnHOrt840ZtTzrUK32erg.png" width="500" alt="project-logo">
+</p>
+
+<h1 align="center">Git Branch Lint 🌿</h1>
+<p align="center"><em>Enforce consistent git branch naming conventions across your projects</em></p>
+
+<p align="center">
+    <a aria-label="ElsiKora logo" href="https://elsikora.com">
+  <img src="https://img.shields.io/badge/MADE%20BY%20ElsiKora-333333.svg?style=for-the-badge" alt="ElsiKora">
+</a> <img src="https://img.shields.io/badge/version-blue.svg?style=for-the-badge&logo=npm&logoColor=white" alt="version"> <img src="https://img.shields.io/badge/typescript-blue.svg?style=for-the-badge&logo=typescript&logoColor=white" alt="typescript"> <img src="https://img.shields.io/badge/license-green.svg?style=for-the-badge&logo=license&logoColor=white" alt="license"> <img src="https://img.shields.io/badge/node-green.svg?style=for-the-badge&logo=node.js&logoColor=white" alt="node">
+</p>
+
+
+## 📚 Table of Contents
+- [Description](#-description)
+- [Features](#-features)
+- [Installation](#-installation)
+- [Usage](#-usage)
+- [Roadmap](#-roadmap)
+- [FAQ](#-faq)
+- [License](#-license)
+
+
+## 📖 Description
+Git Branch Lint is a powerful tool designed to maintain consistent git branch naming conventions in your development workflow. It helps teams enforce standardized branch naming patterns, prevent common naming mistakes, and maintain a clean git history. Built with TypeScript and following clean architecture principles, it provides flexible configuration options and helpful error messages to guide developers in following your team's branch naming conventions.
+
+## 🚀 Features
+- ✨ **🔍 Validates branch names against customizable patterns**
+- ✨ **⚡ Fast and lightweight with minimal dependencies**
+- ✨ **🛠 Flexible configuration through multiple formats (JS, JSON, YAML)**
+- ✨ **💡 Helpful error messages with suggestions for fixing invalid names**
+- ✨ **🔒 Prevents usage of prohibited branch names**
+- ✨ **📏 Configurable length restrictions for branch names**
+- ✨ **🎨 Colored CLI output for better readability**
+- ✨ **🔧 Easy integration with git hooks and CI/CD pipelines**
+
+## 🛠 Installation
+```bash
+# Using npm
+npm install --save-dev git-branch-lint
+
+# Using yarn
+yarn add -D git-branch-lint
+
+# Using pnpm
+pnpm add -D git-branch-lint
+```
+
+## 💡 Usage
+## Basic Usage
+
+Run the linter directly:
+```bash
+git-branch-lint
+```
+
+## Configuration
+
+Create a configuration file `.elsikora/.git-branch-lintrc.json`:
+```json
+{
+  "pattern": ":type/:name",
+  "params": {
+    "type": ["feature", "bugfix", "hotfix", "release"],
+    "name": ["[a-z0-9-]+"]
+  },
+  "prohibited": ["master", "main", "develop"],
+  "minLength": 5,
+  "maxLength": 50
+}
+```
+
+## Git Hooks Integration
+
+Add to your `package.json`:
+```json
+{
+  "husky": {
+    "hooks": {
+      "pre-commit": "git-branch-lint"
+    }
+  }
+}
+```
+
+## Advanced Usage
+
+Custom configuration in JavaScript (`.elsikora/git-branch-lint.config.js`):
+```javascript
+module.exports = {
+  pattern: ':type/:scope/:name',
+  params: {
+    type: ['feature', 'bugfix', 'hotfix'],
+    scope: ['api', 'ui', 'core'],
+    name: ['[a-z0-9-]+'],
+  },
+  prohibited: ['wip', 'temp'],
+  minLength: 10,
+  maxLength: 100
+}
+```
+
+## CI/CD Integration
+
+GitHub Actions example:
+```yaml
+name: Lint Branch Names
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - run: npm install
+      - run: npx git-branch-lint
+```
+
+## 🛣 Roadmap
+| Task / Feature | Status |
+|---------------|--------|
+| - Add support for custom error messages | 🚧 In Progress |
+| - Implement branch name suggestions when validation fails | 🚧 In Progress |
+| - Add support for regex-based branch name validation | 🚧 In Progress |
+| - Create GitHub Action for easier CI integration | 🚧 In Progress |
+| - Add support for branch name templates | 🚧 In Progress |
+| - Implement branch name statistics and reporting | 🚧 In Progress |
+| (done) 🔍 Validates branch names against customizable patterns | 🚧 In Progress |
+| (done) ⚡ Fast and lightweight with minimal dependencies | 🚧 In Progress |
+| (done) 🛠 Flexible configuration through multiple formats (JS, JSON, YAML) | 🚧 In Progress |
+
+## ❓ FAQ
+### Why should I use Git Branch Lint?
+Maintaining consistent branch naming conventions helps teams track work effectively and automate processes like deployment and versioning.
+
+### Can I use custom regular expressions?
+Yes, you can define custom regex patterns in the configuration file's `params` section.
+
+### How do I skip validation for certain branches?
+You can exclude branches by adding them to the `prohibited` list with a negative pattern.
+
+### Does it work with monorepos?
+Yes, you can configure different patterns for different parts of your monorepo using workspace-specific configuration files.
+
+## 🔒 License
+This project is licensed under **MIT License
+
+Copyright (c) 2025 ElsiKora
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.**.

package/bin/application/use-cases/get-branch-config-use-case.d.ts

@@ -0,0 +1,19 @@
+import type { IBranchConfig } from "../../domain/interfaces/branch-interfaces";
+import type { IConfigRepository } from "../../domain/interfaces/repository-interfaces";
+/**
+ * Use case for getting branch configuration
+ */
+export declare class GetBranchConfigUseCase {
+    private readonly CONFIG_REPOSITORY;
+    /**
+     * Constructor
+     * @param configRepository The configuration repository
+     */
+    constructor(configRepository: IConfigRepository);
+    /**
+     * Execute the use case
+     * @param appName The application name
+     * @returns The branch configuration
+     */
+    execute(appName: string): Promise<IBranchConfig>;
+}

package/bin/application/use-cases/get-current-branch-use-case.d.ts

@@ -0,0 +1,18 @@
+import type { TBranchName } from "../../domain/interfaces/branch-interfaces";
+import type { IBranchRepository } from "../../domain/interfaces/repository-interfaces";
+/**
+ * Use case for getting the current branch name
+ */
+export declare class GetCurrentBranchUseCase {
+    private readonly BRANCH_REPOSITORY;
+    /**
+     * Constructor
+     * @param branchRepository The branch repository
+     */
+    constructor(branchRepository: IBranchRepository);
+    /**
+     * Execute the use case
+     * @returns The current branch name
+     */
+    execute(): Promise<TBranchName>;
+}

package/bin/application/use-cases/lint-branch-name-use-case.d.ts

@@ -0,0 +1,23 @@
+import type { IBranchConfig, TBranchName } from "../../domain/interfaces/branch-interfaces";
+/**
+ * Use case for linting a branch name
+ */
+export declare class LintBranchNameUseCase {
+    /**
+     * Lint a branch name against a configuration
+     * @param branchName The branch name to lint
+     * @param config The branch configuration
+     * @throws {ProhibitedBranchError} When branch name is prohibited
+     * @throws {PatternMatchError} When branch name doesn't match pattern
+     * @throws {BranchTooShortError} When branch name is shorter than the minimum length
+     * @throws {BranchTooLongError} When branch name is longer than the maximum length
+     */
+    execute(branchName: TBranchName, config: IBranchConfig): void;
+    /**
+     * Validate the branch name against the pattern
+     * @param branchName The branch name to validate
+     * @param config The branch configuration
+     * @throws {PatternMatchError} When branch name doesn't match pattern
+     */
+    private validatePattern;
+}

package/bin/domain/entities/branch.d.ts

@@ -0,0 +1,12 @@
+import type { TBranchName } from "../interfaces/branch-interfaces";
+/**
+ * Domain entity representing a Git branch
+ */
+export declare class Branch {
+    private readonly VALUE;
+    constructor(name: TBranchName);
+    getName(): TBranchName;
+    isProhibited(prohibitedNames: ReadonlyArray<string>): boolean;
+    isTooLong(maxLength?: number): boolean;
+    isTooShort(minLength?: number): boolean;
+}

package/bin/domain/errors/lint-errors.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Base error class for branch linting errors
+ */
+export declare class LintError extends Error {
+    constructor(message: string);
+}
+/**
+ * Error thrown when branch name is too long
+ */
+export declare class BranchTooLongError extends LintError {
+    constructor(branchName: string, maxLength: number);
+}
+/**
+ * Error thrown when branch name is too short
+ */
+export declare class BranchTooShortError extends LintError {
+    constructor(branchName: string, minLength: number);
+}
+/**
+ * Error thrown when branch name doesn't match the pattern
+ */
+export declare class PatternMatchError extends LintError {
+    constructor(branchName: string);
+}
+/**
+ * Error thrown when branch name is prohibited
+ */
+export declare class ProhibitedBranchError extends LintError {
+    constructor(branchName: string);
+}

package/bin/domain/interfaces/branch-interfaces.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Interface for branch configuration
+ */
+export interface IBranchConfig {
+    readonly MAXLENGTH?: number;
+    readonly MINLENGTH?: number;
+    PARAMS: IBranchParameters;
+    readonly PATTERN: string;
+    readonly PROHIBITED: ReadonlyArray<string>;
+}
+/**
+ * Interface for branch parameters
+ */
+export interface IBranchParameters {
+    readonly NAME: ReadonlyArray<string>;
+    readonly TYPE: ReadonlyArray<string>;
+}
+/**
+ * Type definition for a branch name
+ * We explicitly keep this type for semantic clarity
+ */
+export type TBranchName = string;

package/bin/domain/interfaces/repositories/ibranch-repository.d.ts

@@ -0,0 +1,10 @@
+import type { TBranchName } from "../branch-interfaces";
+/**
+ * Repository interface for branch operations
+ */
+export interface IBranchRepository {
+    /**
+     * Get the current branch name
+     */
+    getCurrentBranchName(): Promise<TBranchName>;
+}

package/bin/domain/interfaces/repositories/iconfig-repository.d.ts

@@ -0,0 +1,11 @@
+import type { IBranchConfig } from "../branch-interfaces";
+/**
+ * Repository interface for configuration operations
+ */
+export interface IConfigRepository {
+    /**
+     * Get the branch configuration
+     * @param appName The name of the application
+     */
+    getConfig(appName: string): Promise<IBranchConfig>;
+}

package/bin/domain/interfaces/repository-interfaces.d.ts

@@ -0,0 +1,2 @@
+export type { IBranchRepository } from "./repositories/ibranch-repository";
+export type { IConfigRepository } from "./repositories/iconfig-repository";

package/bin/domain/repositories/branch-repository.d.ts

@@ -0,0 +1,11 @@
+import type { TBranchName } from "../interfaces/branch-interfaces";
+/**
+ * Repository interface for branch operations
+ * @deprecated Use IBranchRepository instead
+ */
+export interface BranchRepository {
+    /**
+     * Get the current branch name
+     */
+    getCurrentBranchName(): Promise<TBranchName>;
+}

package/bin/domain/repositories/config-repository.d.ts

@@ -0,0 +1,12 @@
+import type { IBranchConfig } from "../interfaces/branch-interfaces";
+/**
+ * Repository interface for configuration operations
+ * @deprecated Use IConfigRepository instead
+ */
+export interface ConfigRepository {
+    /**
+     * Get the branch configuration
+     * @param appName The name of the application
+     */
+    getConfig(appName: string): Promise<IBranchConfig>;
+}

package/bin/index.d.ts

@@ -0,0 +1 @@
+export {};

package/bin/index.js

@@ -0,0 +1,446 @@
+#!/usr/bin/env node
+import { cosmiconfig } from 'cosmiconfig';
+import { exec } from 'node:child_process';
+import { promisify } from 'node:util';
+import chalk from 'chalk';
+
+/**
+ * Use case for getting branch configuration
+ */
+class GetBranchConfigUseCase {
+    CONFIG_REPOSITORY;
+    /**
+     * Constructor
+     * @param configRepository The configuration repository
+     */
+    constructor(configRepository) {
+        this.CONFIG_REPOSITORY = configRepository;
+    }
+    /**
+     * Execute the use case
+     * @param appName The application name
+     * @returns The branch configuration
+     */
+    async execute(appName) {
+        return this.CONFIG_REPOSITORY.getConfig(appName);
+    }
+}
+
+/**
+ * Use case for getting the current branch name
+ */
+class GetCurrentBranchUseCase {
+    BRANCH_REPOSITORY;
+    /**
+     * Constructor
+     * @param branchRepository The branch repository
+     */
+    constructor(branchRepository) {
+        this.BRANCH_REPOSITORY = branchRepository;
+    }
+    /**
+     * Execute the use case
+     * @returns The current branch name
+     */
+    async execute() {
+        return this.BRANCH_REPOSITORY.getCurrentBranchName();
+    }
+}
+
+/**
+ * Domain entity representing a Git branch
+ */
+class Branch {
+    VALUE;
+    constructor(name) {
+        this.VALUE = name;
+    }
+    getName() {
+        return this.VALUE;
+    }
+    isProhibited(prohibitedNames) {
+        return prohibitedNames.includes(this.VALUE);
+    }
+    isTooLong(maxLength) {
+        if (maxLength === undefined) {
+            return false;
+        }
+        return this.VALUE.length > maxLength;
+    }
+    isTooShort(minLength) {
+        if (minLength === undefined) {
+            return false;
+        }
+        return this.VALUE.length < minLength;
+    }
+}
+
+/**
+ * Base error class for branch linting errors
+ */
+class LintError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "LintError";
+    }
+}
+/**
+ * Error thrown when branch name is too long
+ */
+class BranchTooLongError extends LintError {
+    constructor(branchName, maxLength) {
+        // eslint-disable-next-line @elsikora-typescript/restrict-template-expressions
+        super(`Branch name "${branchName}" is too long (maximum length: ${maxLength})`);
+        this.name = "BranchTooLongError";
+    }
+}
+/**
+ * Error thrown when branch name is too short
+ */
+class BranchTooShortError extends LintError {
+    constructor(branchName, minLength) {
+        // eslint-disable-next-line @elsikora-typescript/restrict-template-expressions
+        super(`Branch name "${branchName}" is too short (minimum length: ${minLength})`);
+        this.name = "BranchTooShortError";
+    }
+}
+/**
+ * Error thrown when branch name doesn't match the pattern
+ */
+class PatternMatchError extends LintError {
+    constructor(branchName) {
+        super(`Branch name "${branchName}" doesn't match pattern`);
+        this.name = "PatternMatchError";
+    }
+}
+/**
+ * Error thrown when branch name is prohibited
+ */
+class ProhibitedBranchError extends LintError {
+    constructor(branchName) {
+        super(`Branch name "${branchName}" is prohibited`);
+        this.name = "ProhibitedBranchError";
+    }
+}
+
+/**
+ * Use case for linting a branch name
+ */
+class LintBranchNameUseCase {
+    /**
+     * Lint a branch name against a configuration
+     * @param branchName The branch name to lint
+     * @param config The branch configuration
+     * @throws {ProhibitedBranchError} When branch name is prohibited
+     * @throws {PatternMatchError} When branch name doesn't match pattern
+     * @throws {BranchTooShortError} When branch name is shorter than the minimum length
+     * @throws {BranchTooLongError} When branch name is longer than the maximum length
+     */
+    execute(branchName, config) {
+        const branch = new Branch(branchName);
+        if (branch.isProhibited(config.PROHIBITED)) {
+            throw new ProhibitedBranchError(branchName);
+        }
+        // @ts-ignore
+        if (branch.isTooShort(config.MINLENGTH)) {
+            // @ts-ignore
+            throw new BranchTooShortError(branchName, config.MINLENGTH);
+        }
+        // @ts-ignore
+        if (branch.isTooLong(config.MAXLENGTH)) {
+            // @ts-ignore
+            throw new BranchTooLongError(branchName, config.MAXLENGTH);
+        }
+        this.validatePattern(branch.getName(), config);
+    }
+    /**
+     * Validate the branch name against the pattern
+     * @param branchName The branch name to validate
+     * @param config The branch configuration
+     * @throws {PatternMatchError} When branch name doesn't match pattern
+     */
+    validatePattern(branchName, config) {
+        // Start with original pattern
+        let pattern = config.PATTERN;
+        // Process each parameter in the configuration
+        for (const [key, values] of Object.entries(config.PARAMS)) {
+            // Create the placeholder - IMPORTANT: Convert to lowercase to match pattern
+            const placeholder = `:${key.toLowerCase()}`;
+            const parameterValues = values;
+            let replacement = "(";
+            for (let index = 0; index < parameterValues.length; index++) {
+                const value = parameterValues[index];
+                // Add the value to the replacement pattern
+                if (value.startsWith("[")) {
+                    replacement += value;
+                }
+                else {
+                    const escapedValue = value.replaceAll(/[-/\\^$*+?.()|[\]{}]/g, String.raw `\$&`);
+                    replacement += escapedValue;
+                }
+                // Add OR separator if not the last value
+                if (index < parameterValues.length - 1) {
+                    replacement += "|";
+                }
+            }
+            replacement += ")";
+            // Replace the placeholder in the pattern
+            pattern = pattern.replaceAll(new RegExp(placeholder, "g"), replacement);
+        }
+        // Create the regular expression
+        const regexp = new RegExp(`^${pattern}$`);
+        // Test the branch name against the pattern
+        if (!regexp.test(branchName)) {
+            throw new PatternMatchError(branchName);
+        }
+    }
+}
+
+/**
+ * Default configuration for branch linting
+ */
+const DEFAULT_CONFIG = {
+    // eslint-disable-next-line @elsikora-typescript/no-magic-numbers
+    MAXLENGTH: 50,
+    // eslint-disable-next-line @elsikora-typescript/no-magic-numbers
+    MINLENGTH: 5,
+    PARAMS: {
+        NAME: ["[a-z0-9-]+"],
+        TYPE: ["feature", "hotfix", "support", "bugfix", "release"],
+    },
+    PATTERN: ":type/:name",
+    PROHIBITED: ["ci", "wip", "main", "test", "build", "master", "release", "dev", "develop"],
+};
+/**
+ * Cosmiconfig implementation of ConfigRepository
+ */
+class CosmiconfigRepository {
+    /**
+     * Get the branch configuration
+     * @param appName The name of the application
+     * @returns A promise that resolves to the branch configuration
+     */
+    async getConfig(appName) {
+        const configExplorer = cosmiconfig(appName, {
+            packageProp: `elsikora.${appName}`,
+            searchPlaces: ["package.json", `.elsikora/.${appName}rc`, `.elsikora/.${appName}rc.json`, `.elsikora/.${appName}rc.yaml`, `.elsikora/.${appName}rc.yml`, `.elsikora/.${appName}rc.js`, `.elsikora/.${appName}rc.ts`, `.elsikora/.${appName}rc.mjs`, `.elsikora/.${appName}rc.cjs`, `.elsikora/${appName}.config.js`, `.elsikora/${appName}.config.ts`, `.elsikora/${appName}.config.mjs`, `.elsikora/${appName}.config.cjs`],
+        });
+        const result = await configExplorer.search();
+        if (!result || result.isEmpty) {
+            return DEFAULT_CONFIG;
+        }
+        // Convert the config to match our interfaces
+        const providedConfig = result.config;
+        const uppercasedConfig = {};
+        // Create a new object with uppercase keys instead of modifying the original
+        for (const key of Object.keys(providedConfig)) {
+            const uppercaseKey = key.toUpperCase();
+            const value = providedConfig[key];
+            if (Array.isArray(value)) {
+                // Preserve arrays
+                // eslint-disable-next-line @elsikora-typescript/no-unsafe-assignment
+                uppercasedConfig[uppercaseKey] = [...value];
+            }
+            else if (typeof value === "object" && value !== null) {
+                // Handle nested objects
+                const nestedObject = {};
+                for (const subKey of Object.keys(value)) {
+                    const subValue = value[subKey];
+                    if (Array.isArray(subValue)) {
+                        // Preserve nested arrays
+                        // eslint-disable-next-line @elsikora-typescript/no-unsafe-assignment
+                        nestedObject[subKey.toUpperCase()] = [...subValue];
+                    }
+                    else {
+                        nestedObject[subKey.toUpperCase()] = subValue;
+                    }
+                }
+                uppercasedConfig[uppercaseKey] = nestedObject;
+            }
+            else {
+                // Handle primitive values
+                uppercasedConfig[uppercaseKey] = value;
+            }
+        }
+        const mergedConfig = {
+            ...DEFAULT_CONFIG,
+            ...uppercasedConfig,
+        };
+        if (uppercasedConfig.PARAMS && DEFAULT_CONFIG.PARAMS) {
+            mergedConfig.PARAMS = {
+                ...DEFAULT_CONFIG.PARAMS,
+                ...uppercasedConfig.PARAMS,
+            };
+        }
+        return mergedConfig;
+    }
+}
+
+const execAsync = promisify(exec);
+/**
+ * Git implementation of BranchRepository
+ */
+class GitBranchRepository {
+    /**
+     * Get the current branch name
+     * @returns A promise that resolves to the current branch name
+     */
+    async getCurrentBranchName() {
+        const command = "git rev-parse --abbrev-ref HEAD";
+        const { stdout } = await execAsync(command);
+        return stdout.trim();
+    }
+}
+
+/**
+ * Format error messages for CLI output
+ */
+class ErrorFormatter {
+    /**
+     * Format an error message
+     * @param message The error message
+     * @returns The formatted error message
+     */
+    format(message) {
+        return chalk.red(`✖ ${message}`);
+    }
+}
+
+/**
+ * Format hint messages for CLI output
+ */
+class HintFormatter {
+    /**
+     * Format a hint message based on error type and config
+     * @param error The error that occurred
+     * @param config The branch configuration
+     * @returns The formatted hint message
+     */
+    format(error, config) {
+        let output = "";
+        if (error instanceof PatternMatchError) {
+            output += this.formatPatternMatchHint(config);
+        }
+        else if (error instanceof ProhibitedBranchError) {
+            output += this.formatProhibitedBranchHint(config);
+        }
+        return output;
+    }
+    /**
+     * Format a hint for pattern match errors
+     * @param config The branch configuration
+     * @returns The formatted hint
+     */
+    formatPatternMatchHint(config) {
+        let output = "";
+        output += `${chalk.blue("Expected pattern:")} ${chalk.yellow(config.PATTERN)}\n`;
+        // Format the parameters
+        for (const [parameterName, parameterValues] of Object.entries(config.PARAMS)) {
+            const valuesList = parameterValues.map((value) => chalk.yellow(value)).join(", ");
+            output += chalk.blue(`Valid ${parameterName} values:`) + " " + valuesList + "\n";
+        }
+        return output.trim();
+    }
+    /**
+     * Format a hint for prohibited branch errors
+     * @param config The branch configuration
+     * @returns The formatted hint
+     */
+    formatProhibitedBranchHint(config) {
+        const prohibitedList = config.PROHIBITED.map((name) => chalk.yellow(name)).join(", ");
+        return `${chalk.blue("Prohibited branch names:")} ${prohibitedList}`;
+    }
+}
+
+/**
+ * Controller for CLI operations
+ */
+class CliController {
+    ERROR_FORMATTER;
+    GET_BRANCH_CONFIG_USE_CASE;
+    GET_CURRENT_BRANCH_USE_CASE;
+    HINT_FORMATTER;
+    LINT_BRANCH_NAME_USE_CASE;
+    /**
+     * Constructor
+     * @param getBranchConfigUseCase The use case for getting branch configuration
+     * @param getCurrentBranchUseCase The use case for getting the current branch
+     * @param lintBranchNameUseCase The use case for linting branch names
+     */
+    constructor(getBranchConfigUseCase, getCurrentBranchUseCase, lintBranchNameUseCase) {
+        this.GET_BRANCH_CONFIG_USE_CASE = getBranchConfigUseCase;
+        this.GET_CURRENT_BRANCH_USE_CASE = getCurrentBranchUseCase;
+        this.LINT_BRANCH_NAME_USE_CASE = lintBranchNameUseCase;
+        this.ERROR_FORMATTER = new ErrorFormatter();
+        this.HINT_FORMATTER = new HintFormatter();
+    }
+    /**
+     * Execute the CLI command
+     * @param appName The application name
+     */
+    async execute(appName) {
+        try {
+            const [config, branchName] = await Promise.all([this.GET_BRANCH_CONFIG_USE_CASE.execute(appName), this.GET_CURRENT_BRANCH_USE_CASE.execute()]);
+            this.LINT_BRANCH_NAME_USE_CASE.execute(branchName, config);
+        }
+        catch (error) {
+            await this.handleError(error);
+        }
+    }
+    /**
+     * Handle errors that occur during execution
+     * @param error The error that occurred
+     */
+    async handleError(error) {
+        if (!(error instanceof Error)) {
+            console.error(this.ERROR_FORMATTER.format("[LintBranchName] Unhandled error occurred"));
+            throw new Error("Unknown error occurred");
+        }
+        if (error instanceof LintError) {
+            try {
+                // Get the configuration using the service instead of hardcoded values
+                const config = await this.GET_BRANCH_CONFIG_USE_CASE.execute("git-branch-lint");
+                console.error(this.ERROR_FORMATTER.format(error.message));
+                console.log(this.HINT_FORMATTER.format(error, config));
+                // Since this is a CLI tool, it's appropriate to exit the process on validation errors
+                // ESLint wants us to throw instead, but this is a CLI application where exit is acceptable
+                // eslint-disable-next-line elsikora-node/no-process-exit, @elsikora-unicorn/no-process-exit
+                process.exit(1);
+            }
+            catch {
+                console.error(this.ERROR_FORMATTER.format("Failed to load configuration for error hint"));
+                console.error(this.ERROR_FORMATTER.format(error.message));
+                // eslint-disable-next-line elsikora-node/no-process-exit, @elsikora-unicorn/no-process-exit
+                process.exit(1);
+            }
+        }
+        throw error;
+    }
+}
+
+/**
+ * Application name used for configuration
+ */
+const APP_NAME = "git-branch-lint";
+/**
+ * Main function that bootstraps the application
+ */
+const main = async () => {
+    // Infrastructure layer
+    const configRepository = new CosmiconfigRepository();
+    const branchRepository = new GitBranchRepository();
+    // Application layer
+    const getBranchConfigUseCase = new GetBranchConfigUseCase(configRepository);
+    const getCurrentBranchUseCase = new GetCurrentBranchUseCase(branchRepository);
+    const lintBranchNameUseCase = new LintBranchNameUseCase();
+    // Presentation layer
+    const cliController = new CliController(getBranchConfigUseCase, getCurrentBranchUseCase, lintBranchNameUseCase);
+    // Execute the application
+    await cliController.execute(APP_NAME);
+};
+// Bootstrap the application and handle errors
+main().catch((error) => {
+    console.error("[LintBranchName] Unhandled error occurred");
+    throw error;
+});
+//# sourceMappingURL=index.js.map

package/bin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/application/use-cases/get-branch-config-use-case.ts","../src/application/use-cases/get-current-branch-use-case.ts","../src/domain/entities/branch.ts","../src/domain/errors/lint-errors.ts","../src/application/use-cases/lint-branch-name-use-case.ts","../src/infrastructure/config/cosmiconfig-repository.ts","../src/infrastructure/git/git-branch-repository.ts","../src/presentation/cli/formatters/error-formatter.ts","../src/presentation/cli/formatters/hint-formatter.ts","../src/presentation/cli/cli-controller.ts","../src/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,null],"names":[],"mappings":";;;;;;AAGA;;AAEG;MACU,sBAAsB,CAAA;AACjB,IAAA,iBAAiB;AAElC;;;AAGG;AACH,IAAA,WAAA,CAAY,gBAAmC,EAAA;AAC9C,QAAA,IAAI,CAAC,iBAAiB,GAAG,gBAAgB;;AAG1C;;;;AAIG;IACI,MAAM,OAAO,CAAC,OAAe,EAAA;QACnC,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC;;AAEjD;;ACtBD;;AAEG;MACU,uBAAuB,CAAA;AAClB,IAAA,iBAAiB;AAElC;;;AAGG;AACH,IAAA,WAAA,CAAY,gBAAmC,EAAA;AAC9C,QAAA,IAAI,CAAC,iBAAiB,GAAG,gBAAgB;;AAG1C;;;AAGG;AACI,IAAA,MAAM,OAAO,GAAA;AACnB,QAAA,OAAO,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE;;AAErD;;ACtBD;;AAEG;MACU,MAAM,CAAA;AACD,IAAA,KAAK;AAEtB,IAAA,WAAA,CAAY,IAAiB,EAAA;AAC5B,QAAA,IAAI,CAAC,KAAK,GAAG,IAAI;;IAGX,OAAO,GAAA;QACb,OAAO,IAAI,CAAC,KAAK;;AAGX,IAAA,YAAY,CAAC,eAAsC,EAAA;QACzD,OAAO,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;;AAGrC,IAAA,SAAS,CAAC,SAAkB,EAAA;AAClC,QAAA,IAAI,SAAS,KAAK,SAAS,EAAE;AAC5B,YAAA,OAAO,KAAK;;AAGb,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS;;AAG9B,IAAA,UAAU,CAAC,SAAkB,EAAA;AACnC,QAAA,IAAI,SAAS,KAAK,SAAS,EAAE;AAC5B,YAAA,OAAO,KAAK;;AAGb,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS;;AAErC;;ACnCD;;AAEG;AACG,MAAO,SAAU,SAAQ,KAAK,CAAA;AACnC,IAAA,WAAA,CAAY,OAAe,EAAA;QAC1B,KAAK,CAAC,OAAO,CAAC;AACd,QAAA,IAAI,CAAC,IAAI,GAAG,WAAW;;AAExB;AAED;;AAEG;AACG,MAAO,kBAAmB,SAAQ,SAAS,CAAA;IAChD,WAAY,CAAA,UAAkB,EAAE,SAAiB,EAAA;;AAEhD,QAAA,KAAK,CAAC,CAAgB,aAAA,EAAA,UAAU,kCAAkC,SAAS,CAAA,CAAA,CAAG,CAAC;AAC/E,QAAA,IAAI,CAAC,IAAI,GAAG,oBAAoB;;AAEjC;AAED;;AAEG;AACG,MAAO,mBAAoB,SAAQ,SAAS,CAAA;IACjD,WAAY,CAAA,UAAkB,EAAE,SAAiB,EAAA;;AAEhD,QAAA,KAAK,CAAC,CAAgB,aAAA,EAAA,UAAU,mCAAmC,SAAS,CAAA,CAAA,CAAG,CAAC;AAChF,QAAA,IAAI,CAAC,IAAI,GAAG,qBAAqB;;AAElC;AAED;;AAEG;AACG,MAAO,iBAAkB,SAAQ,SAAS,CAAA;AAC/C,IAAA,WAAA,CAAY,UAAkB,EAAA;AAC7B,QAAA,KAAK,CAAC,CAAA,aAAA,EAAgB,UAAU,CAAA,uBAAA,CAAyB,CAAC;AAC1D,QAAA,IAAI,CAAC,IAAI,GAAG,mBAAmB;;AAEhC;AAED;;AAEG;AACG,MAAO,qBAAsB,SAAQ,SAAS,CAAA;AACnD,IAAA,WAAA,CAAY,UAAkB,EAAA;AAC7B,QAAA,KAAK,CAAC,CAAA,aAAA,EAAgB,UAAU,CAAA,eAAA,CAAiB,CAAC;AAClD,QAAA,IAAI,CAAC,IAAI,GAAG,uBAAuB;;AAEpC;;AC7CD;;AAEG;MACU,qBAAqB,CAAA;AACjC;;;;;;;;AAQG;IACI,OAAO,CAAC,UAAuB,EAAE,MAAqB,EAAA;AAC5D,QAAA,MAAM,MAAM,GAAW,IAAI,MAAM,CAAC,UAAU,CAAC;QAE7C,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;AAC3C,YAAA,MAAM,IAAI,qBAAqB,CAAC,UAAU,CAAC;;;QAK5C,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;;YAGxC,MAAM,IAAI,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;;;QAK5D,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;;YAGvC,MAAM,IAAI,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;;QAG3D,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC;;AAG/C;;;;;AAKG;IACK,eAAe,CAAC,UAAuB,EAAE,MAAqB,EAAA;;AAErE,QAAA,IAAI,OAAO,GAAW,MAAM,CAAC,OAAO;;AAGpC,QAAA,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;;YAE1D,MAAM,WAAW,GAAW,CAAI,CAAA,EAAA,GAAG,CAAC,WAAW,EAAE,EAAE;YAEnD,MAAM,eAAe,GAAkB,MAAuB;YAE9D,IAAI,WAAW,GAAW,GAAG;AAE7B,YAAA,KAAK,IAAI,KAAK,GAAW,CAAC,EAAE,KAAK,GAAG,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;AACpE,gBAAA,MAAM,KAAK,GAAW,eAAe,CAAC,KAAK,CAAC;;AAG5C,gBAAA,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;oBAC1B,WAAW,IAAI,KAAK;;qBACd;AACN,oBAAA,MAAM,YAAY,GAAW,KAAK,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,GAAA,CAAK,CAAC;oBACvF,WAAW,IAAI,YAAY;;;gBAI5B,IAAI,KAAK,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;oBACvC,WAAW,IAAI,GAAG;;;YAIpB,WAAW,IAAI,GAAG;;AAGlB,YAAA,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,WAAW,CAAC;;;QAIxE,MAAM,MAAM,GAAW,IAAI,MAAM,CAAC,CAAI,CAAA,EAAA,OAAO,CAAG,CAAA,CAAA,CAAC;;QAGjD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;AAC7B,YAAA,MAAM,IAAI,iBAAiB,CAAC,UAAU,CAAC;;;AAGzC;;ACzFD;;AAEG;AACH,MAAM,cAAc,GAAkB;;AAErC,IAAA,SAAS,EAAE,EAAE;;AAEb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,MAAM,EAAE;QACP,IAAI,EAAE,CAAC,YAAY,CAAC;QACpB,IAAI,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC;AAC3D,KAAA;AACD,IAAA,OAAO,EAAE,aAAa;AACtB,IAAA,UAAU,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC;CACzF;AAED;;AAEG;MACU,qBAAqB,CAAA;AACjC;;;;AAIG;IACI,MAAM,SAAS,CAAC,OAAe,EAAA;AACrC,QAAA,MAAM,cAAc,GAAmC,WAAW,CAAC,OAAO,EAAE;YAC3E,WAAW,EAAE,CAAY,SAAA,EAAA,OAAO,CAAE,CAAA;YAClC,YAAY,EAAE,CAAC,cAAc,EAAE,cAAc,OAAO,CAAA,EAAA,CAAI,EAAE,CAAA,WAAA,EAAc,OAAO,CAAA,OAAA,CAAS,EAAE,CAAc,WAAA,EAAA,OAAO,CAAS,OAAA,CAAA,EAAE,CAAc,WAAA,EAAA,OAAO,QAAQ,EAAE,CAAA,WAAA,EAAc,OAAO,CAAA,KAAA,CAAO,EAAE,CAAA,WAAA,EAAc,OAAO,CAAO,KAAA,CAAA,EAAE,CAAc,WAAA,EAAA,OAAO,CAAQ,MAAA,CAAA,EAAE,cAAc,OAAO,CAAA,MAAA,CAAQ,EAAE,CAAA,UAAA,EAAa,OAAO,CAAA,UAAA,CAAY,EAAE,CAAa,UAAA,EAAA,OAAO,CAAY,UAAA,CAAA,EAAE,CAAa,UAAA,EAAA,OAAO,aAAa,EAAE,CAAA,UAAA,EAAa,OAAO,CAAA,WAAA,CAAa,CAAC;AAC5Z,SAAA,CAAC;AACF,QAAA,MAAM,MAAM,GAAsB,MAAM,cAAc,CAAC,MAAM,EAAE;AAE/D,QAAA,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE;AAC9B,YAAA,OAAO,cAAc;;;AAItB,QAAA,MAAM,cAAc,GAA4B,MAAM,CAAC,MAAiC;QACxF,MAAM,gBAAgB,GAA4B,EAAE;;QAGpD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE;AAC9C,YAAA,MAAM,YAAY,GAAW,GAAG,CAAC,WAAW,EAAE;AAC9C,YAAA,MAAM,KAAK,GAAY,cAAc,CAAC,GAAG,CAAC;AAE1C,YAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;;;gBAGzB,gBAAgB,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;;iBACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;;gBAEvD,MAAM,YAAY,GAA4B,EAAE;gBAEhD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,KAAgC,CAAC,EAAE;AACnE,oBAAA,MAAM,QAAQ,GAAa,KAAiC,CAAC,MAAM,CAAC;AAEpE,oBAAA,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;;;wBAG5B,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;;yBAC5C;wBACN,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,QAAQ;;;AAG/C,gBAAA,gBAAgB,CAAC,YAAY,CAAC,GAAG,YAAY;;iBACvC;;AAEN,gBAAA,gBAAgB,CAAC,YAAY,CAAC,GAAG,KAAK;;;AAIxC,QAAA,MAAM,YAAY,GAAkB;AACnC,YAAA,GAAG,cAAc;AACjB,YAAA,GAAI,gBAA6C;SACjD;QAED,IAAI,gBAAgB,CAAC,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE;YACrD,YAAY,CAAC,MAAM,GAAG;gBACrB,GAAG,cAAc,CAAC,MAAM;gBACxB,GAAI,gBAAgB,CAAC,MAAkC;aACvD;;AAGF,QAAA,OAAO,YAAY;;AAEpB;;ACpFD,MAAM,SAAS,GAA8B,SAAS,CAAC,IAAI,CAAC;AAE5D;;AAEG;MACU,mBAAmB,CAAA;AAC/B;;;AAGG;AACI,IAAA,MAAM,oBAAoB,GAAA;QAChC,MAAM,OAAO,GAAW,iCAAiC;QACzD,MAAM,EAAE,MAAM,EAAE,GAAuB,MAAM,SAAS,CAAC,OAAO,CAAC;AAE/D,QAAA,OAAO,MAAM,CAAC,IAAI,EAAE;;AAErB;;ACpBD;;AAEG;MACU,cAAc,CAAA;AAC1B;;;;AAIG;AACI,IAAA,MAAM,CAAC,OAAe,EAAA;QAC5B,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,OAAO,CAAA,CAAE,CAAC;;AAEjC;;ACRD;;AAEG;MACU,aAAa,CAAA;AACzB;;;;;AAKG;IACI,MAAM,CAAC,KAAc,EAAE,MAAqB,EAAA;QAClD,IAAI,MAAM,GAAW,EAAE;AAEvB,QAAA,IAAI,KAAK,YAAY,iBAAiB,EAAE;AACvC,YAAA,MAAM,IAAI,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC;;AACvC,aAAA,IAAI,KAAK,YAAY,qBAAqB,EAAE;AAClD,YAAA,MAAM,IAAI,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC;;AAGlD,QAAA,OAAO,MAAM;;AAGd;;;;AAIG;AACK,IAAA,sBAAsB,CAAC,MAAqB,EAAA;QACnD,IAAI,MAAM,GAAW,EAAE;AAEvB,QAAA,MAAM,IAAI,CAAG,EAAA,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA,CAAA,EAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI;;AAGhF,QAAA,KAAK,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC7E,MAAM,UAAU,GAAY,eAAiC,CAAC,GAAG,CAAC,CAAC,KAAa,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;AAEpH,YAAA,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,CAAS,MAAA,EAAA,aAAa,CAAU,QAAA,CAAA,CAAC,GAAG,GAAG,GAAG,UAAU,GAAG,IAAI;;AAGjF,QAAA,OAAO,MAAM,CAAC,IAAI,EAAE;;AAGrB;;;;AAIG;AACK,IAAA,0BAA0B,CAAC,MAAqB,EAAA;QACvD,MAAM,cAAc,GAAW,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAY,KAAK,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAErG,OAAO,CAAA,EAAG,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAA,CAAA,EAAI,cAAc,CAAA,CAAE;;AAErE;;AChDD;;AAEG;MACU,aAAa,CAAA;AACR,IAAA,eAAe;AAEf,IAAA,0BAA0B;AAE1B,IAAA,2BAA2B;AAE3B,IAAA,cAAc;AAEd,IAAA,yBAAyB;AAE1C;;;;;AAKG;AACH,IAAA,WAAA,CAAY,sBAA8C,EAAE,uBAAgD,EAAE,qBAA4C,EAAA;AACzJ,QAAA,IAAI,CAAC,0BAA0B,GAAG,sBAAsB;AACxD,QAAA,IAAI,CAAC,2BAA2B,GAAG,uBAAuB;AAC1D,QAAA,IAAI,CAAC,yBAAyB,GAAG,qBAAqB;AACtD,QAAA,IAAI,CAAC,eAAe,GAAG,IAAI,cAAc,EAAE;AAC3C,QAAA,IAAI,CAAC,cAAc,GAAG,IAAI,aAAa,EAAE;;AAG1C;;;AAGG;IACI,MAAM,OAAO,CAAC,OAAe,EAAA;AACnC,QAAA,IAAI;AACH,YAAA,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAiC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,2BAA2B,CAAC,OAAO,EAAE,CAAC,CAAC;YAE5K,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC;;QACzD,OAAO,KAAc,EAAE;AACxB,YAAA,MAAM,IAAI,CAAC,WAAW,CAAC,KAAc,CAAC;;;AAIxC;;;AAGG;IACK,MAAM,WAAW,CAAC,KAAY,EAAA;AACrC,QAAA,IAAI,EAAE,KAAK,YAAY,KAAK,CAAC,EAAE;AAC9B,YAAA,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,2CAA2C,CAAC,CAAC;AAEvF,YAAA,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC;;AAG1C,QAAA,IAAI,KAAK,YAAY,SAAS,EAAE;AAC/B,YAAA,IAAI;;gBAEH,MAAM,MAAM,GAAkB,MAAM,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,iBAAiB,CAAC;AAE9F,gBAAA,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACzD,gBAAA,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;;;;AAKtD,gBAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;;AACd,YAAA,MAAM;AACP,gBAAA,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,6CAA6C,CAAC,CAAC;AACzF,gBAAA,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;;AAGzD,gBAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;;;AAIjB,QAAA,MAAM,KAAK;;AAEZ;;AC/ED;;AAEG;AACH,MAAM,QAAQ,GAAW,iBAAiB;AAE1C;;AAEG;AACH,MAAM,IAAI,GAAG,YAA0B;;AAEtC,IAAA,MAAM,gBAAgB,GAA0B,IAAI,qBAAqB,EAAE;AAC3E,IAAA,MAAM,gBAAgB,GAAwB,IAAI,mBAAmB,EAAE;;AAGvE,IAAA,MAAM,sBAAsB,GAA2B,IAAI,sBAAsB,CAAC,gBAAgB,CAAC;AACnG,IAAA,MAAM,uBAAuB,GAA4B,IAAI,uBAAuB,CAAC,gBAAgB,CAAC;AACtG,IAAA,MAAM,qBAAqB,GAA0B,IAAI,qBAAqB,EAAE;;IAGhF,MAAM,aAAa,GAAkB,IAAI,aAAa,CAAC,sBAAsB,EAAE,uBAAuB,EAAE,qBAAqB,CAAC;;AAG9H,IAAA,MAAM,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC;AACtC,CAAC;AAED;AACA,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,KAAI;AAC/B,IAAA,OAAO,CAAC,KAAK,CAAC,2CAA2C,CAAC;AAE1D,IAAA,MAAM,KAAK;AACZ,CAAC,CAAC"}

package/bin/infrastructure/config/cosmiconfig-repository.d.ts

@@ -0,0 +1,13 @@
+import type { IBranchConfig } from "../../domain/interfaces/branch-interfaces";
+import type { IConfigRepository } from "../../domain/interfaces/repository-interfaces";
+/**
+ * Cosmiconfig implementation of ConfigRepository
+ */
+export declare class CosmiconfigRepository implements IConfigRepository {
+    /**
+     * Get the branch configuration
+     * @param appName The name of the application
+     * @returns A promise that resolves to the branch configuration
+     */
+    getConfig(appName: string): Promise<IBranchConfig>;
+}

package/bin/infrastructure/git/git-branch-repository.d.ts

@@ -0,0 +1,12 @@
+import type { TBranchName } from "../../domain/interfaces/branch-interfaces";
+import type { IBranchRepository } from "../../domain/interfaces/repository-interfaces";
+/**
+ * Git implementation of BranchRepository
+ */
+export declare class GitBranchRepository implements IBranchRepository {
+    /**
+     * Get the current branch name
+     * @returns A promise that resolves to the current branch name
+     */
+    getCurrentBranchName(): Promise<TBranchName>;
+}

package/bin/presentation/cli/cli-controller.d.ts

@@ -0,0 +1,30 @@
+import type { GetBranchConfigUseCase } from "../../application/use-cases/get-branch-config-use-case";
+import type { GetCurrentBranchUseCase } from "../../application/use-cases/get-current-branch-use-case";
+import type { LintBranchNameUseCase } from "../../application/use-cases/lint-branch-name-use-case";
+/**
+ * Controller for CLI operations
+ */
+export declare class CliController {
+    private readonly ERROR_FORMATTER;
+    private readonly GET_BRANCH_CONFIG_USE_CASE;
+    private readonly GET_CURRENT_BRANCH_USE_CASE;
+    private readonly HINT_FORMATTER;
+    private readonly LINT_BRANCH_NAME_USE_CASE;
+    /**
+     * Constructor
+     * @param getBranchConfigUseCase The use case for getting branch configuration
+     * @param getCurrentBranchUseCase The use case for getting the current branch
+     * @param lintBranchNameUseCase The use case for linting branch names
+     */
+    constructor(getBranchConfigUseCase: GetBranchConfigUseCase, getCurrentBranchUseCase: GetCurrentBranchUseCase, lintBranchNameUseCase: LintBranchNameUseCase);
+    /**
+     * Execute the CLI command
+     * @param appName The application name
+     */
+    execute(appName: string): Promise<void>;
+    /**
+     * Handle errors that occur during execution
+     * @param error The error that occurred
+     */
+    private handleError;
+}

package/bin/presentation/cli/formatters/error-formatter.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Format error messages for CLI output
+ */
+export declare class ErrorFormatter {
+    /**
+     * Format an error message
+     * @param message The error message
+     * @returns The formatted error message
+     */
+    format(message: string): string;
+}

package/bin/presentation/cli/formatters/hint-formatter.d.ts

@@ -0,0 +1,25 @@
+import type { IBranchConfig } from "../../../domain/interfaces/branch-interfaces";
+/**
+ * Format hint messages for CLI output
+ */
+export declare class HintFormatter {
+    /**
+     * Format a hint message based on error type and config
+     * @param error The error that occurred
+     * @param config The branch configuration
+     * @returns The formatted hint message
+     */
+    format(error: unknown, config: IBranchConfig): string;
+    /**
+     * Format a hint for pattern match errors
+     * @param config The branch configuration
+     * @returns The formatted hint
+     */
+    private formatPatternMatchHint;
+    /**
+     * Format a hint for prohibited branch errors
+     * @param config The branch configuration
+     * @returns The formatted hint
+     */
+    private formatProhibitedBranchHint;
+}

package/package.json

@@ -0,0 +1,83 @@
+{
+	"name": "@elsikora/git-branch-lint",
+	"version": "1.0.0",
+	"description": "Lint your git branch names",
+	"keywords": [
+		"lint",
+		"validate",
+		"branch",
+		"name",
+		"git",
+		"git-branch",
+		"branch-name"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/ElsiKora/Git-Branch-Lint.git"
+	},
+	"license": "MIT",
+	"author": "ElsiKora",
+	"type": "module",
+	"main": "bin/index.js",
+	"bin": {
+		"branch-name-lint": "./bin/index.js"
+	},
+	"files": [
+		"bin"
+	],
+	"scripts": {
+		"prebuild": "rimraf dist",
+		"build": "npm run prebuild && rollup -c",
+		"commit": "cz",
+		"format": "prettier --check .",
+		"format:fix": "prettier --write .",
+		"lint": "eslint ./",
+		"lint:all": "npm run lint && npm run lint:types",
+		"lint:all:fix": "npm run lint:fix && npm run lint:types:fix",
+		"lint:fix": "eslint --fix ./",
+		"lint:types": "tsc --noEmit",
+		"lint:types:fix": "tsc --noEmit --skipLibCheck",
+		"prepare": "husky",
+		"release": "semantic-release"
+	},
+	"config": {
+		"commitizen": {
+			"path": "@elsikora/commitizen-plugin-commitlint-ai"
+		}
+	},
+	"dependencies": {
+		"chalk": "^5.4.1",
+		"cosmiconfig": "^9.0.0",
+		"path-to-regexp": "^8.2.0"
+	},
+	"devDependencies": {
+		"@commitlint/cli": "^19.7.1",
+		"@commitlint/config-conventional": "^19.7.1",
+		"@elsikora/commitizen-plugin-commitlint-ai": "^1.0.0",
+		"@elsikora/eslint-config": "^3.3.4",
+		"@rollup/plugin-typescript": "^12.1.2",
+		"@saithodev/semantic-release-backmerge": "^4.0.1",
+		"@semantic-release/changelog": "^6.0.3",
+		"@semantic-release/commit-analyzer": "^13.0.1",
+		"@semantic-release/git": "^10.0.1",
+		"@semantic-release/github": "^11.0.1",
+		"@semantic-release/npm": "^12.0.1",
+		"@semantic-release/release-notes-generator": "^14.0.3",
+		"@types/node": "^22.13.8",
+		"commitizen": "^4.3.1",
+		"conventional-changelog-conventionalcommits": "^8.0.0",
+		"eslint": "^9.21.0",
+		"eslint-plugin-n": "^17.16.1",
+		"husky": "^9.1.7",
+		"lint-staged": "^15.4.3",
+		"prettier": "^3.5.3",
+		"rimraf": "^6.0.1",
+		"rollup": "^4.34.9",
+		"semantic-release": "^24.2.3",
+		"tslib": "^2.8.1",
+		"typescript": "^5.7.3"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}