🚀 UPDATE: v0.1.4

Merge pull request #8 from warengonzaga/dev

Author: warengonzaga

.npmrc

@@ -0,0 +1 @@
+engine-strict-true

README.md

@@ -1,12 +1,12 @@
 # Magic Commit 🪄 [![author/maintainer](https://img.shields.io/badge/by-Waren%20Gonzaga-016eea.svg?logo=github&labelColor=181717&longCache=true&style=flat-square)](https://warengonzaga.com) [![nominate](https://img.shields.io/badge/nominate-%20@warengonzaga%20as%20GitHub%20Star-yellow.svg?logo=github&labelColor=181717&longCache=true&style=flat-square)](https://stars.github.com/nominate)
 
-[![made in](https://img.shields.io/badge/made%20in-Open%20Source%20Software%20PH-0060a0.svg?logo=github&longCache=true&labelColor=181717&style=flat-square)](https://github.com/ossphilippines) [![sponsors](https://img.shields.io/badge/sponsor-%E2%9D%A4-%23db61a2.svg?&logo=github&logoColor=white&labelColor=181717&style=flat-square)](https://github.com/sponsors/warengonzaga) [![release](https://img.shields.io/github/release/warengonzaga/magic-commit.svg?logo=github&labelColor=181717&color=green&style=flat-square)](https://github.com/warengonzaga/magic-commit/releases) [![star](https://img.shields.io/github/stars/warengonzaga/magic-commit.svg?&logo=github&labelColor=181717&color=yellow&style=flat-square)](https://github.com/warengonzaga/magic-commit/stargazers) [![license](https://img.shields.io/github/license/warengonzaga/magic-commit.svg?&logo=github&labelColor=181717&style=flat-square)](https://github.com/warengonzaga/magic-commit/blob/main/license) [![NPM Installs](https://img.shields.io/npm/dt/magicc?color=CB3837&logo=npm&label=installs&labelColor=181717&style=flat-square)](https://npmjs.com/package/magicc)
+[![made with](https://img.shields.io/badge/made%20with-Open%20Source%20Software%20PH-0060a0.svg?logo=github&longCache=true&labelColor=181717&style=flat-square)](https://github.com/ossphilippines) [![sponsors](https://img.shields.io/badge/sponsor-%E2%9D%A4-%23db61a2.svg?&logo=github&logoColor=white&labelColor=181717&style=flat-square)](https://github.com/sponsors/warengonzaga) [![release](https://img.shields.io/github/release/warengonzaga/magic-commit.svg?logo=github&labelColor=181717&color=green&style=flat-square)](https://github.com/warengonzaga/magic-commit/releases) [![star](https://img.shields.io/github/stars/warengonzaga/magic-commit.svg?&logo=github&labelColor=181717&color=yellow&style=flat-square)](https://github.com/warengonzaga/magic-commit/stargazers) [![license](https://img.shields.io/github/license/warengonzaga/magic-commit.svg?&logo=github&labelColor=181717&style=flat-square)](https://github.com/warengonzaga/magic-commit/blob/main/license) [![NPM Installs](https://img.shields.io/npm/dt/magicc?color=CB3837&logo=npm&label=installs&labelColor=181717&style=flat-square)](https://npmjs.com/package/magicc)
 
 [![banner](https://raw.githubusercontent.com/warengonzaga/magic-commit/main/.github/assets/repo_banner.jpg)](https://github.com/warengonzaga/magic-commit)
 
 You can do `magicc`, you can build anything that you desire. 🪄🔮💻
 
-**Magic Commit** is a simple and easy-to-use tool that helps you to automatically stage your changes by file and commit them one by one. All you need to do is type `magicc` and accept if you love the suggested commit message in every changed files.
+**Magic Commit** is a simple and easy-to-use tool that helps you to automatically stage your changes by file and commit them one by one. All you need to do is type `magicc` and accept if you love the suggested commit message in every changed files. It uses `gpt-4o-mini` as the default model from OpenAI to generate commit messages. 🪄
 
 Have suggestions in mind? [Let me know!](https://github.com/warengonzaga/magic-commit/issues)
 

contributing.md

@@ -14,6 +14,25 @@ There are many ways to contribute to this open source project. Any contributions
 
 If you can write a code then create a pull request to this repo and I will review your code. Please consider to submit your pull request to the ```dev``` branch. I will auto reject if you submit your pull request to the ```main``` branch.
 
+#### 🔧 Setup
+
+**To install the CLI app** in your working directory, you can run the following command:
+
+```bash
+yarn setup
+```
+
+OR
+
+```bash
+npm run setup
+```
+
+Run the command everytime you make changes to the code. This will build the project and install the CLI app in your working directory. So you can test it out using `magicc` command.
+
+> [!IMPORTANT]  
+> When using the setup command please ensure you are using linux-based OS. This command will use commands tht are only available in linux-based OS. Such as `rm -rf` to delete the `dist` folder.
+
 ### 📖 Documentation
 
 (coming soon)
@@ -24,4 +43,4 @@ For any security bugs or issues, please read the [security policy](./security.md
 
 ---
 
-💻 with ❤️ by [Waren Gonzaga](https://warengonzaga.com) and [Him](https://www.youtube.com/watch?v=HHrxS4diLew&t=44s) 🙏
+💻 with ❤️ by [Waren Gonzaga](https://warengonzaga.com) and [Him](https://www.youtube.com/watch?v=HHrxS4diLew&t=44s) 🙏

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "magicc",
-	"version": "0.1.3",
+	"version": "0.2.0",
 	"author": "Waren Gonzaga",
 	"description": "You can do `magicc`, you can build anything that you desire.",
 	"keywords": [
@@ -22,7 +22,9 @@
 		"build": "babel --out-dir=dist source",
 		"dev": "babel --out-dir=dist --watch source",
 		"clean": "rm -rf dist",
+		"setup": "npm run setup:ubuntu",
 		"setup:ubuntu": "npm run clean && npm run build && npm i -g .",
+		"reset": "npm run reset:ubuntu",
 		"reset:ubuntu": "npm uninstall -g magicc && npm run setup:ubuntu",
 		"test": "prettier --check . && xo && ava"
 	},

source/utils/api.js

@@ -2,12 +2,38 @@ import Conf from 'conf';
 
 const config = new Conf({projectName: 'magicc'});
 
-const setOpenAIKey = (key) => {
-  if (!key.startsWith('sk-') || key.length !== 51) {
-    console.error('Invalid OpenAI API key. Please provide a valid key.');
-  } else {
-    config.set('openai', key);
+async function isValidOpenAIKey(apiKey) {
+  try {
+      const response = await fetch('https://api.openai.com/v1/models', {
+          headers: {
+              'Authorization': `Bearer ${apiKey}`
+          }
+      });
+
+      if (response.status === 200) {
+          return true;
+      } else if (response.status === 401) {
+          console.error('Invalid API key');
+          return false;
+      } else {
+          console.error('Unexpected response status:', response.status);
+          return false;
+      }
+  } catch (error) {
+      console.error('Error while validating API key:', error);
+      return false;
   }
+}
+
+const setOpenAIKey = (key) => {
+  isValidOpenAIKey(key).then(isValid => {
+    if (isValid) {
+        console.log('API key is valid');
+        config.set('openai', key);
+    } else {
+        console.log('API key is invalid');
+    }
+  });
 };
 
 const getOpenAIKey = () => {

source/utils/commit.js

@@ -11,7 +11,7 @@ async function askForCommitMessage() {
   });
 
   if (prompt) {
-    rl.question(`Suggested commit message: ${prompt}\nDo you want to proceed? (y/n) `, (answer) => {
+    rl.question(`Suggested commit message: ${prompt}\nDo you want to proceed? (y/N) `, (answer) => {
       if (answer.toLowerCase() === "y") {
         execa("git", ["commit", "-m", prompt])
           .then(() => {

source/utils/config.json

@@ -1,4 +1,6 @@
 {
-  "emoji": "You are the author of the commit message, your task is to select which category will be used for the current git diff based on changes. Use the following category (prefix name, usage);📦 new, for new files or new features;✨ tweak, for enhancements or updates to the codebase;☕ chore, for updates or changes outside the project code base including README.md;🐞 fix, changes for fixing code bugs and errors. Please reply with the prefix and name of the category you want. No other comments are needed.",
-  "message": "You are the author of the changes, you are going to provide a professional git commit message that is no longer than 25 characters in imperative present tense. Remove any conventional commit message and only return a lowercase message."
+  "emoji": "YYou are the author of the commit message. Your task is to select the appropriate category for the git diff based on the changes. Use the following categories (emoji category name => usage): 📦 new => for new files or new features; ✨ tweak => for enhancements or updates to the codebase; ☕ chore => for updates or changes outside the project codebase, including README.md; 🐞 fix => for fixing code bugs and errors. Please reply with the category name only.",
+  "message": "You are the author of the changes, you are going to provide a professional git commit message that is no longer than 25 characters in imperative present tense. Stricly no emojis are allowed and no conventional commit message as prefix is already provided. For example, instead of 'fix: fix a bug' make it 'fix a bug'. The message should be in lower case and no period at the end.",
+  "default_model": "gpt-4o-mini",
+  "maxDiffSize": 4000
 }

source/utils/openai.js

@@ -17,6 +17,8 @@ async function initGit() {
 
 // git status to see if there are any changes
 // if there's any changes add the first file in the list of changes
+let firstFilePath = '';
+
 async function gitStatus() {
 	try {
 		const { stdout: status } = await execa('git', ['status', '--porcelain']);
@@ -31,8 +33,9 @@ async function gitStatus() {
 					.map(line => line.split(' ').slice(1).join(' ').trim())
 				);
 			// git add the first file in the list of changes
-			await execa('git', ['add', filePaths[0]]);
-			console.log(`${filePaths[0]} has been added to the staging area.`);
+			firstFilePath = filePaths[0];
+			await execa('git', ['add', firstFilePath]);
+			console.log(`${firstFilePath} has been added to the staging area.`);
 		} else {
 			console.log('No changes to commit.');
 			return false;
@@ -55,26 +58,33 @@ async function gitDiff() {
 async function generatePrompt() {
 	const apiKey = await getOpenAIKey();
 	const openai = new OpenAI({apiKey: apiKey});
+	const maxDiffSize = config.maxDiffSize;
+
 	// get the staged changes
 	await initGit();
 	await gitStatus();
 	const gitDiffContent = await gitDiff();
 
+	if (gitDiffContent.length > maxDiffSize) {
+		console.log('Diff content is too large. Skipping OpenAI request.');
+		return `✨ tweak: update ${firstFilePath}`;
+	}
+
 	// use the prompt from the config file emoji and send to openai
 	const category = await openai.chat.completions.create({
 		messages: [
 			{ role: "system", content: config.emoji },
 			{ role: "user", content: gitDiffContent },
 		],
-		model: "gpt-3.5-turbo",
+		model: config.default_model,
 	});
 	// use the prmopt from the config file message and send to openai
 	const message = await openai.chat.completions.create({
 		messages: [
 			{ role: "system", content: config.message },
 			{ role: "user", content: gitDiffContent },
 		],
-		model: "gpt-3.5-turbo",
+		model: config.default_model,
 	});
 
 	if (await gitStatus() !== false) {