user_ops

Documentation

Index

• type Checkin
  • func (op Checkin) Run(repo *local_working_copy.Repo, q *query.Query) (err error)
• type Checkout
  • func (op Checkout) Run(skus sku.TransactedSet) (zsc sku.SkuTypeSetMutable, err error)
  • func (op Checkout) RunQuery(qg *query.Query) (checkedOut sku.SkuTypeSetMutable, err error)
  • func (op Checkout) RunWithKasten(kasten ids.RepoId, skus sku.TransactedSet) (zsc sku.SkuTypeSetMutable, err error)
• type CreateFromPaths
  • func (c CreateFromPaths) Run(args ...string) (results sku.TransactedMutableSet, err error)
• type CreateFromShas
  • func (c CreateFromShas) Run(args ...string) (results sku.TransactedMutableSet, err error)
• type CreateOrganizeFile
  • func (cmd CreateOrganizeFile) Run() (results *organize_text.Text, err error)
  • func (cmd CreateOrganizeFile) RunAndWrite(writer io.Writer) (results *organize_text.Text, err error)
• type Diff
  • func (op Diff) Run(remoteCheckedOut sku.SkuType, options object_metadata.TextFormatterOptions) (err error)
• type EachBlob
  • func (c EachBlob) Run(skus sku.SkuTypeSet) (err error)
• type ExecLua
  • func (u ExecLua) Run(sk *sku.Transacted, args ...string) (err error)
• type OpenEditor
  • func (c OpenEditor) Run(u *local_working_copy.Repo, args ...string) (err error)
• type Organize
  • func (op Organize) RunWithQueryGroup(qg *query.Query) (organizeResults organize_text.OrganizeResults, err error)
  • func (op Organize) RunWithSkuType(q *query.Query, skus sku.SkuTypeSet) (organizeResults organize_text.OrganizeResults, err error)
  • func (op Organize) RunWithTransacted(qg *query.Query, transacted sku.TransactedSet) (organizeResults organize_text.OrganizeResults, err error)
• type Organize2
  • func (op Organize2) Run(skus sku.CheckedOutMutableSet) (organizeResults organize_text.OrganizeResults, err error)
• type ReadOrganizeFile
  • func (c ReadOrganizeFile) Run(u *local_working_copy.Repo, r io.Reader, om organize_text.Metadata) (ot *organize_text.Text, err error)
  • func (c ReadOrganizeFile) RunWithPath(u *local_working_copy.Repo, p string, repoId ids.RepoId) (ot *organize_text.Text, err error)
• type WriteNewZettels
  • func (op WriteNewZettels) RunMany(proto sku.Proto, count int) (results sku.TransactedMutableSet, err error)
  • func (c WriteNewZettels) RunOne(z sku.Proto) (result *sku.Transacted, err error)

Types

type Checkin

type Checkin struct {
	Proto sku.Proto

	// TODO make flag family disambiguate these options
	// and use with other commands too
	Delete             bool
	RefreshCheckout    bool
	Organize           bool
	CheckoutBlobAndRun string
	OpenBlob           bool
	Edit               bool // TODO add support back for this
}

func (Checkin) Run

func (op Checkin) Run(
	repo *local_working_copy.Repo,
	q *query.Query,
) (err error)

type Checkout

type Checkout struct {
	*local_working_copy.Repo
	Organize bool
	checkout_options.Options
	Open            bool
	Edit            bool
	Utility         string
	RefreshCheckout bool
}

func (Checkout) Run

func (op Checkout) Run(
	skus sku.TransactedSet,
) (zsc sku.SkuTypeSetMutable, err error)

func (Checkout) RunQuery

func (op Checkout) RunQuery(
	qg *query.Query,
) (checkedOut sku.SkuTypeSetMutable, err error)

func (Checkout) RunWithKasten

func (op Checkout) RunWithKasten(
	kasten ids.RepoId,
	skus sku.TransactedSet,
) (zsc sku.SkuTypeSetMutable, err error)

type CreateFromPaths

