Ellie-cli NPM | npm.io

About The Project

                  _____   _   _   _                   ____   _       ___ 
                 | ____| | | | | (_)   ___           / ___| | |     |_ _|
                 |  _|   | | | | | |  / _ \  _____  | |     | |      | | 
                 | |___  | | | | | | |  __/ |_____| | |___  | |___   | | 
                 |_____| |_| |_| |_|  \___|          \____| |_____| |___|

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

npm
```
npm install npm@latest -g
```
yarn
```
npm install -g yarn
```

Installation

Clone the repo

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

Install NPM packages
```
yarn install
```
Build the app
```
yarn build
```
Run the CLI
```
ellie-cli --help
```

Usage

ellie-cli -i input.csv packageName@version

ellie-cli -i input.csv packageName@version -t <token> -u

For more examples, please refer to the Documentation

Documentation

flag	argument	description	required
`-V` `--version`	None	output the version number	`false`
`-i` `--input`	input.csv	path to csv file	`true`
`-u` `--update`	None	update the dependency	`false`
`-t` `--token`	ghp_00000000000000001	GitHub personal access token	`false`
`-h` `--help`	None	display help for command	`false`
	\<version>	package to be checked against	`true`

Sample Input

Now supports package manager option pass in 'npm' or 'yarn' as an additional data for the repo , default: npm

input.csv

dyte-react-sample-app,https://github.com/dyte-in/react-sample-app,npm
dyte-js-sample-app,https://github.com/dyte-in/javascript-sample-app
dyte-sample-app-backend,https://github.com/dyte-in/backend-sample-app

Drawbacks

Creating a PR also temporarily creates a folder ( gets deleted after job ) which generates only package-lock ( Takes time but better than completing cloning or installing all the node_modules) PS: Look at src/lib/lockFileGenerator.ts // FIXED
BEFORE
AFTER
The changes are committed to a static branch name where error might arise if branch already exists PS: Look at src/lib/generatePR.ts // FIXED
BEFORE
AFTER

License

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

Contact

Your Name - @sanjayybaskaran - sanjaybaskaran01@gmail.com

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

Contributors

@fast-csv/parse @octokit/rest @octokit/types chalk commander fast-csv figlet octokit-plugin-create-pull-request prettier semver

@infinitebrahmanuniverse/nolb-ell @everything-registry/sub-chunk-1570

1.0.1

3 years ago