scaffold

package

v1.1.0 Latest Latest Go to latest Published: Feb 19, 2020 License: MIT Imports: 8 Imported by: 0

Details

This section is empty.

View Source

var LicenseTemplate = `` /* 1087-byte string literal not displayed */

View Source

var ReadmeTemplate = `
# {{ .ProjectName }}

# Overview 

# Getting Started 

`

func AddRemoteOrigin(fp, url string) error

AddRemoteOrigin sets the URL for the 'origin' remote

func Create(name, slug, author string, log *logrus.Logger) error

Create handles the initial local filesystem setup including creating the directory, initializing git, rendering initial files, etc

func GetGitUserName(fp string) (string, error)

GetGitUserName attempts to read the author name from git config

func PushRepo(fp string) error

PushRepo executes a git push command to push up all local files that were scaffolded

type LicenseData struct {
	CopyrightYear string
	Author        string
}

LicenseData is the information required to render the LICENSE file in the new repo

type ReadmeData struct {
	ProjectName string
}

ReadmeData is the information required to render the README.md file in the new repo