Describe the bug

When using a heredoc.Docf as a string interpolation variable for another heredoc.Docf (for instance in the context of building json payloads) with the purpose of (un)marshaling, when there are newlines, the code crashes with error: invalid character '\n' in string literal.

After looking at this StackOverflow, it seems it's because we need to double escape the newlines in JSON string literals. So we should provide an example of how to work with JSON in such a way, as I find heredoc to be very convenient for writing JSON-related tests.

Can we add a new method heredoc.Json/Jsonf( to handle this case + an example in the readme ? Or is there already a workaround to get this working with docf (in which case it would be nice to add this somewhere in the readme) ?

To Reproduce

Code:

import ("github.com/MakeNowJust/heredoc/v2")
func TestHeredocInsideHeredoc(t *testing.T) {
	interpolationHeredoc := heredoc.Docf(`
		Hello,
		%s
	`, "World")
	topLevelHeredoc := heredoc.Docf(`
		{
			"type": "top-level",
			"content": "%s",
		}`, interpolationHeredoc,
	)
	expectedJson := `
		{
			"type": "top-level",
			"content": "Hello,\nWorld"
		}
	`

	expectedBytes := []byte(expectedJson)
	var expectedObject map[string]interface{}
	err := json.Unmarshal(expectedBytes, &expectedObject)
	if err != nil {
		fmt.Println("error:", err)
	}

	expectedBytes = []byte(topLevelHeredoc)
	var actualObject map[string]interface{}
	err = json.Unmarshal(expectedBytes, &actualObject)
	if err != nil {
		fmt.Println("error:", err)
	}

	if diff := deep.Equal(expectedObject, actualObject); diff != nil {
		t.Error(diff)
	}
}

Expected:

OK

Actual:

error: invalid character '\n' in string literal
--- FAIL: TestHeredocInsideHeredoc (0.00s)
    /Users/Cyril/dev/dont-slack-evil/apphome/apphome_test.go:49: [map[content:map[content:Hello,
        World type:top-level] type:nested] != <nil map>]

Environment

• OS: [e.g. Windows, macOS, Linux]
• Go: [e.g. 1.12.9]
• Version: [e.g. 1.0.0]

Describe the bug

Wrong character is produced by heredoc.Doc function when indent contains full-width (zenkaku, u+3000) space.

To Reproduce

With:

package main

import (
	"fmt"

	"github.com/MakeNowJust/heredoc"
)

func main() {
	fmt.Printf("%#+v\n", heredoc.Doc("\n\u3000hello"))
}

Shows this result: "\x80\x80hello". "\x80" is wrong character.

Expected behavior

"hello" is correct result.

Describe the bug

I'm not sure if such behaviour is inconsistent?

To Reproduce

Code:

package main

import (
	"fmt"

	"github.com/MakeNowJust/heredoc/v2"
)

func main() {
	fmt.Println(heredoc.Doc(`
			Is it a basic indentation level or not?
		  Minus one tab plus two spaces.
			To compare.
	`))
}

Expected:

	Is it a basic indentation level or not?
 Minus one tab plus two spaces.
	To compare.

Actual:

Is it a basic indentation level or not?
 Minus one tab plus two spaces.
To compare.

Environment

• OS: Go playground
• Go: Go release
• Version: ?

Describe the bug

$ go get -u github.com/MakeNowJust/[email protected]
go: finding github.com/MakeNowJust/heredoc v2.0.1
go: finding github.com/MakeNowJust/heredoc v2.0.1
go get github.com/MakeNowJust/[email protected]: github.com/MakeNowJust/[email protected]: invalid version: module contains a go.mod file, so major version must be compatible: should be v0 or v1, not v2

https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher
you should make /v2 dir or v2 branch.

e.g. favclip/ucon#33

To Reproduce

Code: same as below

Expected: go get succeed

Actual: raise error

Environment

• OS: macOS
• Go: 1.13.4
• Version: 2.0.1