git-interactive-vlaqa 1.0.0

package/README.md

@@ -0,0 +1,81 @@
+# git-interactive
+
+A collection of interactive CLI commands for common Git workflows, built on [Conventional Commits](https://www.conventionalcommits.org/).
+
+## Prerequisites
+
+- Node.js
+
+## Installation
+
+```bash
+npm install -g git-interactive
+```
+
+---
+
+## Commands
+
+### `gicm` — Interactive Commit
+
+Creates a Conventional Commit via guided prompts. Requires staged changes.
+
+```bash
+gicm
+```
+
+#### Interactive Prompts
+
+**1. Commit type**
+
+| Type | Description |
+|------|-------------|
+| `feat` | New feature |
+| `test` | Test additions or changes |
+| `fix` | Bug fix |
+| `chore` | Maintenance tasks |
+| `refactor` | Code restructuring without behavior change |
+| `docs` | Documentation changes |
+| `style` | Formatting, whitespace, etc. |
+
+**2. Scope** *(optional)*
+
+| Option | Description |
+|--------|-------------|
+| `branch` | Uses the current branch name as scope |
+| `e2e` | Literal scope `e2e` |
+| `api` | Literal scope `api` |
+| `omit` | No scope |
+| `custom` | Prompts for a custom scope string |
+
+**3. Description**
+
+A short description of the change. Must be at least 5 characters. A live character counter (`[n/75]`) is shown while typing.
+
+#### Output format
+
+```
+<type>(<scope>): <description>
+```
+
+Examples:
+
+```
+feat(my-branch): add user authentication
+fix: resolve null pointer on login
+chore(api): update dependencies
+```
+
+After a successful commit, the short hash and subject are printed:
+
+```
+✔ Committed: a1b2c3d feat(my-branch): add user authentication
+```
+
+#### Error handling
+
+| Condition | Message |
+|-----------|---------|
+| Not inside a Git repository | `Make sure you are calling commands from GIT project!` |
+| No staged files | `No staged files. Stage your changes with \`git add\` first.` |
+| Prompt cancelled (`Ctrl+C`) | `👋 until next time!` |

package/bin/gia

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../dist/index.js')

package/bin/gicm

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../dist/index.js')

package/dist/add.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.add = void 0;
+const git_1 = require("./git");
+const gitError_1 = require("./errors/gitError");
+class Add {
+    gitBase;
+    constructor(gitBase = git_1.git) {
+        this.gitBase = gitBase;
+    }
+    async run(workdir) {
+        if (!this.gitBase.isInsideGitProject(workdir).ok)
+            throw new gitError_1.GitError('Make sure you are calling commands from GIT project!');
+        // TODO: implement interactive git add
+        throw new Error('Not implemented');
+    }
+}
+exports.add = new Add();

package/dist/commit.d.ts

@@ -0,0 +1,11 @@
+import { git } from './git';
+declare class Commit {
+    private gitBase;
+    constructor(gitBase?: typeof git);
+    private gitArgs;
+    ask(workdir: string): Promise<string>;
+    call(workdir: string): Promise<void>;
+}
+export declare const commit: Commit;
+export {};
+//# sourceMappingURL=commit.d.ts.map

package/dist/commit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commit.d.ts","sourceRoot":"","sources":["../src/commit.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAG5B,cAAM,MAAM;IACI,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,OAAO,GAAS;IAC7C,OAAO,CAAC,OAAO,CAGb;IAEW,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA+BrC,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAWpD;AAED,eAAO,MAAM,MAAM,QAAe,CAAC"}

package/dist/commit.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commit = void 0;
+const prompts_1 = require("@inquirer/prompts");
+const git_1 = require("./git");
+const errors_1 = require("./errors");
+class Commit {
+    gitBase;
+    constructor(gitBase = git_1.git) {
+        this.gitBase = gitBase;
+    }
+    async promptMessage(workdir) {
+        const wrap = (s) => s ? `(${s})` : '';
+        const type = await (0, prompts_1.rawlist)({
+            message: 'Select commit type:',
+            choices: ['feat', 'test', 'fix', 'chore', 'refactor', 'docs', 'style'],
+        });
+        const scopeAnswer = await (0, prompts_1.rawlist)({
+            message: 'Select commit scope:',
+            choices: ['branch', 'e2e', 'api', 'omit', 'custom'],
+        });
+        let scope = '';
+        if (scopeAnswer === 'branch') {
+            const branch = this.gitBase.ok(workdir, ['branch', '--show-current']);
+            if (!branch.ok)
+                throw new errors_1.GitError(`Could not get branch name: ${branch.out}`);
+            scope = wrap(branch.out);
+        }
+        else if (scopeAnswer === 'custom') {
+            scope = wrap(await (0, prompts_1.input)({ message: 'Provide custom scope:' }));
+        }
+        const description = await (0, prompts_1.input)({
+            message: 'Provide commit description:',
+            transformer: (v) => `\x1b[32m[${v.length}/75]\x1b[0m ${v}`,
+            validate: (v) => v.trim().length > 5 || 'Description should be 5 characters long!',
+        });
+        return `${type}${scope}: ${description.trim()}`;
+    }
+    async run(workdir) {
+        if (!this.gitBase.isInsideGitProject(workdir).ok)
+            throw new errors_1.GitError('Make sure you are calling commands from GIT project!');
+        const staged = this.gitBase.ok(workdir, ['diff', '--cached', '--name-only']);
+        if (!staged.ok || staged.out.trim() === '')
+            throw new errors_1.GitError('No staged files. Stage your changes with `git add` first.');
+        const message = await this.promptMessage(workdir);
+        const result = this.gitBase.ok(workdir, ['commit', '-m', message]);
+        if (!result.ok)
+            throw new errors_1.GitError(`Failed to commit: ${result.out}`);
+        const log = this.gitBase.ok(workdir, ['log', '-1', '--pretty=format:%h %s']);
+        console.log(`\n\x1b[32m✔ Committed:\x1b[0m ${log.out}`);
+    }
+}
+exports.commit = new Commit();

package/dist/commit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commit.js","sourceRoot":"","sources":["../src/commit.ts"],"names":[],"mappings":";;;AAAA,+CAAmD;AACnD,+BAA4B;AAC5B,gDAA6C;AAE7C,MAAM,MAAM;IACY;IAApB,YAAoB,UAAsB,SAAG;QAAzB,YAAO,GAAP,OAAO,CAAkB;IAAG,CAAC;IACzC,OAAO,GAAG;QACd,MAAM,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;QACpC,MAAM,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC;KACzD,CAAC;IAEK,KAAK,CAAC,GAAG,CAAC,OAAe;QAC5B,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,sCAAsC;QAEtC,MAAM,IAAI,GAAG,MAAM,IAAA,iBAAO,EAAC;YACvB,OAAO,EAAE,qBAAqB;YAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC;SACzE,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,IAAA,iBAAO,EAAC;YAC9B,OAAO,EAAE,sBAAsB;YAC/B,OAAO,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC;SACvD,CAAC,CAAC;QAEH,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC3B,KAAK,GAAG,QAAQ,CAAC,MAAM,IAAA,eAAK,EAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC,CAAC,CAAC;QACxE,CAAC;aAAM,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;YAClC,MAAM,UAAU,GAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAClE,IAAI,CAAC,UAAU,CAAC,EAAE;gBAAE,MAAM,IAAI,mBAAQ,CAAC,4BAA4B,CAAC,CAAC;YAErE,KAAK,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;aAAM,IAAI,WAAW,KAAK,OAAO,EAAE,CAAC;YACjC,KAAK,GAAG,EAAE,CAAC;QACf,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,IAAA,eAAK,EAAC;YACxB,OAAO,EAAE,6BAA6B;SACzC,CAAC,CAAC;QAEH,OAAO,GAAG,IAAI,GAAG,KAAK,KAAK,OAAO,EAAE,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,OAAe;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,EAAE;YAC5C,MAAM,IAAI,mBAAQ,CAAC,sDAAsD,CAAC,CAAC;QAE/E,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAExC,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAE7E,IAAI,CAAC,aAAa,CAAC,EAAE;YAAE,MAAM,IAAI,mBAAQ,CAAC,mBAAmB,CAAC,CAAC;IACnE,CAAC;CAEJ;AAEY,QAAA,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC"}

package/dist/errors/gitError.d.ts

@@ -0,0 +1,4 @@
+export declare class GitError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=gitError.d.ts.map

package/dist/errors/gitError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitError.d.ts","sourceRoot":"","sources":["../../src/errors/gitError.ts"],"names":[],"mappings":"AAAA,qBAAa,QAAS,SAAQ,KAAK;gBACnB,OAAO,EAAE,MAAM;CAI9B"}

package/dist/errors/gitError.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitError = void 0;
+class GitError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'GitError';
+    }
+}
+exports.GitError = GitError;

