Table of Contents
My motivation for creating node-git was to understand the ins and outs of Git.
This project implements only necessary functionalities of Git such as add, commit, checkout, status, log, and many more commands used to manage file versions and internals objects, providing all the necessary Git's commands You are using on day-to-day basis.
All commands were modeled after the original Git commands in terms of their behavior, parameters and names. Not all of them have their full original options support due to the fact that Git is a very powerful tool, and mapping it completely in Node,js goes beyond the scope of my original premise of keeping this project simple.
Object files are stored in .node-git folder in your repository (after initialization).
node-git is compatible with git's files such as .gitignore and uses git's config files, so you don't need to configure it if You are already using Git.
Some of git's internal logic has been omitted due to lack of need or due to the sophistication of the functionality in question. In the future, the following list may change, and the given differences may be introduced to node-git
- node-git do not use 32-bit ctime/mtime nanosecond fractions in INDEX file, only the 32-bit seconds
- node-git only supports v2 INDEX file.
You can read more details about INDEX file here
Requires Node v20+
npm i @trolxu/node-git -g- Initialize node-git repository
node-git init- Add changes to the INDEX file
node-git add file.txt
node-git status # check status of INDEX and working tree- Commit changes
node-git commit -m "First node-git commit!"- That's it! You can verify added files by running the following commands
node-git ls-files --verbose # show detailed information about INDEX and working tree
node-git log # show commit historynode-git help [command]The following functionalities are currently under development
- Remote repository support
- Remote command
- Clone
- Push
- Pull
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Hubert Lipiński - [email protected]
Project Link: https://github.com/HubertLipinski/node-git