glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-05-06 05:17:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add config to prevent addition of copyright notice

Browse source 
Some projects do not add copyright headers to the tops of their files.
Right now you can specify `license: none` to prevent a license from
being generated for the file. But you will still get a line like:
  `// Copyright © 2017 NAME HERE <EMAIL ADDRESS>`

This change allows passing `author: none` to prevent that line from
being generated. The change does not alter the defaults. However, it
does slightly change the formatting templates to prevent the
extraneous addition of newlines when an author or liciece line is not
requested.
This commit is contained in:
Joe Richey 2019-05-16 20:27:05 -07:00
parent 67fc4837d2
commit ada5eb9754
4 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
cobra/README.md
View file

@ -92,3 +92,6 @@ license:
You can also use built-in licenses. For example, **GPLv2**, **GPLv3**, **LGPL**,
**AGPL**, **MIT**, **2-Clause BSD** or **3-Clause BSD**.
You can prevent the generation of the `// Copyright © 2015 AUTHOR <EMAIL>` line
at the top of the file by setting `author` to `none`.

6
cobra/cmd/add.go
View file

@ -120,9 +120,9 @@ func validateCmdName(source string) string {
}
func createCmdFile(license License, path, cmdName string) {
template := `{{comment .copyright}}
{{if .license}}{{comment .license}}{{end}}
template := `{{if .copyright}}{{comment .copyright}}
{{end}}{{if .license}}{{comment .license}}
{{end}}
package {{.cmdPackage}}
import (

12
cobra/cmd/init.go
View file

@ -106,9 +106,9 @@ func createLicenseFile(license License, path string) {
}
func createMainFile(project *Project) {
mainTemplate := `{{ comment .copyright }}
{{if .license}}{{ comment .license }}{{end}}
mainTemplate := `{{if .copyright}}{{comment .copyright}}
{{end}}{{if .license}}{{comment .license}}
{{end}}
package main
import "{{ .importpath }}"
@ -134,9 +134,9 @@ func main() {
}
func createRootCmdFile(project *Project) {
template := `{{comment .copyright}}
{{if .license}}{{comment .license}}{{end}}
template := `{{if .copyright}}{{comment .copyright}}
{{end}}{{if .license}}{{comment .license}}
{{end}}
package cmd
import (

3
cobra/cmd/licenses.go
View file

@ -77,6 +77,9 @@ func getLicense() License {
func copyrightLine() string {
author := viper.GetString("author")
if author == "none" {
return ""
}
year := viper.GetString("year") // For tests.
if year == "" {