Documentation
¶
Index ¶
- type BundlePackager
- type GenericBundlePackager
- func (p *GenericBundlePackager) AppendGithubDependency(repoPattern bundle_entities.GithubRepoPattern)
- func (p *GenericBundlePackager) AppendMarketplaceDependency(marketplacePattern bundle_entities.MarketplacePattern)
- func (p *GenericBundlePackager) AppendPackageDependency(packagePath string) error
- func (p *GenericBundlePackager) Assets() (map[string][]byte, error)
- func (p *GenericBundlePackager) BumpVersion(target manifest_entities.Version)
- func (p *GenericBundlePackager) Export() ([]byte, error)
- func (p *GenericBundlePackager) FetchAsset(path string) ([]byte, error)
- func (p *GenericBundlePackager) ListDependencies() ([]bundle_entities.Dependency, error)
- func (p *GenericBundlePackager) Manifest() (*bundle_entities.Bundle, error)
- func (p *GenericBundlePackager) Regenerate(bundle bundle_entities.Bundle) error
- func (p *GenericBundlePackager) Remove(index int) error
- type LocalBundlePackager
- type MemoryZipBundlePackager
- type ZipBundlePackager
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BundlePackager ¶
type BundlePackager interface {
// Export exports the bundle to a zip byte array
Export() ([]byte, error)
// Save saves the bundle to the original source
Save() error
// Manifest returns the manifest of the bundle
Manifest() (*bundle_entities.Bundle, error)
// Remove removes a dependency from the bundle
Remove(index int) error
// Append Github Dependency appends a github dependency to the bundle
AppendGithubDependency(repoPattern bundle_entities.GithubRepoPattern)
// Append Marketplace Dependency appends a marketplace dependency to the bundle
AppendMarketplaceDependency(marketplacePattern bundle_entities.MarketplacePattern)
// Append Package Dependency appends a local package dependency to the bundle
AppendPackageDependency(packagePath string) error
// ListDependencies lists all the dependencies of the bundle
ListDependencies() ([]bundle_entities.Dependency, error)
// Regenerate regenerates the bundle, replace the basic information of the bundle like name, labels, description, icon, etc.
Regenerate(bundle bundle_entities.Bundle) error
// BumpVersion bumps the version of the bundle
BumpVersion(targetVersion manifest_entities.Version)
// FetchAsset fetches the asset of the bundle
// NOTE: path is the relative path to _assets folder
FetchAsset(path string) ([]byte, error)
// Assets returns a set of assets in the bundle
Assets() (map[string][]byte, error)
// ReadFile reads the file from the bundle
// NOTE: path is the relative path to the root of the bundle
ReadFile(path string) ([]byte, error)
}
func NewLocalBundlePackager ¶
func NewLocalBundlePackager(path string) (BundlePackager, error)
func NewZipBundlePackager ¶
func NewZipBundlePackager(path string) (BundlePackager, error)
func NewZipBundlePackagerWithSizeLimit ¶
func NewZipBundlePackagerWithSizeLimit(path string, maxSize int64) (BundlePackager, error)
type GenericBundlePackager ¶
type GenericBundlePackager struct {
// contains filtered or unexported fields
}
func NewGenericBundlePackager ¶
func NewGenericBundlePackager( bundle *bundle_entities.Bundle, extraFiles map[string]*bytes.Buffer, ) *GenericBundlePackager
func (*GenericBundlePackager) AppendGithubDependency ¶
func (p *GenericBundlePackager) AppendGithubDependency(repoPattern bundle_entities.GithubRepoPattern)
func (*GenericBundlePackager) AppendMarketplaceDependency ¶
func (p *GenericBundlePackager) AppendMarketplaceDependency(marketplacePattern bundle_entities.MarketplacePattern)
func (*GenericBundlePackager) AppendPackageDependency ¶
func (p *GenericBundlePackager) AppendPackageDependency(packagePath string) error
func (*GenericBundlePackager) Assets ¶
func (p *GenericBundlePackager) Assets() (map[string][]byte, error)
func (*GenericBundlePackager) BumpVersion ¶
func (p *GenericBundlePackager) BumpVersion(target manifest_entities.Version)
func (*GenericBundlePackager) Export ¶
func (p *GenericBundlePackager) Export() ([]byte, error)
func (*GenericBundlePackager) FetchAsset ¶
func (p *GenericBundlePackager) FetchAsset(path string) ([]byte, error)
func (*GenericBundlePackager) ListDependencies ¶
func (p *GenericBundlePackager) ListDependencies() ([]bundle_entities.Dependency, error)
func (*GenericBundlePackager) Manifest ¶
func (p *GenericBundlePackager) Manifest() (*bundle_entities.Bundle, error)
func (*GenericBundlePackager) Regenerate ¶
func (p *GenericBundlePackager) Regenerate(bundle bundle_entities.Bundle) error
func (*GenericBundlePackager) Remove ¶
func (p *GenericBundlePackager) Remove(index int) error
type LocalBundlePackager ¶
type LocalBundlePackager struct {
GenericBundlePackager
// contains filtered or unexported fields
}
func (*LocalBundlePackager) ReadFile ¶
func (p *LocalBundlePackager) ReadFile(path string) ([]byte, error)
func (*LocalBundlePackager) Save ¶
func (p *LocalBundlePackager) Save() error
type MemoryZipBundlePackager ¶
type MemoryZipBundlePackager struct {
GenericBundlePackager
// contains filtered or unexported fields
}
func NewMemoryZipBundlePackager ¶
func NewMemoryZipBundlePackager(zipFile []byte) (*MemoryZipBundlePackager, error)
func (*MemoryZipBundlePackager) ReadFile ¶
func (p *MemoryZipBundlePackager) ReadFile(path string) ([]byte, error)
func (*MemoryZipBundlePackager) Save ¶
func (p *MemoryZipBundlePackager) Save() error
type ZipBundlePackager ¶
type ZipBundlePackager struct {
*MemoryZipBundlePackager
// contains filtered or unexported fields
}
func (*ZipBundlePackager) Save ¶
func (p *ZipBundlePackager) Save() error
Click to show internal directories.
Click to hide internal directories.