lockfile

Documentation

Index

• func Overwrite(rw ReadWriter, filename string, patches []DependencyPatch) error
• type DependencyPatch
• type NpmReadWriter
  • func (rw NpmReadWriter) Read(file lockfile.DepFile) (*resolve.Graph, error)
  • func (NpmReadWriter) System() resolve.System
  • func (rw NpmReadWriter) Write(original lockfile.DepFile, output io.Writer, patches []DependencyPatch) error
• type ReadWriter
  • func GetReadWriter(pathToLockfile string) (ReadWriter, error)

Functions

func Overwrite

func Overwrite(rw ReadWriter, filename string, patches []DependencyPatch) error

Types

type DependencyPatch

type DependencyPatch struct {
	Pkg         resolve.PackageKey
	OrigVersion string
	NewVersion  string
}

type NpmReadWriter

type NpmReadWriter struct{}

func (NpmReadWriter) Read

func (rw NpmReadWriter) Read(file lockfile.DepFile) (*resolve.Graph, error)

func (NpmReadWriter) System

func (NpmReadWriter) System() resolve.System

func (NpmReadWriter) Write

func (rw NpmReadWriter) Write(original lockfile.DepFile, output io.Writer, patches []DependencyPatch) error

type ReadWriter

type ReadWriter interface {
	// System returns which ecosystem this ReadWriter is for.
	System() resolve.System
	// Read parses a lockfile into a resolved graph
	Read(file lockfile.DepFile) (*resolve.Graph, error)
	// Write applies the DependencyPatches to the lockfile, with minimal changes to the file.
	// `original` is the original lockfile to read from. The updated lockfile is written to `output`.
	Write(original lockfile.DepFile, output io.Writer, patches []DependencyPatch) error
}

func GetReadWriter

func GetReadWriter(pathToLockfile string) (ReadWriter, error)