ghfs

README

ghfs

:octocat: ghfs implements the io/fs interfaces for GitHub remote repositories.

The implementation wraps go-github client and use Git Database API.

Supported interface

• fs.FS
• fs.ReadFileFS
• fs.ReadDirFS
• fs.SubFS

Usage

package main

import (
	"fmt"
	"io"
	"log"

	"github.com/k1LoW/ghfs"
)

func main() {
	fsys, err := ghfs.New("golang", "time")
	if err != nil {
		log.Fatal(err)
	}
	f, err := fsys.Open("README.md")
	if err != nil {
		log.Fatal(err)
	}
	b, err := io.ReadAll(f)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", b)
}

References

• johejo/ghfs: Package ghfs wraps the github v3 rest api with io/fs.

Documentation

Index

• type FS
  • func New(owner, repo string, opts ...Option) (*FS, error)
  • func (fsys *FS) Open(name string) (fs.File, error)
  • func (fsys *FS) ReadDir(name string) ([]fs.DirEntry, error)
  • func (fsys *FS) ReadFile(name string) ([]byte, error)
  • func (fsys *FS) Sub(dir string) (fs.FS, error)
• type Option
  • func Branch(branch string) Option
  • func Client(client *github.Client) Option
  • func Context(ctx context.Context) Option
  • func Tag(tag string) Option

Types

type FS

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

func New

func New(owner, repo string, opts ...Option) (*FS, error)

func (*FS) Open

func (fsys *FS) Open(name string) (fs.File, error)

func (*FS) ReadDir

func (fsys *FS) ReadDir(name string) ([]fs.DirEntry, error)

func (*FS) ReadFile

func (fsys *FS) ReadFile(name string) ([]byte, error)

func (*FS) Sub

func (fsys *FS) Sub(dir string) (fs.FS, error)

type Option

type Option func(*config) error

func Branch

func Branch(branch string) Option

func Client

func Client(client *github.Client) Option

func Context

func Context(ctx context.Context) Option

func Tag

func Tag(tag string) Option