Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 2.16 KB

README.md

File metadata and controls

53 lines (32 loc) · 2.16 KB

About npm-author-packages

npm-author-packages is an npm package for accessing various npm author/package related information, such as

  • which packages has an author created
  • is a specific author the creator of a package
  • is an author involved in creation of any of the packages in a project

Why?

According to the documentation of npm-search it should be possible to search for an npm package with the npm username. However, this seems currently not to work (in April 2022), so I decided to create my own solution for accomplishing this. Initially my motivation was sparked by the peacenotwar npm malware and my desire to check if that specific author was involved in any of packages my projects are using.

How does it work

For reading the npm packages of an author, I use screenscraping techniques. Because of this the command for listing author packages may be slow when there are very many packages, like for user sindresorhus. For determining project dependencies npm-ls is used.

Installation and usage

As a terminal utility

To use this package anywhere from the terminal, install it globally

npm install -g @sasuw/npm-author-packages

Then you can list npm packages for a specific author by running

npmap [username]

To find out if any dependency (or sub-dependency) in your npm project involves a specicic author, run this in your project directory

npmap -a [username] -i

To find out if a specicic author is a (co)author of a specific package, execute

npmap -a [username] -p [package name]

For all options, run

npmap -h

In code

To use this package in your own project

npm i --save @sasuw/npm-author-packages

Code example to print all packages for an npm author with username sasuw

const npmAuthorPackages = require("@sasuw/npm-author-packages");

(async function () {
    let authorPackages = await npmAuthorPackages.readNpmPackageAuthors('sasuw');
    authorPackages.forEach(element => {
        console.log(element);
    });
})();