evrgrn v0.0.3

evergreen-cli

A CLI tool for analyzing project dependency health.

• Usage
• Commands
• Configuration

Usage

$ npx evrgrn
...

Commands

npx evrgrn help [COMMAND]

Display help for evergreen.

USAGE
  $ npx evrgrn help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for evergreen.

npx evrgrn report

Generate an Evergreen dependency report.

USAGE
  $ npx evrgrn report

DESCRIPTION
  Generate an Evergreen dependency report.

npx evrgrn report regenerate

Regenrate an Evergreen report from previously fetched details and updated configuration.

USAGE
  $ npx evrgrn report regenerate

DESCRIPTION
  Regenrate an Evergreen report from previously fetched details and updated configuration.

Configuration

The configuration should be in a file called .evergreenrc.json in the current directory.

Example Configuration

{
  "approvedLicenses": [ 
    "MIT",
    "Apache",
    "BSD-3-Clause",
    "BSD-2-Clause",
    "MPL-2.0",
    "ISC",
    "PSF",
    "Public Domain",
    "LGPL v2",
    "GPL v2"
  ],
  "reports": [
    {
      "ecosystem": "cocoapods",
      "options": {
          "sourceGlob": "../ios/**/*.@(h|m|swift)",
          "projectRoot": "../ios"
      }
    },
    {
      "ecosystem": "yarn",
      "options": {
        "sourceGlob": "../web/src/frontend/**/*.@(js|jsx|ts|tsx)",
        "projectRoot": "../web/src/frontend"
      }
    },
    {
      "ecosystem": "pip",
      "options": {
        "sourceGlob": "../web/src/aplaceforrover/**/*.py",
        "projectRoot": "../web"
      }
    },
    {
      "ecosystem": "gradle",
      "options": {
        "sourceGlob": "../android/**/*.@(java|kt)",
        "projectRoot": "../android"
      }
    }
  ],
  "overrides": [
    {
      "packageName": "GoogleAppMeasurement",
      "ecosystem": "cocoapods",
      "license": "Apache 2.0"
    }
  ]
}

Configuration Options

See types for more information.