@elsikora/git-branch-lint 1.1.0 → 1.1.1-dev.2

package/README.md

@@ -38,13 +38,13 @@ Git Branch Lint is a powerful tool designed to maintain consistent git branch na
 ## 🛠 Installation
 ```bash
 # Using npm
-npm install --save-dev git-branch-lint
+npm install --save-dev @elsikora/git-branch-lint
 
 # Using yarn
-yarn add -D git-branch-lint
+yarn add -D @elsikora/git-branch-lint
 
 # Using pnpm
-pnpm add -D git-branch-lint
+pnpm add -D @elsikora/git-branch-lint
 ```
 
 ## 💡 Usage
@@ -52,7 +52,7 @@ pnpm add -D git-branch-lint
 
 Run the linter directly:
 ```bash
-git-branch-lint
+npx @elsikora/git-branch-lint
 ```
 
 ## Configuration
@@ -78,7 +78,7 @@ Add to your `package.json`:
 {
   "husky": {
     "hooks": {
-      "pre-commit": "git-branch-lint"
+      "pre-commit": "npx @elsikora/git-branch-lint"
     }
   }
 }
@@ -89,18 +89,77 @@ Add to your `package.json`:
 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
+  branches: {
+		bugfix: { description: "🐞 Fixing issues in existing functionality", title: "Bugfix" },
+		feature: { description: "🆕 Integration of new functionality", title: "Feature" },
+		hotfix: { description: "🚑 Critical fixes for urgent issues", title: "Hotfix" },
+		release: { description: "📦 Preparing a new release version", title: "Release" },
+		support: { description: "🛠️ Support and maintenance tasks", title: "Support" },
+	},
+	ignore: ["dev"],
+	rules: {
+		"branch-max-length": 50,
+		"branch-min-length": 5,
+		"branch-pattern": ":type/:name",
+		"branch-prohibited": ["main", "master", "release"],
+		"branch-subject-pattern": "[a-z0-9-]+",
+	},
 }
 ```
 
+Typescript support (`.elsikora/git-branch-lint.config.ts`):
+```typescript
+import type { BranchLintConfig } from "@elsikora/git-branch-lint";
+
+const config: BranchLintConfig = {
+ branches: {
+  bugfix: { description: "🆕 Integration of new functionality", title: "Feature" },
+  feature: { description: "🐞 Fixing issues in existing functionality", title: "Bugfix" },
+  hotfix: { description: "🚑 Critical fixes for urgent issues", title: "Hotfix" },
+  release: { description: "📦 Preparing a new release version", title: "Release" },
+  support: { description: "🛠️ Support and maintenance tasks", title: "Support" },
+ },
+ ignore: [dev],
+ rules: {
+  "branch-max-length": 50,
+  "branch-min-length": 5,
+  "branch-pattern": ":type/:name",
+  "branch-prohibited": ["main", "master", "release"],
+  "branch-subject-pattern": "[a-z0-9-]+",
+ },
+};
+
+export default config;
+```
+
+## Create branch tool
+
+Create branch tool is a command-line utility included in the @elsikora/branch-lint package. It facilitates the creation of Git branches by guiding users through an interactive prompt to select a branch type and name, ensuring compliance with the project's branch naming conventions as defined in the configuration.
+
+Example:
+```bash
+npx @elsikora/branch-lint -b
+```
+
+Prompts:
+```bash
+🌿 Creating a new branch...
+
+❔ Select the type of branch you're creating: 
+  Feature:     🆕 Integration of new functionality 
+  Bugfix:      🐞 Fixing issues in existing functionality 
+❯ Hotfix:      🚑 Critical fixes for urgent issues 
+  Release:     📦 Preparing a new release version 
+  Support:     🛠️ Support and maintenance tasks 
+
+Enter the branch name (e.g., authorization): new-ui
+
+⌛️ Creating branch: feature/new-ui
+Do you want to push the branch to the remote repository? (y/N) y
+
+✅ Branch feature/new-ui pushed to remote repository!
+```
+
 ## CI/CD Integration
 
 GitHub Actions example:
@@ -115,7 +174,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
       - run: npm install
-      - run: npx git-branch-lint
+      - run: npx @elsikora/git-branch-lint
 ```
 
 ## 🛣 Roadmap

