internal

Documentation

Overview

Copyright © 2022 Mike Messmore <mike@messmore.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2022 Mike Messmore <mike@messmore.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2022 Mike Messmore <mike@messmore.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2022 Mike Messmore <mike@messmore.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2022 Mike Messmore <mike@messmore.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2022 Mike Messmore <mike@messmore.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2022 Mike Messmore <mike@messmore.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Constants
• Variables
• func AddBookmark(category string, title string, url string)
• func Background(args ...string) (*os.Process, error)
• func BookmarkComplete(category string, toComplete string) []string
• func CD()
• func CategoryComplete(toComplete string) []string
• func ConvertToPDF(title string, outPath string)
• func Create(title string)
• func DisplayHumanConfig()
• func Edit(path string)
• func EditByTitle(title string)
• func Exec(args ...string) error
• func ExecGit(args ...string)
• func GetBookmarkCategories(bookmarks []BookmarkCategory, toComplete string) []string
• func GetBookmarkNames(bookmarks []Bookmark, toComplete string) []string
• func GetBrowser() (string, error)
• func GetEditor() (string, error)
• func GetGit() (string, error)
• func GetHugo() (string, error)
• func GetPid() (int, error)
• func GetTitles(toComplete string) []string
• func InitRepo(path string, url string)
• func IsRunning() bool
• func NotePathsByTitle(title string) (string, string, bool)
• func Open()
• func Prompt(prompt string) bool
• func PromptToSaveConfig(root string, configPath string)
• func Rm(title string, force bool)
• func RmBookmark(category string, title string) bool
• func SetBookmarks(categories []BookmarkCategory)
• func SetPid(pid int) error
• func Start()
• func Stop()
• func Todo()
• func UpdateSubmodule()
• func YamlConfig(path string)
• type Bookmark
• type BookmarkCategory
  • func GetBookmarks() []BookmarkCategory
• type RunError
  • func Run(args ...string) *RunError
  • func RunGit(args ...string) *RunError
  • func (r *RunError) Error() string

Constants

const MAX_PID_SIZE int = 5

Linux has up to 32768 MacOS up to 99998 FreeBSD up to 99999 So 5 bytes

Variables

var PID_FILE = ".hugo.pid"

var URL = "http://localhost:1313"

TODO: this shouldn't be hardcoded

Functions

func AddBookmark

func AddBookmark(category string, title string, url string)

func Background

func Background(args ...string) (*os.Process, error)

func BookmarkComplete

func BookmarkComplete(category string, toComplete string) []string

func CD

func CD()

func CategoryComplete

func CategoryComplete(toComplete string) []string

func ConvertToPDF

func ConvertToPDF(title string, outPath string)

Trying headless chrome

func Create

func Create(title string)

func DisplayHumanConfig

func DisplayHumanConfig()

func Edit

func Edit(path string)

func EditByTitle

func EditByTitle(title string)

func Exec

func Exec(args ...string) error

func ExecGit

func ExecGit(args ...string)

func GetBookmarkCategories

func GetBookmarkCategories(bookmarks []BookmarkCategory, toComplete string) []string

func GetBookmarkNames

func GetBookmarkNames(bookmarks []Bookmark, toComplete string) []string

func GetBrowser

func GetBrowser() (string, error)

func GetEditor

func GetEditor() (string, error)

func GetGit

func GetGit() (string, error)

func GetHugo

func GetHugo() (string, error)

func GetPid

func GetPid() (int, error)

func GetTitles

func GetTitles(toComplete string) []string

func InitRepo

func InitRepo(path string, url string)

func IsRunning

func IsRunning() bool

func NotePathsByTitle

func NotePathsByTitle(title string) (string, string, bool)

func Open

func Open()

func Prompt

func Prompt(prompt string) bool

func PromptToSaveConfig

func PromptToSaveConfig(root string, configPath string)

func Rm

func Rm(title string, force bool)

func RmBookmark

func RmBookmark(category string, title string) bool

func SetBookmarks

func SetBookmarks(categories []BookmarkCategory)

func SetPid

func SetPid(pid int) error

func Start

func Start()

func Stop

func Stop()

func Todo

func Todo()

func UpdateSubmodule

func UpdateSubmodule()

func YamlConfig

func YamlConfig(path string)

Types

type Bookmark

type Bookmark struct {
	Name string `yaml:"Name"`
	Url  string `yaml:"URL"`
}

type BookmarkCategory

type BookmarkCategory struct {
	Name  string     `yaml:"Name"`
	Items []Bookmark `yaml:"Items"`
}

func GetBookmarks

func GetBookmarks() []BookmarkCategory

type RunError

type RunError struct {
	Output   string
	ExitCode int
	Tool     string
}

func Run

func Run(args ...string) *RunError

func RunGit

func RunGit(args ...string) *RunError

func (*RunError) Error

func (r *RunError) Error() string