const (
// MaxZipFile is the maximum size in bytes of a module zip file. The
// go command will report an error if either the zip file or its extracted
// content is larger than this.
MaxZipFile = 500 << 20
// MaxGoMod is the maximum size in bytes of a go.mod file within a
// module zip file.
MaxGoMod = 16 << 20
// MaxLICENSE is the maximum size in bytes of a LICENSE file within a
// module zip file.
MaxLICENSE = 16 << 20
)
func Create(w io.Writer, m module.Version, files []File) (err error)
Create builds a zip archive for module m from an abstract list of files and writes it to w.
Create verifies the restrictions described in the package documentation and should not produce an archive that Unzip cannot extract. Create does not include files in the output archive if they don't belong in the module zip. In particular, Create will not include files in modules found in subdirectories, most files in vendor directories, or irregular files (such as symbolic links) in the output archive.
func CreateFromDir(w io.Writer, m module.Version, dir string) (err error)
CreateFromDir creates a module zip file for module m from the contents of a directory, dir. The zip content is written to w.
CreateFromDir verifies the restrictions described in the package documentation and should not produce an archive that Unzip cannot extract. CreateFromDir does not include files in the output archive if they don't belong in the module zip. In particular, CreateFromDir will not include files in modules found in subdirectories, most files in vendor directories, or irregular files (such as symbolic links) in the output archive. Additionally, unlike Create, CreateFromDir will not include directories named ".bzr", ".git", ".hg", or ".svn".
func CreateFromVCS(w io.Writer, m module.Version, repoRoot, revision, subdir string) (err error)
CreateFromVCS creates a module zip file for module m from the contents of a VCS repository stored locally. The zip content is written to w.
repoRoot must be an absolute path to the base of the repository, such as "/Users/some-user/some-repo".
revision is the revision of the repository to create the zip from. Examples include HEAD or SHA sums for git repositories.
subdir must be the relative path from the base of the repository, such as "sub/dir". To create a zip from the base of the repository, pass an empty string.
If CreateFromVCS returns UnrecognizedVCSError, consider falling back to CreateFromDir.
func Unzip(dir string, m module.Version, zipFile string) (err error)
Unzip extracts the contents of a module zip file to a directory.
Unzip checks all restrictions listed in the package documentation and returns an error if the zip archive is not valid. In some cases, files may be written to dir before an error is returned (for example, if a file's uncompressed size does not match its declared size).
dir may or may not exist: Unzip will create it and any missing parent directories if it doesn't exist. If dir exists, it must be empty.
CheckedFiles reports whether a set of files satisfy the name and size constraints required by module zip files. The constraints are listed in the package documentation.
Functions that produce this report may include slightly different sets of files. See documentation for CheckFiles, CheckDir, and CheckZip for details.
type CheckedFiles struct {
// Valid is a list of file paths that should be included in a zip file.
Valid []string
// Omitted is a list of files that are ignored when creating a module zip
// file, along with the reason each file is ignored.
Omitted []FileError
// Invalid is a list of files that should not be included in a module zip
// file, along with the reason each file is invalid.
Invalid []FileError
// SizeError is non-nil if the total uncompressed size of the valid files
// exceeds the module zip size limit or if the zip file itself exceeds the
// limit.
SizeError error
}
func CheckDir(dir string) (CheckedFiles, error)
CheckDir reports whether the files in dir satisfy the name and size constraints listed in the package documentation. The returned CheckedFiles record contains lists of valid, invalid, and omitted files. If a directory is omitted (for example, a nested module or vendor directory), it will appear in the omitted list, but its files won't be listed.
CheckDir returns an error if it encounters an I/O error or if the returned CheckedFiles does not describe a valid module zip file (according to CheckedFiles.Err). The returned CheckedFiles is still populated when such an error is returned.
Note that CheckDir will not open any files, so CreateFromDir may still fail when CheckDir is successful due to I/O errors.
func CheckFiles(files []File) (CheckedFiles, error)
CheckFiles reports whether a list of files satisfy the name and size constraints listed in the package documentation. The returned CheckedFiles record contains lists of valid, invalid, and omitted files. Every file in the given list will be included in exactly one of those lists.
CheckFiles returns an error if the returned CheckedFiles does not describe a valid module zip file (according to CheckedFiles.Err). The returned CheckedFiles is still populated when an error is returned.
Note that CheckFiles will not open any files, so Create may still fail when CheckFiles is successful due to I/O errors and reported size differences.
func CheckZip(m module.Version, zipFile string) (CheckedFiles, error)
CheckZip reports whether the files contained in a zip file satisfy the name and size constraints listed in the package documentation.
CheckZip returns an error if the returned CheckedFiles does not describe a valid module zip file (according to CheckedFiles.Err). The returned CheckedFiles is still populated when an error is returned. CheckZip will also return an error if the module path or version is malformed or if it encounters an error reading the zip file.
Note that CheckZip does not read individual files, so Unzip may still fail when CheckZip is successful due to I/O errors.
func (cf CheckedFiles) Err() error
Err returns an error if CheckedFiles does not describe a valid module zip file. [CheckedFiles.SizeError] is returned if that field is set. A FileErrorList is returned if there are one or more invalid files. Other errors may be returned in the future.
File provides an abstraction for a file in a directory, zip, or anything else that looks like a file.
type File interface {
// Path returns a clean slash-separated relative path from the module root
// directory to the file.
Path() string
// Lstat returns information about the file. If the file is a symbolic link,
// Lstat returns information about the link itself, not the file it points to.
Lstat() (os.FileInfo, error)
// Open provides access to the data within a regular file. Open may return
// an error if called on a directory or symbolic link.
Open() (io.ReadCloser, error)
}
type FileError struct {
Path string
Err error
}
func (e FileError) Error() string
func (e FileError) Unwrap() error
type FileErrorList []FileError
func (el FileErrorList) Error() string
UnrecognizedVCSError indicates that no recognized version control system was found in the given directory.
type UnrecognizedVCSError struct {
RepoRoot string
}
func (e *UnrecognizedVCSError) Error() string