package/bin/application/use-cases/check-working-directory-use-case.d.ts

@@ -0,0 +1,13 @@
+import type { IBranchRepository } from "../../domain/interface/branch.repository.interface";
+/**
+ * Use case for checking working directory status
+ */
+export declare class CheckWorkingDirectoryUseCase {
+    private readonly branchRepository;
+    constructor(branchRepository: IBranchRepository);
+    /**
+     * Execute the use case
+     * @throws {UncommittedChangesError} When there are uncommitted changes
+     */
+    execute(): Promise<void>;
+}

package/bin/application/use-cases/check-working-directory.use-case.d.ts

@@ -0,0 +1,13 @@
+import type { IBranchRepository } from "../../domain/interface/branch.repository.interface";
+/**
+ * Use case for checking working directory status
+ */
+export declare class CheckWorkingDirectoryUseCase {
+    private readonly branchRepository;
+    constructor(branchRepository: IBranchRepository);
+    /**
+     * Execute the use case
+     * @throws {UncommittedChangesError} When there are uncommitted changes
+     */
+    execute(): Promise<void>;
+}

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

@@ -0,0 +1,14 @@
+import type { IBranchRepository } from "../../domain/interface/branch.repository.interface";
+/**
+ * Use case for creating a new branch
+ */
+export declare class CreateBranchUseCase {
+    private readonly branchRepository;
+    constructor(branchRepository: IBranchRepository);
+    /**
+     * Execute the use case
+     * @param branchName The name of the branch to create
+     * @throws {BranchAlreadyExistsError} When trying to create current branch
+     */
+    execute(branchName: string): Promise<void>;
+}

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

@@ -0,0 +1,14 @@
+import type { IBranchRepository } from "../../domain/interface/branch.repository.interface";
+/**
+ * Use case for creating a new branch
+ */
+export declare class CreateBranchUseCase {
+    private readonly branchRepository;
+    constructor(branchRepository: IBranchRepository);
+    /**
+     * Execute the use case
+     * @param branchName The name of the branch to create
+     * @throws {BranchAlreadyExistsError} When trying to create current branch
+     */
+    execute(branchName: string): Promise<void>;
+}

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

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

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

@@ -1,4 +1,4 @@
-import type { IBranchRepository } from "../../domain/interfaces/repository-interfaces";
+import type { IBranchRepository } from "../../domain/interface/branch.repository.interface";
 /**
  * Use case for getting the current branch name
  */

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