package/dist/errors/gitError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitError.js","sourceRoot":"","sources":["../../src/errors/gitError.ts"],"names":[],"mappings":";;;AAAA,MAAa,QAAS,SAAQ,KAAK;IAC/B,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;IAC3B,CAAC;CACJ;AALD,4BAKC"}

package/dist/errors/index.d.ts

@@ -0,0 +1,2 @@
+export { GitError } from './gitError';
+//# sourceMappingURL=index.d.ts.map

package/dist/errors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}

package/dist/errors/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExitPromptError = exports.GitError = void 0;
+var gitError_1 = require("./gitError");
+Object.defineProperty(exports, "GitError", { enumerable: true, get: function () { return gitError_1.GitError; } });
+var core_1 = require("@inquirer/core");
+Object.defineProperty(exports, "ExitPromptError", { enumerable: true, get: function () { return core_1.ExitPromptError; } });

package/dist/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA"}

package/dist/git.d.ts

@@ -0,0 +1,14 @@
+declare class Git {
+    private call;
+    ok(workdir: string, args: string[]): {
+        ok: boolean;
+        out: string;
+    };
+    isInsideGitProject(workdir: string): {
+        ok: boolean;
+        out: string;
+    };
+}
+export declare const git: Git;
+export {};
+//# sourceMappingURL=git.d.ts.map

