README.md

NodeSecure authors

Caution

This project (package) has been re-implemented/replaced in Scanner monorepo, here

Requirements

• Node.js v18 or higher

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @nodesecure/authors
# or
$ yarn add @nodesecure/authors

Usage example

import { extractAllAuthorsFromLibrary } from "@nodesecure/authors";

const flaggedAuthors = [{ name: "Blake Embrey", email: "hello@blakeembrey.com" }];

const authors = extractAllAuthorsFromLibrary(library, flaggedAuthors);
// Expect authors to be following this schema
// [
//   {
//     name: "Blake Embrey",
//     email: "hello@blakeembrey.com",
//     flagged: true,
//     packages: [
//       {
//         homepage: "https://github.com/blakeembrey/array-flatten",
//         spec: "array-flatten",
//         versions: "3.0.0",
//         isPublishers: false
//       },
//       {
//         homepage: "https://github.com/pillarjs/path-to-regexp#readme",
//         spec: "path-to-regexp",
//         versions: "6.2.0",
//         isPublishers: true
//       }
//   }
// ]

API

TBC

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Vincent Dhennin 💻 👀 📖 🐛

Nicolas Hallaert 👀

Kouadio Fabrice Nguessan 🚧

License

MIT