README
¶
anno 
Go package for text annotation. Read the article covering anno
- Simple interface
- Very extensible
- Looks nice in JSON (good for APIs)
Usage
s := "Find http://www.websites.com/ and #hashtags and @mentions easily"
notes, err := anno.FindManyString(s, anno.Emails, anno.URLs, anno.Mentions, anno.Hashtags)
if err != nil {
log.Fatalln(err)
}
for _, note := range notes {
log.Printf("Found a %s at [%d:%d]: \"%s\"", note.Kind, note.Start, note.End, note.Val)
}
Will output:
Found a url at [5:29]: "http://www.websites.com/"
Found a mention at [48:57]: "@mentions"
Found a hashtag at [34:43]: "#hashtags"
You can expand (replace) occurances of the notes using anno.Expander:
expander := anno.Expander{
"url": func(b string) string {
return fmt.Sprintf(`<a href="%[1]s">%[1]s</a>`, b)
},
"mention": func(b string) string {
return fmt.Sprintf(`<a href="https://downlist.io/%[1]s">%[1]s</a>`, b)
},
}
src := "This is a #long string written by @mat containing links to https://downlist.io/."
notes, err := anno.FindManyString(src, anno.URLs, anno.Mentions, anno.Hashtags)
if err != nil {
log.Fatalln(err)
}
log.Println(expander.Expand(src, notes))
Will output:
This is a #long string written by <a href="https://downlist.io/@mat">@mat</a> containing links to <a href="https://downlist.io/">https://downlist.io/</a>.
Emoji
Emoji support lives in its own package due to the external dependency.
src := "You make me want to :smile: you know!"
notes, err := anno.FindManyString(src, emoji.Find)
expander := anno.Expander{
"emoji": emoji.Expand,
}
log.Println(expander.Expand(src, notes))
Will replace :smile: with the appropriate emoji character.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Emails = FieldFunc("email", func(s []byte) (bool, []byte) { trimmedS := TrimPunctuation(s) if !bytes.Contains(s, []byte("@")) { return false, s } for _, tld := range tlds { if bytes.HasSuffix(s, tld) { return true, trimmedS } } return false, s })
Emails finds email addresses.
trimmedS := TrimPunctuation(s) return bytes.HasPrefix(trimmedS, []byte("#")), trimmedS })
Hashtags finds #hashtags.
var Mentions = FieldFunc("mention", func(s []byte) (bool, []byte) { trimmedS := TrimPunctuation(s) return bytes.HasPrefix(trimmedS, []byte("@")), trimmedS })
Mentions finds @twitter style mentions.
var Punctuation = `.?!'",;`
Punctuation is a string of common punctuation and quotation characters.
var URLs = FieldFunc("url", func(s []byte) (bool, []byte) { trimmedS := TrimPunctuation(s) if bytes.Contains(s, []byte("@")) { return false, s } if bytes.HasPrefix(trimmedS, []byte("http")) || bytes.HasPrefix(trimmedS, []byte("www")) { return true, trimmedS } for _, tld := range tlds { if bytes.HasSuffix(trimmedS, tld) { return true, trimmedS } } return false, s })
URL finds web addresses.
Functions ¶
func TrimPunctuation ¶
TrimPunctuation trims off Punctuation characters.
Types ¶
type ErrNoMatch ¶
type ErrNoMatch []byte
ErrNoMatch is returned when a match was expected but can not be found. Can be returned from FieldFunc.
func (ErrNoMatch) Error ¶
func (e ErrNoMatch) Error() string
type Expander ¶
Expander holds a map of note kinds to expander functions that will be used to replace the text in the original string.
type FinderFunc ¶
FinderFunc represents a function capable of finding notes.
func FieldFunc ¶
func FieldFunc(kind string, fn func(b []byte) (bool, []byte)) FinderFunc
FieldFunc returns a FinderFunc that finds notes on a per field basis. The fn returns true if it's a match, and optionally a subset of the the match. The returned []byte must be contained in the source string, otherwise ErrNoMatch will be returned.
type Notes ¶
type Notes []*Note
Notes is a sortable slice of Note objects.
func FindMany ¶
FindMany runs all finders against the source and returns a slice of notes or an error.
func FindManyString ¶
FindManyString runs all finders against the source and returns a slice of notes or an error.
func FindString ¶
FindString uses the Finder to find notes within the specified string.
Source Files
Directories