bbfs

package module

v0.0.6 Latest Latest Go to latest Published: Nov 4, 2024 License: MIT Imports: 9 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/myhops/bbfs

Links

Open Source Insights

README ¶

BBFS

A golang FS implementation for Bitbucket Data Center.

It currently only supports the Bitbucket Data Center API. The Cloud version is under development.

References

Documentation ¶

Overview ¶

bbfs is a fs.FS implementation for a Bitbucket server, on premises.

Index ¶

Constants
Variables
func NewFS(cfg *Config, opts ...Option) fs.FS
type Bitbucket
type Config
type Option

Constants ¶

View Source

const (
	// Default api path for Bitbucket Server
	ApiPath = "/rest/api"
	// API version
	DefaultVersion = "latest"
)

Variables ¶

View Source

var (
	ErrNotImplementedYet = errors.New("not implemented yet")
)

Functions ¶

func NewFS ¶

func NewFS(cfg *Config, opts ...Option) fs.FS

NewFS returns a new FS.

Types ¶

type Bitbucket ¶

type Bitbucket interface {
}

Define the interface for accessing the Bitbucket repositories.

type Config ¶

type Config struct {
	// Host is the hostname of the server
	Host string
	// ProjectKey is the name of the project or the user of the repo
	ProjectKey string
	// RepositorySlug is the name of the repository
	RepositorySlug string
	// Root is the root of the file system in the repo,
	// must be a an existing directory
	Root string
	// AccessKey is an http access key for the repo or the project
	AccessKey string
	// At is a branch, tag or commit
	At string
	// ApiVersion is ignored
	ApiVersion string
}

Config contains the configuration for a bitbucket file system.

type Option ¶

type Option func(*bbFS)

Options is the type for NewFS options.

func WithDisabledCache ¶ added in v0.0.5

func WithDisabledCache() Option

WithDisabledCache disables caching the requests to bitbucket

func WithLogger ¶

func WithLogger(l *slog.Logger) Option

WithLogger adds a logger to the FS.

func WithMaxCachedItemSize ¶ added in v0.0.5

func WithMaxCachedItemSize(size int64) Option

WithMaxCachedItemSize sets the maximum size for items in the cache.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
bbclient bbclient exposes services to interact with a Bitbucket repository.	bbclient exposes services to interact with a Bitbucket repository.
cloud cloud does not work yet, do not use	cloud does not work yet, do not use
server
cmd
bbclient command
nulllog nullog contains a handler that logs nohing and is always disabled.	nullog contains a handler that logs nohing and is always disabled.

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