package/dist/git.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"git.d.ts","sourceRoot":"","sources":["../src/git.ts"],"names":[],"mappings":"AAEA,cAAM,GAAG;IACL,OAAO,CAAC,IAAI;IAIL,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE;IAgBjE,kBAAkB,CAAC,OAAO,EAAE,MAAM;YAhBS,OAAO;aAAO,MAAM;;CAmBzE;AAED,eAAO,MAAM,GAAG,KAAY,CAAC"}

package/dist/git.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.git = void 0;
+const child_process_1 = require("child_process");
+class Git {
+    call(workdir, args) {
+        return (0, child_process_1.execFileSync)('git', args, { cwd: workdir, encoding: 'utf8', stdio: 'pipe' }).trim();
+    }
+    ok(workdir, args) {
+        try {
+            return { ok: true, out: this.call(workdir, args) };
+        }
+        catch (e) {
+            const err = e;
+            const stderr = typeof err.stderr === 'string' ? err.stderr : (err.stderr?.toString() ?? '');
+            const stdout = typeof err.stdout === 'string' ? err.stdout : (err.stdout?.toString() ?? '');
+            return { ok: false, out: (stderr || stdout || err.message).trim() };
+        }
+    }
+    isInsideGitProject(workdir) {
+        return this.ok(workdir, ['rev-parse', '--is-inside-work-tree']);
+    }
+}
+exports.git = new Git();

package/dist/git.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"git.js","sourceRoot":"","sources":["../src/git.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAE7C,MAAM,GAAG;IACG,IAAI,CAAC,OAAe,EAAE,IAAc;QACxC,OAAO,IAAA,4BAAY,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/F,CAAC;IAEM,EAAE,CAAC,OAAe,EAAE,IAAc;QACrC,IAAI,CAAC;YACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;QACvD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,GAAG,GAAG,CAIX,CAAC;YACF,MAAM,MAAM,GAAG,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5F,MAAM,MAAM,GAAG,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YAE5F,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM,KAAK,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;QAC7E,CAAC;IACL,CAAC;IAEM,kBAAkB,CAAC,OAAe;QACrC,OAAO,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC,CAAC;IACpE,CAAC;CACJ;AAEY,QAAA,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const commit_1 = require("./commit");
+const errors_1 = require("./errors");
+const add_1 = require("./add");
+const command = path_1.default.basename(process.argv[1] ?? '');
+(async () => {
+    const workdir = process.cwd();
+    switch (command) {
+        case 'gicm':
+            await commit_1.commit.run(workdir);
+            break;
+        case 'gia':
+            await add_1.add.run(workdir);
+            break;
+        default: console.log(`Unknown command: ${command}`);
+    }
+})().catch((error) => {
+    if (error instanceof errors_1.ExitPromptError) {
+        console.log('👋 until next time!');
+    }
+    else if (error instanceof Error) {
+        console.error(`❌ ${error.message}`);
+        process.exitCode = 1;
+    }
+    else {
+        console.error('Unexpected error:', error);
+        process.exitCode = 1;
+    }
+});

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,qCAAkC;AAElC,CAAC,KAAK,IAAI,EAAE;IACR,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QAE9B,MAAM,eAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC;AAEL,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1C,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,KAAK,EAAE,EAAE;IACtC,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC7D,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC7D,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7C,CAAC;SAAM,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACnE,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "git-interactive-vlaqa",
+  "version": "1.0.0",
+  "description": "Interactive Git CLI",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "bin": {
+    "gicm": "./bin/gicm",
+    "gia": "./bin/gia"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/VladimirLQA/git_utils.git"
+  },
+  "keywords": [],
+  "author": "Volodymyr Lazurenko",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/VladimirLQA/git_utils/issues"
+  },
+  "homepage": "https://github.com/VladimirLQA/git_utils#readme",
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@eslint/json": "^2.0.0",
+    "@eslint/markdown": "^8.0.2",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@types/node": "^25.9.3",
+    "eslint": "^10.5.0",
+    "globals": "^17.6.0",
+    "jiti": "^2.7.0",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.61.0"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^8.5.2"
+  }
+}