stupid-dependency-tracker v0.0.1

About The Project

A command line tool for checking dependency versions across npm packages.

So you might have a question

What's about this name stupid-dependency-tracker? Why is it called that?

Yeah, you guessed right it's a stupid tool that updates dependencies of open source projects built with npm, it does not care about your personal projects.

However it's a great tool for checking out the versions of your dependencies against a set version.

Getting Started

Two ways to use this tool:

• Build Locally
• Install and Run Globally

Prerequisites

Please install and configure the following before building or running this tool:

• Node.js
• NPM
• Git (Getting Started)
• Github Personal Access Token (required for creating pull requests)

Installation

Build Locally

1. Clone the repository

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

2. Navigate to the project root directory and install dependencies

   npm install

3. Export the tool to global node_modules

sudo npm link

4. You are ready to use the tool!

   stdt --help

Example

1. Execute the following command while in the project root directory to compare versions

   stdt -i index.csv axios@0.23.0

2. Execute the following command to make a pull request

   stdt -u -i index.csv axios@0.23.0

Install and Run Globally

1. Install the tool globally

   npm install -g stupid-dependency-tracker

2. Now update the packages and create pull requests !!!

   stdt --help

Example

1. Get the path to csv file and then run the command to check dependency

   stdt -i <pathToCSVFile> <packagename>@<version>

2. Run the following command to update the package and create a pull request

   stdt -u -i <pathToCSVFile> <packagename>@<version>

   or

   stdt --update -i <pathToCSVFile> <packagename>@<version>

Format of CSV File

```
repo,name
<repo_url>, <project_name>
```

Outputs

1. Output for only dependency check

2. Output for update and create pull request

Usage

1. Use this tool to check the versions of dependencies across any project or multiple projects.
2. This tool now supports pull requests for opensource projects with package.json.
3. This tool creates pull request on behalf of the user.
4. It is not designed to make pull requests for your own repositories as of now.

Roadmap

• Add support to check private repositories
• Add support to update dependencies for user on their own repositories

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

Running Tests

1. Tests are in the test directory.
2. Run the tests with npm test before submitting a pull request.

npm test

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

License

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

Acknowledgments

• Dyte