VBot is a command line interface (CLI) tool that can help you manage versions of the packages that are used within your repositories. VBot provides you with 2 simple in-built commands to detect any version anamoly and can send PR to correct it.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
The project can simply be started by calling the CLI name vbot in your terminal. In my case i am using Windows Powershell here. The above screenshot shows the options and the commands of this CLI tool.
- Node.js - install the latest version of it.
- npm
npm install npm@latest -g
- Clone the repo
git clone https://github.com/dyte-submissions/dyte-vit-2022-dakshsethi
- Install NPM packages
npm install
- In the root directory of your project, create an environment file by the name
.env - Go to profile page of Github - https://github.com/settings/profile
- Click on Developer Options in the bottom of the left side-bar.
- Select
Personal access tokens - Click on
generate new token - Enter your GitHub Password
- Do this as the below image
- Click on
Generate token - Copy the Generated Personal Access Token
12. Open the `.env` file and it should look like this [![ENV File][env-file]]()
This is how you can use this CLI tool directly through the terminal.
Open the root directory of the project
cd repo
npm install vbot
npm install -g .After successfull install now the CLI tool can be directly in the terminal.
Open the terminal and type
vbot
Note:
If the above command vbot gives error like this:
Then you can navigate to the root folder and simply type this command
node bin/index.js
This is the 1st command of the SDK Tooling Challenge
Steps:
- Go to project directory
- Paste the CSV file in the root of this directory
- run the below command in the terminal
vbot i input.csv react@17.0.2 This produces this output in the terminal
This generates a CSV file output.csv like this:
Note: This function requires that a fix branch exists right now in the repositories. As i tried working on Creating Branch using GitHub API but due to some errors and technical glitch, it was not working. Also due to lack of time as the project was very tedious, i am able to commit 2 new files with the help of GitHub API and call a PR request but not package.json as of right now. If given enough time, this issue will be resolved later on.
This is the 2nd command of the SDK Tooling Challenge
Steps:
- Go to project directory
- Paste the CSV file in the root of this directory
- run the below command in the terminal
vbot u i input.csv react@17.0.4 This produces following output
The URLs and sha are just for the reference of understanding as multiple back-to-back API calls are fired just to commit and open up a PR in the fix branch.
This can be checked in the Repo Pull page too:
This generates an output1.csv file too:
See the open issues for a full list of proposed features (and known issues).
Note: Basic error handling is made available in the project.
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 with the tag "enhancement". 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.
Daksh Sethi - @sethidaksh02 - sethidaksh02@gmail.com
Project Link: https://github.com/dyte-submissions/dyte-vit-2022-dakshsethi