install

package

v0.0.0-...-4dc51e6 Latest Latest Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/snyk/snyk-ls

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

type CLIRelease
- func NewCLIRelease(httpClient func() *http.Client) *CLIRelease
- func (r *CLIRelease) GetLatestRelease(ctx context.Context) (*Release, error)
type Discovery
- func (d *Discovery) ChecksumInfo(r *Release) (string, error)
- func (d *Discovery) ChecksumURL(r *Release) (string, error)
- func (d *Discovery) DownloadURL(r *Release) (string, error)
- func (d *Discovery) ExecutableName(isUpdate bool) string
- func (d *Discovery) LookConfigPath() (string, error)
- func (d *Discovery) LookPath() (string, error)
- func (d *Discovery) LookUserDir() (string, error)
type Downloader
- func NewDownloader(errorReporter error_reporting.ErrorReporter, ...) *Downloader
- func (d *Downloader) Download(r *Release, isUpdate bool) error
type FakeInstaller
- func NewFakeInstaller() *FakeInstaller
- func (t *FakeInstaller) Find() (string, error)
- func (t *FakeInstaller) Install(_ context.Context) (string, error)
- func (t *FakeInstaller) Installs() int
- func (t *FakeInstaller) Update(_ context.Context) (bool, error)
- func (t *FakeInstaller) Updates() int
type HashSum
- func HashSumFromHexDigest(hexDigest string) (HashSum, error)
- func (hs HashSum) String() string
type Install
- func NewInstaller(errorReporter error_reporting.ErrorReporter, client func() *http.Client) *Install
- func (i *Install) Find() (string, error)
- func (i *Install) Install(ctx context.Context) (string, error)
- func (i *Install) Update(ctx context.Context) (bool, error)
type Installer
type Release
type ReleaseAsset
type ReleaseAssets

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CLIRelease ¶

type CLIRelease struct {
	// contains filtered or unexported fields
}

func NewCLIRelease ¶

func NewCLIRelease(httpClient func() *http.Client) *CLIRelease

func (*CLIRelease) GetLatestRelease ¶

func (r *CLIRelease) GetLatestRelease(ctx context.Context) (*Release, error)

type Discovery ¶

type Discovery struct{}

func (*Discovery) ChecksumInfo ¶

func (d *Discovery) ChecksumInfo(r *Release) (string, error)

ChecksumInfo returns OS specific checksum information for Snyk CLI.

func (*Discovery) ChecksumURL ¶

func (d *Discovery) ChecksumURL(r *Release) (string, error)

ChecksumURL returns OS specific checksum url for Snyk CLI.

func (*Discovery) DownloadURL ¶

func (d *Discovery) DownloadURL(r *Release) (string, error)

DownloadURL returns OS specific download url for Snyk CLI.

func (*Discovery) ExecutableName ¶

func (d *Discovery) ExecutableName(isUpdate bool) string

ExecutableName returns OS specific filename for Snyk CLI.

func (*Discovery) LookConfigPath ¶

func (d *Discovery) LookConfigPath() (string, error)

func (*Discovery) LookPath ¶

func (d *Discovery) LookPath() (string, error)

LookPath searches for the Snyk CLI executable in the directories named by the PATH environment variable.

func (*Discovery) LookUserDir ¶

func (d *Discovery) LookUserDir() (string, error)

LookUserDir searches for the Snyk CLI executable in the XDG_DATA_HOME/snyk-ls directory.

type Downloader ¶

type Downloader struct {
	// contains filtered or unexported fields
}

func NewDownloader ¶

func NewDownloader(errorReporter error_reporting.ErrorReporter, httpClientFunc func() *http.Client) *Downloader

func (*Downloader) Download ¶

func (d *Downloader) Download(r *Release, isUpdate bool) error

type FakeInstaller ¶

type FakeInstaller struct {
	// contains filtered or unexported fields
}

func NewFakeInstaller ¶

func NewFakeInstaller() *FakeInstaller

func (*FakeInstaller) Find ¶

func (t *FakeInstaller) Find() (string, error)

func (*FakeInstaller) Install ¶

func (t *FakeInstaller) Install(_ context.Context) (string, error)

func (*FakeInstaller) Installs ¶

func (t *FakeInstaller) Installs() int

func (*FakeInstaller) Update ¶

func (t *FakeInstaller) Update(_ context.Context) (bool, error)

func (*FakeInstaller) Updates ¶

func (t *FakeInstaller) Updates() int

type HashSum ¶

type HashSum []byte

func HashSumFromHexDigest ¶

func HashSumFromHexDigest(hexDigest string) (HashSum, error)

func (HashSum) String ¶

func (hs HashSum) String() string

type Install ¶

type Install struct {
	// contains filtered or unexported fields
}

func NewInstaller ¶

func NewInstaller(errorReporter error_reporting.ErrorReporter, client func() *http.Client) *Install

func (*Install) Find ¶

func (i *Install) Find() (string, error)

func (*Install) Install ¶

func (i *Install) Install(ctx context.Context) (string, error)

func (*Install) Update ¶

func (i *Install) Update(ctx context.Context) (bool, error)

type Installer ¶

type Installer interface {
	Find() (string, error)
	Install(ctx context.Context) (string, error)
	Update(ctx context.Context) (bool, error)
}

type Release ¶

type Release struct {
	Version string         `json:"version,omitempty"`
	Assets  *ReleaseAssets `json:"assets,omitempty"`
}

Release represents a Snyk CLI release with assets.

type ReleaseAsset ¶

type ReleaseAsset struct {
	URL          string `json:"url,omitempty"`
	ChecksumInfo string `json:"sha256,omitempty"`
	ChecksumURL  string `json:"sha256Url,omitempty"`
}

ReleaseAsset represents a Snyk CLI release asset including url to CLI binary and sha256 checksum.

type ReleaseAssets ¶

type ReleaseAssets struct {
	AlpineLinux *ReleaseAsset `json:"snyk-alpine,omitempty"`
	Linux       *ReleaseAsset `json:"snyk-linux,omitempty"`
	LinuxARM64  *ReleaseAsset `json:"snyk-linux-arm64,omitempty"`
	MacOS       *ReleaseAsset `json:"snyk-macos,omitempty"`
	MacOSARM64  *ReleaseAsset `json:"snyk-macos-arm64,omitempty"`
	Windows     *ReleaseAsset `json:"snyk-win.exe,omitempty"`
}

ReleaseAssets represents a assets object.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL