NPUC (Node Package Updates Checker)

This project is a tool that checks the updates of the packages used in a project tha uses npm.

Technologies Used

This project uses the following technologies:

- Node.js: The cross-platform JavaScript runtime environment. It's the base technology of the project. The version is defined on the .nvmrc file. https://nodejs.org

- NPM: The package manager for JavaScript. It's used to manage the dependencies of the project. The version is defined on the package.json file. https://www.npmjs.com

- chalk: A tool that allows the use of colors in the console. https://www.npmjs.com/package/chalk

Code Structure

Main files and directories of the project:

- index.js: The main file of the project. It's the file that is executed when the project is run.

- src/lib: The directory that contains the files with the functions that are used in the project.

- src/constants: The directory that contains the files with the constants that are used in the project.

- .npucrc.json: The file that contains a sample configuration file for the project.

Usage

To use the project, follow the steps below:

Check licenses

npx npuc

Init and check licenses

npx npuc --init

It will create a .npucrc.json file in the root of the project.

Show help

npx npuc --help

Show complete list of packages and their versions

npx npuc --packageList

or as a json

npx npuc --packageList --json

create a file with the list of packages as json

You can create a file with the list of packages in json format by using the --file option.

npx npuc --packageList --json --file <file_name>.json

You can also use the --file option to specify the name of the file where the list will be saved. If you don't specify a file name, it will default to npuc_packages.json.

send list to webhook

Alwais in json format

npx npuc --packageList --webHookUrl <webhook_url>

or with a token sended in the header as x-webhook-key npx npuc --packageList --webHookUrl <webhook_url> --webHookKey <webHookKey>

Deployment

To deploy the project, follow the steps below:

Install the dependencies

npm install

Run the project

node ./index.js

License

This project is licensed under the MIT License - see the LICENSE.md file for details.