Checkmate

project_description
Explore the docs »

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

About The Project

[] Checkmate is a CLI tool that helps the user to keep a track for various versions of a specific dependecy and verify if the version being used is the required one. Version if unsatisfied can be upgraded to a mentioned version by changing the same in package.json file. Checkmate therefore is helpful in large project where number of projects handled is huge. It eliminates the need to manually check versions in each project and automates the task, making it easieer and faster.

(back to top)

Built With

• Node JS
• Intellegence & Patience

(back to top)

Getting Started

checkmate -u -i filename.csv dependency@version

• checkmate - main command that triggers the cli
• -u or -- update - to update the version in package.json and create a pull request for update.
• -i or --inspect - to check the version of dependency with the dependecies in each project mentioned in filename.csv

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• Any flavour of Linux (OS)

Installation

1. Clone the repo

   git clone https://github.com/CyberneTech/Checkmate

2. Install NPM packages

   npm install

3. Get a Github Access Token for authorization

4. Enter the following command in terminal

   export  AUTH_TOKEN="github_access_token"

5. place CSV file with project links in project root directory

6. Enter command to run cli

   checkmate -i filename.csv dependency@version

(back to top)

Usage

1. To keep a check of versions of various dependencies involved in a project, specially if the project has large number of dependencies involved
2. Keep versions up to date (no downgrade possible)

(back to top)

Roadmap

• Passing multiple dependencies in single command
• Added customization to functions
• Check compatibity of the versions before update
• Aviod updating to deprecated versions or if code contains deprecated functions of older dependency versions See the open issues for a full list of proposed features (and known issues).

(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)

Contact

Shruti Jain- [email protected]

Contact me at: Linkedin,

(back to top)