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.

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

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

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 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 input

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

• example output

Miscellaneous Screenshots

• loading

• error handling

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

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

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

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

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