Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
bc0871f
Setting up GitHub Classroom Feedback
github-classroom[bot] May 30, 2022
56c629a
feat: -i arg parse
May 30, 2022
dbaf19e
feat: read csv from given path
May 30, 2022
6239181
feat:github auth key storage
May 30, 2022
f1e371b
feat:add auth key and fetch package.json
May 30, 2022
713d781
feat:read csv and featch
May 30, 2022
1a50fca
feat:check version and compare
May 30, 2022
ca26706
feat:check if user is collaborator in repo
May 31, 2022
680524b
feat:commit pkg.json
May 31, 2022
775509d
feat:create branch
May 31, 2022
238fbeb
feat:commit change to created branch
May 31, 2022
4f4b4ac
fix: version comparison
May 31, 2022
a1b5d32
fix: links return
May 31, 2022
53678ce
feat:make upgrade table
May 31, 2022
51543d0
feat:take user email input for user with multiple emails
May 31, 2022
84bd807
fix:create updated table index
May 31, 2022
10d5b1b
fix:change name to biryani 😎
May 31, 2022
67a1da9
feat:add help argument
May 31, 2022
8af9817
fix:remove unused libs
May 31, 2022
b20a2c7
feat:add image for readme
Jun 1, 2022
3fe0511
feat:add image for help
Jun 1, 2022
166c26a
Update README.md
devashar13 Jun 1, 2022
4c9cc7b
fix:unused packages
Jun 1, 2022
7a50911
Merge branch 'main' of github.com:dyte-submissions/dyte-vit-2022-deva…
Jun 1, 2022
665ee86
fix:remove csv file
Jun 1, 2022
879e364
Update README.md
devashar13 Jun 1, 2022
604c627
fix:convert esm to cjs
Jun 1, 2022
5eaa953
Merge branch 'main' of github.com:dyte-submissions/dyte-vit-2022-deva…
Jun 1, 2022
375fa66
fix:cli expo
Jun 1, 2022
325a272
delete:main.js
Jun 1, 2022
2cf7885
Update README.md
devashar13 Jun 1, 2022
f21e536
Update README.md
devashar13 Jun 1, 2022
45fc7d4
Update README.md
devashar13 Jun 1, 2022
02a778a
fix:readme links
Jun 1, 2022
fbf3658
fix:readme install
Jun 1, 2022
f308021
fix:same version result
Jun 1, 2022
3124fbd
fix:version change
Jun 1, 2022
06d31e0
fix:get default branch
Jun 1, 2022
1f82ed1
update version
Jun 1, 2022
d4d24df
fix:same name branch error
Jun 1, 2022
7fffeea
fix:table column width
Jun 1, 2022
d6f9cec
sample csv
Jun 1, 2022
5de1fa5
sample csv name
Jun 1, 2022
05e43f9
Update README.md
devashar13 Jun 1, 2022
b5ff767
update
Jun 1, 2022
206baa9
update
Jun 1, 2022
510e5d2
Merge branch 'main' of github.com:dyte-submissions/dyte-vit-2022-deva…
Jun 1, 2022
bbb4fa8
fix:default branch
Jun 1, 2022
3d5ada0
version update
Jun 1, 2022
86ff01e
fix:pr title
Jun 1, 2022
f64a178
Update README.md
devashar13 Jun 14, 2022
fcfc0bf
Major documentation update
Frixoe Nov 23, 2022
1081aaf
Merge pull request #2 from Frixoe/docs-update
devashar13 Nov 23, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
**/node_modules
.vscode/
143 changes: 60 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,26 @@
[![Open in Visual Studio Code](https://classroom.github.com/assets/open-in-vscode-c66648af7eb3fe8bc4f294546bfd86ef473780cde1dea487d3c4ff354943c9ae.svg)](https://classroom.github.com/online_ide?assignment_repo_id=7943761&assignment_repo_type=AssignmentRepo)
<div id="top"></div>
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Don't forget to give the project a star!
*** Thanks again! Now go create something AMAZING! :D
-->



<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]



<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/github_username/repo_name">
<img src="images/logo.png" alt="Logo" width="80" height="80">
<a href="dyte-submissions/dyte-vit-2022-devashar13">
<img src="https://i.postimg.cc/XJXTMMXZ/image.png" alt="Logo">
</a>

<h3 align="center">project_title</h3>
<h3 align="center">Biryani CLI</h3>

<p align="center">
project_description
A tool to manage all your dependencies.
<br />
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
<a href="https://github.com/dyte-submissions/dyte-vit-2022-devashar13"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/github_username/repo_name">View Demo</a>
<a href="https://github.com/dyte-submissions/dyte-vit-2022-devashar13">View Demo</a>
·
<a href="https://github.com/github_username/repo_name/issues">Report Bug</a>
<a href="https://github.com/dyte-submissions/dyte-vit-2022-devashar13/issues">Report Bug</a>
·
<a href="https://github.com/github_username/repo_name/issues">Request Feature</a>
<a href="https://github.com/dyte-submissions/dyte-vit-2022-devashar13/issues">Request Feature</a>
</p>
</div>

Expand Down Expand Up @@ -78,34 +52,28 @@
</ol>
</details>



<!-- ABOUT THE PROJECT -->
## About The Project
<p align="center">
<img src="https://i.postimg.cc/yx8WC8cm/biryanihelp.png" alt="Logo">
</p>

[![Product Name Screen Shot][product-screenshot]](https://example.com)

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`

<p align="right">(<a href="#top">back to top</a>)</p>


**Biryani** is a tool created to manage dependecies of your github repositories without locally installing any of them . Given the current version of a dependency with a csv of repositories, biryani can tell if the version is greater than or equal to the version specified or not and update it and create a pull request.

### Built With

* [Next.js](https://nextjs.org/)
* [React.js](https://reactjs.org/)
* [Vue.js](https://vuejs.org/)
* [Angular](https://angular.io/)
* [Svelte](https://svelte.dev/)
* [Laravel](https://laravel.com)
* [Bootstrap](https://getbootstrap.com)
* [JQuery](https://jquery.com)
* [arg](https://www.npmjs.com/package/arg)
* [octokit](https://www.npmjs.com/package/octokit/)
* [chalk](https://www.npmjs.com/package/chalk)
* [cli-table](https://www.npmjs.com/package/cli-table)
* [configstore](https://svelte.dev/)
* [configstore](https://www.npmjs.com/package/configstore)
* [esm](https://www.npmjs.com/package/esm)
* [inquirer](https://www.npmjs.com/package/inquirer)

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- GETTING STARTED -->
## Getting Started

Expand All @@ -119,52 +87,64 @@ This is an example of how to list things you need to use the software and how to
```sh
npm install npm@latest -g
```
* Github private access token
Create a personal access token from : https://github.com/settings/tokens/new?scopes=repo,user
(will be only asked )

### Installation
1. Install NPM packages
```sh
npm install -g @devashar13/biryani
```
And biryani will be installed globally to your system path.
<!-- USAGE EXAMPLES -->

1. Get a free API Key at [https://example.com](https://example.com)
2. Clone the repo
```sh
git clone https://github.com/github_username/repo_name.git
```
3. Install NPM packages
```sh
npm install
```
4. Enter your API in `config.js`
```js
const API_KEY = 'ENTER YOUR API';
```
## Usage

<p align="right">(<a href="#top">back to top</a>)</p>
To check if installation was successful, use the command:

```
biryani
```
After installation, run the command below in your terminal:

```
biryani --help
```
Create a .csv file with the format
```
name,repo
reponame,https://github.com/username/reponame
```
Check <a href="https://github.com/dyte-submissions/dyte-vit-2022-devashar13/blob/main/input.csv">Sample CSV</a>

<!-- USAGE EXAMPLES -->
## Usage
The help menu with all the options will be listed.

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_
```
biryani -i <path-to-csv> <library@version>
```
Use the above command to get current version of the library being used in the repositories and check if the version is satisfied with the given version

<p align="right">(<a href="#top">back to top</a>)</p>
Sample Output:
[![image.png](https://i.postimg.cc/Dwcn2gZh/image.png)](https://postimg.cc/rDzvj5xZ)

```
biryani -u -i <path-to-csv> <library@version>
```
Use the above command to get current version of the library being used in the repositories and check if the version is satisfied with the given version and update the version and create a pull request


<p align="right">(<a href="#top">back to top</a>)</p>


<!-- ROADMAP -->
## Roadmap

- [ ] Feature 1
- [ ] Feature 2
- [ ] Feature 3
- [ ] Nested Feature

See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
See the [open issues](https://github.com/-submissions/dyte-vit-2022-devashar13/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- CONTRIBUTING -->
## Contributing

Expand Down Expand Up @@ -194,10 +174,7 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.

<!-- CONTACT -->
## Contact

Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com

Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)
Project Link: [https://github.com/dyte-submissions/dyte-vit-2022-devashar13](https://github.com/github_username/repo_name)

<p align="right">(<a href="#top">back to top</a>)</p>

Expand Down
2 changes: 2 additions & 0 deletions bin/biryani
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/usr/bin/env node
require('../src/cli').cli(process.argv);
Binary file added images/biryanihelp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/biryanilogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions input.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
name,repo
project-name,https://github.com/username/yourrepo/
Loading