📦 git-flow-js
git-flow-js
is a CLI tool that simplifies branch management in Git. It automates common workflows and maintains a consistent branch structure.
🚀 Installation
Install it globally with npm:
npm install -g git-flow-js
`
Or clone it and Link it locally for development:
git clone https://github.com/jaime00/git-flow-js.git
cd git-flow-js
npm install
npm link
⚙️ Usage
Run the main command from the root of your Git repository:
git-flow-js
or
gfjs
🧰 Available Commands
Command | Description |
---|---|
git-flow-js , gfjs , asd |
Run the interactive flow to manage branches (note: asd is a special Easter egg 🥚) |
-version , -v |
Display the installed version |
-help , -h (under construction 🚧) |
Display help or usage information |
📁 Project Structure
The project is organized in a modular fashion for easy maintenance and extension. The main directory and file structure is detailed below:
git-flow-js/
├── src/
│ ├── actions/
│ │ ├── createOriginalBranch.js
│ │ ├── createTemporalBranch.js
│ │ └── createBranchName.js
│ ├── getters/
│ │ ├── getCurrentPackageVersion.js
│ │ ├── getBranchType.js
│ │ ├── getTicketOfJIRA.js
│ │ ├── getEnviroment.js
│ │ └── getCurrentBranch.js
│ └── utils/
│ └── validateTicketOfJIRA.js
├── index.js
├── build.js
├── package.json
└── README.md
🛠️ Contribute
Contributions welcome! To get started:
git clone https://github.com/jaime00/git-flow-js.git
cd git-flow-js
npm install
npm link
git-flow-js # or use the abbreviated version with gfjs or asd
Please open an issue to report bugs or suggest improvements.
📝 License
Distributed under the MIT License.
📬 Contact
- 🌐 Portfolio: Visit my website
- 💼 LinkedIn: linkedin.com/in/jaime00
- 📧 Email: imjaimetorresv@gmail.com
- 🐙 GitHub: github.com/jaime00
For contributions, bug reports, or suggestions, please open an issue in the repository.