type CreateFromPaths struct {
	*local_working_copy.Repo
	Proto      sku.Proto
	TextParser object_metadata.TextParser
	Filter     script_value.ScriptValue
	Delete     bool
}

func (CreateFromPaths) Run

func (c CreateFromPaths) Run(
	args ...string,
) (results sku.TransactedMutableSet, err error)

type CreateFromShas

type CreateFromShas struct {
	*local_working_copy.Repo
	sku.Proto
}

func (CreateFromShas) Run

func (c CreateFromShas) Run(
	args ...string,
) (results sku.TransactedMutableSet, err error)

type CreateOrganizeFile

type CreateOrganizeFile struct {
	*local_working_copy.Repo
	organize_text.Options
}

TODO support using query results for organize population

func (CreateOrganizeFile) Run

func (cmd CreateOrganizeFile) Run() (results *organize_text.Text, err error)

func (CreateOrganizeFile) RunAndWrite

func (cmd CreateOrganizeFile) RunAndWrite(
	writer io.Writer,
) (results *organize_text.Text, err error)

type Diff

type Diff struct {
	*local_working_copy.Repo

	object_metadata.TextFormatterFamily
}

TODO move to store_fs

func (Diff) Run

func (op Diff) Run(
	remoteCheckedOut sku.SkuType,
	options object_metadata.TextFormatterOptions,
) (err error)

type EachBlob

type EachBlob struct {
	*local_working_copy.Repo
	Utility string
}

TODO move to store_fs

func (EachBlob) Run

func (c EachBlob) Run(
	skus sku.SkuTypeSet,
) (err error)

type ExecLua

type ExecLua struct {
	*local_working_copy.Repo
}

func (ExecLua) Run

func (u ExecLua) Run(sk *sku.Transacted, args ...string) (err error)

type OpenEditor

type OpenEditor struct {
	VimOptions []string
}

func (OpenEditor) Run

func (c OpenEditor) Run(
	u *local_working_copy.Repo,
	args ...string,
) (err error)

type Organize

type Organize struct {
	*local_working_copy.Repo
	organize_text.Metadata
	DontUseQueryGroupForOrganizeMetadata bool
}

TODO migrate over to Organize2

func (Organize) RunWithQueryGroup

func (op Organize) RunWithQueryGroup(
	qg *query.Query,
) (organizeResults organize_text.OrganizeResults, err error)

func (Organize) RunWithSkuType

func (op Organize) RunWithSkuType(
	q *query.Query,
	skus sku.SkuTypeSet,
) (organizeResults organize_text.OrganizeResults, err error)

func (Organize) RunWithTransacted

func (op Organize) RunWithTransacted(
	qg *query.Query,
	transacted sku.TransactedSet,
) (organizeResults organize_text.OrganizeResults, err error)

TODO remove

type Organize2

type Organize2 struct {
	*local_working_copy.Repo
	organize_text.Metadata
}

func (Organize2) Run

func (op Organize2) Run(
	skus sku.CheckedOutMutableSet,
) (organizeResults organize_text.OrganizeResults, err error)

type ReadOrganizeFile

type ReadOrganizeFile struct{}

func (ReadOrganizeFile) Run

func (c ReadOrganizeFile) Run(
	u *local_working_copy.Repo,
	r io.Reader,
	om organize_text.Metadata,
) (ot *organize_text.Text, err error)

func (ReadOrganizeFile) RunWithPath

func (c ReadOrganizeFile) RunWithPath(
	u *local_working_copy.Repo,
	p string,
	repoId ids.RepoId,
) (ot *organize_text.Text, err error)

type WriteNewZettels

type WriteNewZettels struct {
	*local_working_copy.Repo
}

func (WriteNewZettels) RunMany

func (op WriteNewZettels) RunMany(
	proto sku.Proto,
	count int,
) (results sku.TransactedMutableSet, err error)

func (WriteNewZettels) RunOne

func (c WriteNewZettels) RunOne(
	z sku.Proto,
) (result *sku.Transacted, err error)