Documentation ¶
Index ¶
- Constants
- Variables
- func NewInMemoryWorkspaceProvider(doc *automerge.Doc) *inMemoryWorkspaceProvider
- func ResolveAuthor(flagValue string) (string, error)
- func ResolveConfigDirectory(flagValue string) (string, error)
- func ResolveWorkspaceUid(flagValue string) (string, error)
- func ValidateAndCleanUnicode(input string, allowMultiline bool) (output string, err error)
- func ValidateTodoAnnotationKey(key string) error
- func ValidateTodoDescription(input string) (string, error)
- func ValidateTodoStatus(input string) (string, error)
- func ValidateTodoTitle(input string) (string, error)
- func ValidateWorkspaceAlias(input string) (string, error)
- func ValidatedAuthor(input string) error
- type Comment
- type CreateCommentParams
- type CreateTodoParams
- type CreateWorkspaceParams
- type DeleteCommentParams
- type DeleteTodoParams
- type DocProvider
- type EditCommentParams
- type EditTodoParams
- type StorageProvider
- type Todo
- type WorkspaceMeta
- type WorkspaceProvider
Constants ¶
View Source
const ( ConfigDirEnvironmentVariable = "AU_DIRECTORY" WorkspaceUidEnvironmentVariable = "AU_WORKSPACE" AuthorEnvironmentVariable = "AU_AUTHOR" EditorVariable = "AU_EDITOR" GlobalEditorVariable = "EDITOR" DefaultConfigDir = "$HOME/.au" )
View Source
const AurelianRankAnnotation = "https://" + ReservedAnnotationHostname + "/annotations/rank"
View Source
const DefaultCommentMediaType = "text/markdown"
View Source
const MaximumAliasLength = 100
View Source
const MaximumDescriptionLength = 5000
View Source
const MaximumTodoTitleLength = 200
View Source
const MinimumAliasLength = 3
View Source
const MinimumTodoTitleLength = 3
View Source
const ReservedAnnotationHostname = "aurelian.one"
View Source
const ReservedAnnotationShortHostname = "aurelian"
View Source
const Suffix = ".automerge"
Variables ¶
View Source
var Commit = "unknown"
View Source
var CommitTimestamp = "0"
View Source
var ErrContainsInvalidUtf8Runes = errors.New("contains invalid utf8 runes")
View Source
var ErrDisallowedCharacter = errors.New("disallowed rune")
View Source
var Version = "unknown"
Functions ¶
func NewInMemoryWorkspaceProvider ¶ added in v0.0.9
func NewInMemoryWorkspaceProvider(doc *automerge.Doc) *inMemoryWorkspaceProvider
func ResolveAuthor ¶ added in v0.0.8
func ResolveConfigDirectory ¶
func ResolveWorkspaceUid ¶
func ValidateAndCleanUnicode ¶ added in v0.0.8
func ValidateTodoAnnotationKey ¶ added in v0.0.8
func ValidateTodoDescription ¶ added in v0.0.8
func ValidateTodoStatus ¶ added in v0.0.8
func ValidateTodoTitle ¶ added in v0.0.8
func ValidateWorkspaceAlias ¶ added in v0.0.8
func ValidatedAuthor ¶ added in v0.0.8
Types ¶
type CreateCommentParams ¶ added in v0.0.8
type CreateTodoParams ¶ added in v0.0.7
type CreateWorkspaceParams ¶ added in v0.0.7
type CreateWorkspaceParams struct {
Alias string
}
type DeleteCommentParams ¶ added in v0.0.9
type DeleteCommentParams struct {
DeletedBy string
}
type DeleteTodoParams ¶ added in v0.0.9
type DeleteTodoParams struct {
DeletedBy string
}
type DocProvider ¶ added in v0.0.7
type DocProvider interface {
GetDoc() *automerge.Doc
}
type EditCommentParams ¶ added in v0.0.8
type EditTodoParams ¶ added in v0.0.7
type StorageProvider ¶ added in v0.0.7
type StorageProvider interface { ListWorkspaces(ctx context.Context) ([]WorkspaceMeta, error) GetWorkspace(ctx context.Context, id string) (*WorkspaceMeta, error) CreateWorkspace(ctx context.Context, params CreateWorkspaceParams) (*WorkspaceMeta, error) DeleteWorkspace(ctx context.Context, id string) error ImportWorkspace(ctx context.Context, id string, data []byte) (*WorkspaceMeta, error) GetCurrentWorkspace(ctx context.Context) (string, error) SetCurrentWorkspace(ctx context.Context, id string) error SetCurrentAuthor(ctx context.Context, author string) error OpenWorkspace(ctx context.Context, id string, writeable bool) (WorkspaceProvider, error) }
func NewDirectoryStorage ¶ added in v0.0.7
func NewDirectoryStorage(path string) (StorageProvider, error)
type WorkspaceMeta ¶ added in v0.0.7
type WorkspaceProvider ¶ added in v0.0.7
type WorkspaceProvider interface { Metadata() WorkspaceMeta ListTodos(ctx context.Context) ([]Todo, error) GetTodo(ctx context.Context, id string) (*Todo, error) CreateTodo(ctx context.Context, params CreateTodoParams) (*Todo, error) EditTodo(ctx context.Context, id string, params EditTodoParams) (*Todo, error) DeleteTodo(ctx context.Context, id string, params DeleteTodoParams) error ListComments(ctx context.Context, todoId string) ([]Comment, error) GetComment(ctx context.Context, todoId, commentId string) (*Comment, error) CreateComment(ctx context.Context, todoId string, params CreateCommentParams) (*Comment, error) EditComment(ctx context.Context, todoId, commentId string, params EditCommentParams) (*Comment, error) DeleteComment(ctx context.Context, todoId, commentId string, params DeleteCommentParams) error Flush() error Close() error }
Click to show internal directories.
Click to hide internal directories.