dakshsethi / vBOT

This is a CLI tool that works similar to Dependabot, made using node.js

VBot - DYTE SDK Tooling Challenge

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

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

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.

(back to top)

Built With

• Node.js

(back to top)

Getting Started

Prerequisites

• Node.js - install the latest version of it.
• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/dyte-submissions/dyte-vit-2022-dakshsethi

2. Install NPM packages

   npm install

3. In the root directory of your project, create an environment file by the name .env
4. Go to profile page of Github - https://github.com/settings/profile
5. Click on Developer Options in the bottom of the left side-bar.
6. Select Personal access tokens
7. Click on generate new token
8. Enter your GitHub Password
9. Do this as the below image
10. Click on Generate token
11. Copy the Generated Personal Access Token

12. Open the `.env` file and it should look like this [![ENV File][env-file]]()

(back to top)

Usage

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

(back to top)

Roadmap

1. Input File

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:

2. Update PR File

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 vbot-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.

(back to top)

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Daksh Sethi - @sethidaksh02 - [e-mail]

Project Link: https://github.com/dyte-submissions/dyte-vit-2022-dakshsethi

(back to top)