| 1 | # snyk-cli-interface
|
| 2 | Interface definitions for interactions between Snyk CLI and associated components:
|
| 3 |
|
| 4 | * plugins for analyzing various build systems
|
| 5 | * monitor states sent to snyk.io website
|
| 6 |
|
| 7 | This library should be only imported from Typescript.
|
| 8 |
|
| 9 | The types can be imported in one of the following ways:
|
| 10 |
|
| 11 | * whole sub-module import from the top level
|
| 12 |
|
| 13 | import { legacyPlugin as api } from '@snyk/cli-interface';
|
| 14 | // use api.InspectOptions
|
| 15 |
|
| 16 | * "deep import" (discouraged but possible)
|
| 17 |
|
| 18 | import { InspectOptions } from '@snyk/cli-interface/legacy/plugin';
|
| 19 |
|
| 20 | The `npm` package does not follow the usual Snyk convention and
|
| 21 | exports the build files in the root directory, not in dist, to enable "deep imports".
|
| 22 |
|
| 23 | We still have to publish the package using the compiled files, because many tools in Node.js
|
| 24 | ecosystem assume that published libraries should be always in Javascript.
|