Skip to content

jim0thy/npm-package-check

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Instructions for Running the Script using ts-node

Here is an outline on how to run the TypeScript script given, using `ts-node`.

Prerequisites

  • Ensure that you have Node.js and npm (Node Package Manager) installed in your system. You can download these from here.

  • You will need an npm authentication token to run this script without errors. See npm authToken for detailed information on obtaining it. Your npm configuration file, containing the token, should be located at ~/.npmrc.

  • You also need to provide the name of the organization as a command-line argument. This is used for package retrieval from the NPM registry.

Installation Steps

npm install will install all the dependencies required to run the script. This will install ts-node, axios, and csv-writer packages.

Run the Script

Finally, you can run the script using ts-node as:

npx ts-node main.ts 'organization-name'

Replace 'organization-name' with the actual organization name.

After running the script, a CSV file named package-sizes.csv will be created in the current directory, containing information on the size of each package in the given organization. Data will also be printed to the console.

Please note that optional error handlers are placed in several places in the script to catch and log any potential errors.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages