Package: npmvaliddep
NPMVALIDDEPCLI tool made in python to check and update the npm package dependencies in github repositoriesExplore the docs »View Demo·Report Bug·Request FeatureTable of ContentsAbout The ProjectBuilt WithGetting StartedPrerequisitesInstallationUsageContributingLicenseContactAcknowledgmentsAbout The ProjectNPMVALIDDEP is a cli tool made in python used to check the version of NPM packages in a github repository of NodeJs project. You can specify multiple packages to check and also specify if you want to raise a PR in case the packages are not up-to-date. It works for public as well as private repositories (provided that you are authorised to access the repository), in case you are the owner of the repository then instead of raising a PR it will directly commit to the repository main brach.(back to top)Built WithPython(back to top)Getting StartedBelow listed are the detailed steps to install the package with the prereqisites required.PrerequisitesYou need to have following things installed:Pip (Package Installer for python)GitNode and npmInstallationCreate a python virtual environment and install the npmvaliddep package using pipproject_urlpipinstallnpmvaliddep(back to top)UsageIn order to ensure that you can access the private repositories, you need to add your github username andauthentication token(Don't worry we store your token locally and never reveal it even to you :sunglasses:)To check your cofigured github username and password:npmvaliddep--getgithubcredsTo configure your cofigured github username and password:npmvaliddep--setgithubcredsTo check if the stored password matched your password:npmvaliddep--matchgithubpassTo perform dependency check of multiple github repositories and packages:(Required) Create a csv file with the following headers and enter the rows accordingly.(Required) Specify the path to the csv using --check flagnpmvaliddep--check'/home/user/checkrepos.csv'(Required) Specify the dependencies you need to check using the --deps flagnpmvaliddep--check'/home/user/checkrepos.csv'--depsaxios@0.23.0cookie-parser@1.4.6(Optional) By default the output csv will be generated in the user home directory but if you want to change that you can specify the path using --output flagnpmvaliddep--check'/home/user/checkrepos.csv'--depsaxios@0.23.0cookie-parser@1.4.6--output'/home/user/Downloads/output.csv'(Optional) If you waant to generate a PR to update the dependencies then you can pass a --createpr flagnpmvaliddep--check'/home/user/checkrepos.csv'--depsaxios@0.23.0cookie-parser@1.4.6--output'/home/user/Downloads/output.csv'--createprNote -In the above image you can notice that the last repository belongs to me i.e. the user of the CLI, in this case the tool will not create a PR but will directly commit the changes to the main branch of the repository. Also note that if a repository is private and the user is not authorised to access it then the tool will skip that repository.(back to top)ContributingContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make aregreatly 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!Fork the ProjectCreate your Feature Branch (git checkout -b feature/AmazingFeature)Commit your Changes (git commit -m 'Add some AmazingFeature')Push to the Branch (git push origin feature/AmazingFeature)Open a Pull Request(back to top)LicenseDistributed under the MIT License. SeeLICENSE.txtfor more information.(back to top)ContactAkshat Gupta -@linkedin_handle-Mail meProject Link:https://github.com/dyte-submissions/dyte-vit-2022-Akshat1903(back to top)AcknowledgmentsI would like to thank dyte recruitment team to give this challenging task and focusing on the other half of the students who don't only crave for DSA :wink:(back to top)