README.md

Wooff

Cli tool to check and update dependencies.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Installation
3. Usage
   • Checking Installation
   • Entering Arguments
   • Updating Repos
4. Miscellaneous Screenshots
5. Roadmap
6. Contributing
7. License
8. Contact

About The Project

• A fast, reliable way to check and update your dependencies in all your repositories.
• Easy to install and use comman line interface.
• Appealing UI.
• Propper error messages and information prompts.

(back to top)

Built With

• Node.js
• octokit.js
• create-node-cli
• chalk
• cli-alerts
• cli-handle-unhandled
• cli-meow-help
• cli-welcome
• csv-parse
• github-url-to-object
• inquirer
• loading-cli
• meow
• simple-git

(back to top)

Installation

• npm

  npm install wooff -g

• yarn

  yarn add wooff -g

• Add sudo before the code if facing error due to system permissions
• Enter system password if prompted

(back to top)

Usage

Checking Installation

To confirm if wooff is installed

• run

  wooff

• or

  wooff -v

Entering Arguments

cd to the directory where the csv file is located

• run

  wooff -c [CSV File Name].csv -p [Package Name]@[Package Version]

  Enter your GitHub Personal Access Token in the prompt
  Creating a Personal Access Token

• Example CSV File

• example input

  wooff -c csv.csv -p [email protected]

• example output
  

Updating Repos

Add the -u flag to send Pull requests to the repositories with updated package version

• run

  wooff -c [CSV File Name].csv -p [Package Name]@[Package Version] -u

• Example CSV File

• example input

  wooff -c csv.csv -p [email protected] -u

• example output
  

(back to top)

Miscellaneous Screenshots

• loading
  

• error handling
  
  

  
  

  
  

  

(back to top)

Roadmap

• One time GitHub authentication
• Automatic dependency checker
  • Dependency update notifications
  • Automatic Pull requests
• Configuration options
• Allowing package@latest as argument

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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. See LICENSE.txt for more information.

(back to top)

Contact

Shashwat Gupta (shashtag) - @ShashTagZero - [email protected]

Project Links: https://github.com/dyte-submissions/dyte-vit-2022-shashtag
https://www.npmjs.com/package/wooff

(back to top)