mirror of
https://github.com/jimeh/undent.git
synced 2026-02-19 03:56:38 +00:00
Jim Myhrberg
b2057429a1
This effectively cleans up what I consider syntactical sugar required
due to Go's syntax. For example:
str := undent.String(`
hello
world`,
)
In the above example I would consider the initial line-break after the
opening back-tick (`) character syntactical sugar, and hence should be
discarded from the final undented string.
However if the literal string contains more than one initial line-break,
only the first one should be removed, as the rest would intentionally be
part of the input.
82 lines
1.5 KiB
Go
82 lines
1.5 KiB
Go
// Package undent removes leading indentation/white-space from strings and byte
|
|
// slices.
|
|
package undent
|
|
|
|
import (
|
|
"fmt"
|
|
"regexp"
|
|
)
|
|
|
|
var matcher = regexp.MustCompile(`(?m)^([ \t]*)(?:\S)`)
|
|
|
|
// Bytes removes leading indentation/white-space from given byte slice.
|
|
func Bytes(b []byte) []byte {
|
|
if len(b) > 0 && b[0] == '\n' {
|
|
b = b[1:]
|
|
}
|
|
|
|
matches := matcher.FindAll(b, -1)
|
|
if len(matches) == 0 {
|
|
return b
|
|
}
|
|
|
|
index := 0
|
|
length := len(matches[0])
|
|
|
|
for i, s := range matches[1:] {
|
|
l := len(s)
|
|
if l < length {
|
|
index = i + 1
|
|
length = l
|
|
}
|
|
}
|
|
|
|
if length <= 1 {
|
|
return b
|
|
}
|
|
indent := matches[index][0 : length-1]
|
|
|
|
return regexp.MustCompile(
|
|
`(?m)^`+regexp.QuoteMeta(string(indent)),
|
|
).ReplaceAllLiteral(b, []byte{})
|
|
}
|
|
|
|
// String removes leading indentation/white-space from given string.
|
|
func String(s string) string {
|
|
if len(s) > 0 && s[0] == '\n' {
|
|
s = s[1:]
|
|
}
|
|
|
|
matches := matcher.FindAllString(s, -1)
|
|
if len(matches) == 0 {
|
|
return s
|
|
}
|
|
|
|
index := 0
|
|
length := len(matches[0])
|
|
|
|
for i, s := range matches[1:] {
|
|
l := len(s)
|
|
if l < length {
|
|
index = i + 1
|
|
length = l
|
|
}
|
|
}
|
|
|
|
if length <= 1 {
|
|
return s
|
|
}
|
|
indent := matches[index][0 : length-1]
|
|
|
|
return regexp.MustCompile(
|
|
`(?m)^`+regexp.QuoteMeta(indent),
|
|
).ReplaceAllLiteralString(s, "")
|
|
}
|
|
|
|
// Stringf removes leading indentation/white-space from given format string
|
|
// before passing format and all additional arguments to fmt.Sprintf, returning
|
|
// the result.
|
|
func Stringf(format string, a ...interface{}) string {
|
|
return fmt.Sprintf(String(format), a...)
|
|
}
|