mirror of
https://github.com/spf13/cobra
synced 2024-11-19 12:17:09 +00:00
118 lines
3 KiB
Go
118 lines
3 KiB
Go
// Copyright © 2015 Steve Francia <spf@spf13.com>.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Parts inspired by https://github.com/ryanuber/go-license
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/spf13/viper"
|
|
)
|
|
|
|
//Licenses contains all possible licenses a user can chose from
|
|
var Licenses map[string]License
|
|
|
|
//License represents a software license agreement, containing the Name of
|
|
// the license, its possible matches (on the command line as given to cobra)
|
|
// the header to be used with each file on the file's creating, and the text
|
|
// of the license
|
|
type License struct {
|
|
Name string // The type of license in use
|
|
PossibleMatches []string // Similar names to guess
|
|
Text string // License text data
|
|
Header string // License header for source files
|
|
}
|
|
|
|
func init() {
|
|
Licenses = make(map[string]License)
|
|
|
|
// Allows a user to not use a license.
|
|
Licenses["none"] = License{"None", []string{"none", "false"}, "", ""}
|
|
|
|
// Allows a user to use config for a custom license.
|
|
Licenses["custom"] = License{"Custom", []string{}, "", ""}
|
|
|
|
initApache2()
|
|
initMit()
|
|
initBsdClause3()
|
|
initBsdClause2()
|
|
initGpl2()
|
|
initGpl3()
|
|
initLgpl()
|
|
initAgpl()
|
|
|
|
// Licenses["apache20"] = License{
|
|
// Name: "Apache 2.0",
|
|
// PossibleMatches: []string{"apache", "apache20", ""},
|
|
// Header: `
|
|
// `,
|
|
// Text: `
|
|
// `,
|
|
// }
|
|
}
|
|
|
|
func getLicense() License {
|
|
l := whichLicense()
|
|
if l != "" {
|
|
if x, ok := Licenses[l]; ok {
|
|
return x
|
|
}
|
|
}
|
|
|
|
return Licenses["apache"]
|
|
}
|
|
|
|
func whichLicense() string {
|
|
// if explicitly flagged, use that
|
|
if userLicense != "" {
|
|
return matchLicense(userLicense)
|
|
}
|
|
|
|
// if already present in the project, use that
|
|
// TODO: Inspect project for existing license
|
|
|
|
// default to viper's setting
|
|
|
|
if viper.IsSet("license.header") || viper.IsSet("license.text") {
|
|
if custom, ok := Licenses["custom"]; ok {
|
|
custom.Header = viper.GetString("license.header")
|
|
custom.Text = viper.GetString("license.text")
|
|
Licenses["custom"] = custom
|
|
return "custom"
|
|
}
|
|
}
|
|
|
|
return matchLicense(viper.GetString("license"))
|
|
}
|
|
|
|
func copyrightLine() string {
|
|
author := viper.GetString("author")
|
|
year := time.Now().Format("2006")
|
|
|
|
return "Copyright © " + year + " " + author
|
|
}
|
|
|
|
// given a license name (in), try to match the license indicated
|
|
func matchLicense(in string) string {
|
|
for key, lic := range Licenses {
|
|
for _, match := range lic.PossibleMatches {
|
|
if strings.EqualFold(in, match) {
|
|
return key
|
|
}
|
|
}
|
|
}
|
|
return ""
|
|
}
|