snyk-go-parser

  • Version 1.9.2
  • Published
  • 70.9 kB
  • 4 dependencies
  • Apache-2.0 license

Install

npm i snyk-go-parser
yarn add snyk-go-parser
pnpm add snyk-go-parser

Overview

Generate a dep tree given a collection of manifests

Index

Functions

function buildGoPkgDepTree

buildGoPkgDepTree: (
manifestFileContents: string,
lockFileContents: string,
options?: unknown
) => Promise<DepTree>;

    function buildGoVendorDepTree

    buildGoVendorDepTree: (manifestFileContents: string) => Promise<DepTree>;

      function parseGoModGraph

      parseGoModGraph: (
      goModGraphOutput: string,
      projectName?: string,
      projectVersion?: string
      ) => DepGraph;

        function parseGoModRelativeManifestReplaces

        parseGoModRelativeManifestReplaces: (goModFileContent?: string) => string[];

          function parseGoPkgConfig

          parseGoPkgConfig: (
          manifestFileContents: string,
          lockFileContents: string
          ) => Promise<GoPackageConfig>;

            function parseGoVendorConfig

            parseGoVendorConfig: (manifestFileContents: string) => Promise<GoPackageConfig>;

              Interfaces

              interface GoModuleConfig

              interface GoModuleConfig {}

                property excludes

                excludes: ModuleAndVersion[];

                  property golangVersion

                  golangVersion?: string;

                    property moduleName

                    moduleName: string;

                      property replaces

                      replaces: Replace[];

                        property requires

                        requires: Require[];

                          interface GoPackageConfig

                          interface GoPackageConfig {}

                            property ignoredPkgs

                            ignoredPkgs?: string[];

                              property lockedVersions

                              lockedVersions: LockedDeps;

                                property packageName

                                packageName?: string;

                                  Type Aliases

                                  type GoPackageManagerType

                                  type GoPackageManagerType = 'golangdep' | 'govendor' | 'gomodules';

                                    type ModuleVersion

                                    type ModuleVersion = ModuleExactVersion | ModulePseudoVersion;

                                      Package Files (6)

                                      Dependencies (4)

                                      Dev Dependencies (12)

                                      Peer Dependencies (0)

                                      No peer dependencies.

                                      Badge

                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/snyk-go-parser.

                                      • Markdown
                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/snyk-go-parser)
                                      • HTML
                                        <a href="https://www.jsdocs.io/package/snyk-go-parser"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>