ac

README

go-ac

ac is helper library that creates CREDITS files(s) using go version -m and gocredits.

Requirement

• Go 1.13
• gocredits: if you want to use gocredits as extarnal program.

Ueage

Example of using ac in magefile.

input

  ▾ my-proj/
    ▾ dist/
      ▾ my_cmd_linux_386/
          my_cmd
      ▾ my_cmd_linux_amd64/
          my_cmd
      ▾ my_cmd_windows_amd64/
          my_cmd.exe
      go.sum

output(If CREDITS_* files are all the same, they are merged into the CREDITS file).

  ▾ my-proj/
      CREDITS_linux_386
      CREDITS_linux_amd64
      CREDITS_windows_amd64

magefile.go

import "github.com/hankei6km/go-ac"

func Credits() error {

	// ...

	cwd, err := os.Getwd()
	if err != nil {
		return err
	}
	tmpDir := filepath.Join(cwd, "tmp")
	if err := ac.ResetDir(tmpDir, os.ModePerm); err != nil {
		return err
	}
	defer os.RemoveAll(tmpDir)

	b := ac.NewOutputBuilder().
		GoSumFile(filepath.Join(cwd, "go.sum"))
	d := ac.NewDistBuilder().
		DistDir(filepath.Join(cwd, "dist")).
		WorkDir(tmpDir).
		OutDir(cwd).
		OutputBuilder(b).
		Build()
	if err := d.Run(); err != nil {
		return err
	}

	// ...

	return nil
}

Documentation

Index

• func DistSuffix(d string) []string
• func ResetDir(name string, perm os.FileMode) error
• type Dist
• type DistBuilder
  • func NewDistBuilder() DistBuilder
• type FuncOutputBuilder
• type Output
• type OutputBuilder
  • func NewOutputBuilder() OutputBuilder
• type ProgOutput

Functions

func DistSuffix

func DistSuffix(d string) []string

DistSuffix returns suffix of d(ie. foo_bar_linxu_386 -> [linx 386])

func ResetDir

func ResetDir(name string, perm os.FileMode) error

ResetDir calls RemoveAll (if name is exists) and Mkdir.

Types

type Dist

type Dist interface {
	Run() error
}

Dist provide functions to write some CREDITS files for each binary files (ie. foo_linux_386, foo_darwin_amd64 -> CREDITS_linxu_386, CREDITS_darwin_amd64)

Dist は各バイナリファイルから、それぞれ用の CREDITS ファイルを書き出す機能を提供する.

type DistBuilder

type DistBuilder interface {
	WorkDir(string) DistBuilder
	DistDir(string) DistBuilder
	OutDir(string) DistBuilder
	BaseName(string) DistBuilder
	Uniq(bool) DistBuilder

	OutputBuilder(OutputBuilder) DistBuilder

	OutStream(io.Writer) DistBuilder
	ErrStream(io.Writer) DistBuilder

	Branch() DistBuilder
	Build() Dist
}

DistBuilder builds Dist.

func NewDistBuilder

func NewDistBuilder() DistBuilder

NewDistBuilder returns the instance of DistBuilder.

type FuncOutputBuilder

type FuncOutputBuilder interface {
	// contains filtered or unexported methods
}

FuncOutputBuilder adds properties to Output(Builder).

type Output

type Output interface {
	Flush() (hash []byte, err error)
}

Output provides functions to write the CREADITS file from the binary file.

Output はバイナリファイルから CREADTIS ファイルを書き出す機能を提供する.

type OutputBuilder

type OutputBuilder interface {
	GoSumFile(string) OutputBuilder
	WorkDir(string) OutputBuilder
	Binary(string) OutputBuilder
	OutStream(io.Writer) OutputBuilder
	ErrStream(io.Writer) OutputBuilder

	ProgOutput
	FuncOutputBuilder

	Branch() OutputBuilder
	Build() Output
}

OutputBuilder builds CreaditsFile.

今回はそれほどコスト気にする必要はないので、各メソッドで深いコピー(ぽいこと)を行う.

func NewOutputBuilder

func NewOutputBuilder() OutputBuilder

NewOutputBuilder returns the instance of OutputBuilder.

type ProgOutput

type ProgOutput interface {
	Prog(string) OutputBuilder
}

ProgOutput adds properties to Output(Builder).