@@ -1,10 +1,10 @@
-import type { BranchLintConfig } from "../../domain/interfaces/config.type";
+import type { IBranchLintConfig } from "../../domain/type/config.type";
 /**
- * Use case for linting a branch name
+ * Use case for linting branch names
  */
 export declare class LintBranchNameUseCase {
     /**
-     * Lint a branch name against a configuration
+     * Execute the use case
      * @param branchName The branch name to lint
      * @param config The branch configuration
      * @throws {ProhibitedBranchError} When branch name is prohibited
@@ -12,7 +12,7 @@ export declare class LintBranchNameUseCase {
      * @throws {BranchTooShortError} When branch name is shorter than the minimum length
      * @throws {BranchTooLongError} When branch name is longer than the maximum length
      */
-    execute(branchName: string, config: BranchLintConfig): void;
+    execute(branchName: string, config: IBranchLintConfig): void;
     /**
      * Validate the branch name against the pattern
      * @param branchName The branch name to validate

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

@@ -0,0 +1,13 @@
+import type { IBranchRepository } from "../../domain/interface/branch.repository.interface";
+/**
+ * Use case for pushing a branch to remote repository
+ */
+export declare class PushBranchUseCase {
+    private readonly branchRepository;
+    constructor(branchRepository: IBranchRepository);
+    /**
+     * Execute the use case
+     * @param branchName The name of the branch to push
+     */
+    execute(branchName: string): Promise<void>;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * Use case for validating branch name format
+ */
+export declare class ValidateBranchNameUseCase {
+    private readonly BRANCH_NAME_PATTERN;
+    /**
+     * Execute the use case
+     * @param branchName The branch name to validate
+     * @returns Validation result with error message if invalid
+     */
+    execute(branchName: string): {
+        errorMessage?: string;
+        isValid: boolean;
+    };
+}

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

@@ -0,0 +1,15 @@
+/**
+ * Use case for validating branch name format
+ */
+export declare class ValidateBranchNameUseCase {
+    private readonly BRANCH_NAME_PATTERN;
+    /**
+     * Execute the use case
+     * @param branchName The branch name to validate
+     * @returns Validation result with error message if invalid
+     */
+    execute(branchName: string): {
+        errorMessage?: string;
+        isValid: boolean;
+    };
+}

package/bin/domain/errors/branch-creation.error.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Base error class for branch creation errors
+ */
+export declare class BranchCreationError extends Error {
+    constructor(message: string);
+}
+/**
+ * Error thrown when trying to create a branch that already exists
+ */
+export declare class BranchAlreadyExistsError extends BranchCreationError {
+    constructor(branchName: string);
+}
+/**
+ * Error thrown when git operation fails
+ */
+export declare class GitOperationError extends BranchCreationError {
+    constructor(operation: string, details?: string);
+}
+/**
+ * Error thrown when working directory has uncommitted changes
+ */
+export declare class UncommittedChangesError extends BranchCreationError {
+    constructor();
+}

package/bin/domain/interface/branch.repository.interface.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Repository interface for branch operations
+ */
+export interface IBranchRepository {
+    /**
+     * Create a new branch
+     * @param branchName The name of the branch to create
+     */
+    createBranch(branchName: string): Promise<void>;
+    /**
+     * Get the current branch name
+     */
+    getCurrentBranchName(): Promise<string>;
+    /**
+     * Check if working directory has uncommitted changes
+     */
+    hasUncommittedChanges(): Promise<boolean>;
+    /**
+     * Push branch to remote repository
+     * @param branchName The name of the branch to push
+     */
+    pushBranch(branchName: string): Promise<void>;
+}

package/bin/domain/{interfaces/repositories/iconfig-repository.d.ts → interface/config.repository.interface.d.ts}

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

package/bin/domain/interface/repository.interface.d.ts

@@ -0,0 +1,2 @@
+export type { IBranchRepository } from "./branch.repository.interface";
+export type { IConfigRepository } from "./config.repository.interface";

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

@@ -0,0 +1,5 @@
+export interface IBranchDetails {
+    description: string;
+    title: string;
+}
+export type TBranchList = Array<string> | Record<string, IBranchDetails>;

package/bin/domain/type/config.type.d.ts

@@ -0,0 +1,7 @@
+import type { TBranchList } from "./branch.type";
+import type { IRulesList } from "./rules.type";
+export interface IBranchLintConfig {
+    branches: TBranchList;
+    ignore?: Array<string>;
+    rules?: Partial<IRulesList>;
+}

package/bin/domain/{interfaces → type}/rules.type.d.ts

@@ -1,4 +1,4 @@
-export interface RulesList {
+export interface IRulesList {
     "branch-max-length": number;
     "branch-min-length": number;
     "branch-pattern": string;

package/bin/index.d.ts

@@ -1 +1 @@
-export type { BranchLintConfig } from "./domain/interfaces/config.type";
+export type { IBranchLintConfig } from "./domain/type/config.type";