commit-sense-cli 1.0.1 → 1.1.0

package/README.md

@@ -15,7 +15,7 @@ CommitSense helps developers write accurate, meaningful, and semantically correc
 ## Installation
 
 ```bash
-npm install -g commit-sense
+npm install -g commit-sense-cli
 ```
 
 ## Usage
@@ -29,7 +29,7 @@ git add .
 Run CommitSense instead of `git commit`:
 
 ```bash
-commit-sense
+commit-sense-cli
 ```
 
 Follow the interactive prompts to confirm or edit the commit message.
@@ -41,3 +41,21 @@ Follow the interactive prompts to confirm or edit the commit message.
 3. Build: `npm run build`
 4. Run locally: `npm run dev` (or `node bin/commitsense.js`)
 
+## Optional: Enforce Commit Convention
+
+You can use `commit-sense-cli` to validate commit messages with git hooks (e.g., using **Husky**).
+
+1. Install Husky:
+```bash
+npm install --save-dev husky
+npx husky init
+```
+
+2. Add a `commit-msg` hook:
+```bash
+echo "npx commit-sense-cli validate \$1" > .husky/commit-msg
+```
+
+Now, if you try to commit with an invalid message (e.g., `git commit -m "bad message"`), it will be rejected.
+
+

package/dist/analysis/validator.d.ts

@@ -0,0 +1,5 @@
+export interface ValidationResult {
+    isValid: boolean;
+    errors: string[];
+}
+export declare function validateCommitMessage(message: string): ValidationResult;

package/dist/analysis/validator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCommitMessage = validateCommitMessage;
+function validateCommitMessage(message) {
+    const errors = [];
+    const conventionalCommitRegex = /^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\(.+\))?: .+$/;
+    const firstLine = message.split('\n')[0];
+    if (!conventionalCommitRegex.test(firstLine)) {
+        errors.push('Commit message must follow format: type(scope): subject');
+        errors.push('Example: feat(auth): add login support');
+        errors.push('Allowed types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert');
+    }
+    return {
+        isValid: errors.length === 0,
+        errors
+    };
+}

package/dist/index.js

@@ -9,7 +9,55 @@ const git_1 = require("./utils/git");
 const classifier_1 = require("./analysis/classifier");
 const scope_1 = require("./analysis/scope");
 const child_process_1 = require("child_process");
+const validator_1 = require("./analysis/validator");
+const fs_extra_1 = __importDefault(require("fs-extra"));
 async function main() {
+    // 0. Handle Validation Command
+    const args = process.argv.slice(2);
+    if (args.length > 0 && (args[0] === 'validate' || args[0] === '--validate')) {
+        const msgFile = args[1];
+        if (!msgFile) {
+            console.error(chalk_1.default.red('Error: Commit message file path required for validation.'));
+            process.exit(1);
+        }
+        try {
+            const msg = await fs_extra_1.default.readFile(msgFile, 'utf-8');
+            const result = (0, validator_1.validateCommitMessage)(msg);
+            if (!result.isValid) {
+                console.error(chalk_1.default.red('Invalid Commit Message:'));
+                result.errors.forEach(e => console.error(chalk_1.default.yellow(` - ${e}`)));
+                // Provide Suggestions
+                try {
+                    const stagedFiles = await (0, git_1.getStagedFiles)();
+                    if (stagedFiles.length > 0) {
+                        const fileChanges = await Promise.all(stagedFiles.map(async (file) => ({
+                            path: file,
+                            diff: await (0, git_1.getStagedFileDiff)(file)
+                        })));
+                        const classification = await (0, classifier_1.classifyChanges)(fileChanges);
+                        const suggestedScope = (0, scope_1.detectScope)(stagedFiles);
+                        console.log(chalk_1.default.cyan('\n----------------------------------------'));
+                        console.log(chalk_1.default.cyan('🤖 CommitSense Suggestion:'));
+                        console.log(chalk_1.default.green(`${classification.type}${suggestedScope ? `(${suggestedScope})` : ''}: <description>`));
+                        console.log(chalk_1.default.gray(`Reason: ${classification.reason}`));
+                        console.log(chalk_1.default.cyan('----------------------------------------\n'));
+                    }
+                }
+                catch (err) {
+                    // Ignore analysis errors during validation to avoid noise
+                }
+                process.exit(1);
+            }
+            else {
+                console.log(chalk_1.default.green('Commit message is valid.'));
+                process.exit(0);
+            }
+        }
+        catch (error) {
+            console.error(chalk_1.default.red(`Error reading commit message file: ${msgFile}`), error);
+            process.exit(1);
+        }
+    }
     console.log(chalk_1.default.cyan('CommitSense - Smart Commit Wizard'));
     // 1. Get staged files
     const stagedFiles = await (0, git_1.getStagedFiles)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commit-sense-cli",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "",
   "main": "dist/index.js",
   "bin": {
@@ -19,7 +19,8 @@
   "scripts": {
     "test": "jest",
     "build": "tsc",
-    "dev": "ts-node src/index.ts"
+    "dev": "ts-node src/index.ts",
+    "prepare": "husky"
   },
   "repository": {
     "type": "git",
@@ -34,9 +35,11 @@
   },
   "homepage": "https://github.com/abhishekpanda0620/commit-sense#readme",
   "dependencies": {
+    "@types/fs-extra": "^11.0.4",
     "@types/node": "^25.2.3",
     "chalk": "^5.6.2",
     "commander": "^14.0.3",
+    "fs-extra": "^11.3.3",
     "prompts": "^2.4.2",
     "simple-git": "^3.30.0",
     "ts-node": "^10.9.2",
@@ -45,6 +48,7 @@
   "devDependencies": {
     "@types/jest": "^30.0.0",
     "@types/prompts": "^2.4.9",
+    "husky": "^9.1.7",
     "jest": "^30.2.0",
     "ts-jest": "^29.4.6"
   }