fs

README

File system installer for Plugin Registry

A file system installer for plugin-registry

Prerequisites

• Go >= 1.16

Install

go get github.com/nhatthm/plugin-registry-fs

Usage

Import the library while bootstrapping the application (see the examples)

This installer supports installing:

• A binary file
• A folder
• An archive (.tar.gz, .gz. or zip)

The source must be in this format:

./my-project/
├── .plugin.registry.yaml
└── my-plugin/
    └── (plugin files)

For example, if source is an archive, it should be:

./my-project/
├── .plugin.registry.yaml
└── my-plugin-1.0.0-darwin-amd64.tar.gz

Examples

package mypackage

import (
	"context"

	registry "github.com/nhatthm/plugin-registry"
	_ "github.com/nhatthm/plugin-registry-fs" // Add file system installer.
)

var defaultRegistry = mustCreateRegistry()

func mustCreateRegistry() registry.Registry {
	r, err := createRegistry()
	if err != nil {
		panic(err)
	}

	return r
}

func createRegistry() (registry.Registry, error) {
	return registry.NewRegistry("~/plugins")
}

func installPlugin(source string) error {
	return defaultRegistry.Install(context.Background(), source)
}

Donation

If this project help you reduce time to develop, you can give me a cup of coffee :)

Paypal donation

       or scan this

Documentation

Overview

Package fs provides file system installers.

Index

• Variables
• type ArchiveInstaller
  • func NewGzipInstaller(fs afero.Fs) *ArchiveInstaller
  • func NewZipInstaller(fs afero.Fs) *ArchiveInstaller
  • func (i *ArchiveInstaller) Install(ctx context.Context, dest, pluginURL string) (*plugin.Plugin, error)
• type Installer
  • func NewFsInstaller(fs afero.Fs) *Installer
  • func (i *Installer) Install(ctx context.Context, dest, path string) (*plugin.Plugin, error)

Variables

var (
	// ErrPluginNotDir indicates that the plugin is not a directory.
	ErrPluginNotDir = errors.New("plugin is not a directory")
	// ErrPluginIsDir indicates that the plugin is a directory.
	ErrPluginIsDir = errors.New("plugin is a directory")
	// ErrIllegalFilePath indicates that the file path is illegal.
	ErrIllegalFilePath = errors.New("illegal file path")
)

var ErrPluginNotGzip = errors.New("plugin is not a gzip")

ErrPluginNotGzip indicates that the plugin is not a zip.

var ErrPluginNotZip = errors.New("plugin is not a zip")

ErrPluginNotZip indicates that the plugin is not a zip.

Types

type ArchiveInstaller

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

ArchiveInstaller is an installer for archive file.

func NewGzipInstaller

func NewGzipInstaller(fs afero.Fs) *ArchiveInstaller

NewGzipInstaller creates a new filesystem installer.

func NewZipInstaller

func NewZipInstaller(fs afero.Fs) *ArchiveInstaller

NewZipInstaller creates a new filesystem installer.

func (*ArchiveInstaller) Install

func (i *ArchiveInstaller) Install(ctx context.Context, dest, pluginURL string) (*plugin.Plugin, error)

Install installs the plugin.

type Installer

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

Installer is a file system installer.

func NewFsInstaller

func NewFsInstaller(fs afero.Fs) *Installer

NewFsInstaller creates a new filesystem installer.

func (*Installer) Install

func (i *Installer) Install(ctx context.Context, dest, path string) (*plugin.Plugin, error)

Install installs the plugin.