scaffold

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

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

Documentation

Index

Constants

This section is empty.

Variables

View Source
var LicenseTemplate = `` /* 1087-byte string literal not displayed */
View Source
var ReadmeTemplate = `
# {{ .ProjectName }}

# Overview 

# Getting Started 

`

Functions

func AddRemoteOrigin

func AddRemoteOrigin(fp, url string) error

AddRemoteOrigin sets the URL for the 'origin' remote

func Create

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

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

func PushRepo

func PushRepo(fp string) error

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

Types

type LicenseData

type LicenseData struct {
	CopyrightYear string
	Author        string
}

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

type ReadmeData

type ReadmeData struct {
	ProjectName string
}

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL