-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add report subcommand with custom templates
The new report subcommand replaces the existing csv command (and the csv command is now deprecated). By default `go-licenses report` will output CSV, but it also allows for a custom go template to be used.
- Loading branch information
1 parent
2aec38b
commit d28fcac
Showing
6 changed files
with
219 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| // Copyright 2019 Google Inc. All Rights Reserved. | ||
| // | ||
| // 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. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/csv" | ||
| "io/ioutil" | ||
| "os" | ||
| "text/template" | ||
|
|
||
| "github.com/golang/glog" | ||
| "github.com/google/go-licenses/licenses" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| var ( | ||
| reportHelp = "Prints report of all licenses that apply to one or more Go packages and their dependencies." | ||
| reportCmd = &cobra.Command{ | ||
| Use: "report <package> [package...]", | ||
| Short: reportHelp, | ||
| Long: reportHelp + packageHelp, | ||
| Args: cobra.MinimumNArgs(1), | ||
| RunE: reportMain, | ||
| } | ||
|
|
||
| templateFile string | ||
| ) | ||
|
|
||
| func init() { | ||
| reportCmd.Flags().StringVar(&templateFile, "template", "", "Custom Go template file to use for report") | ||
|
|
||
| rootCmd.AddCommand(reportCmd) | ||
| } | ||
|
|
||
| type libraryData struct { | ||
| Name string | ||
| LicenseURL string | ||
| LicenseName string | ||
| } | ||
|
|
||
| func reportMain(_ *cobra.Command, args []string) error { | ||
| classifier, err := licenses.NewClassifier(confidenceThreshold) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| libs, err := licenses.Libraries(context.Background(), classifier, ignore, args...) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var reportData []libraryData | ||
| for _, lib := range libs { | ||
| libData := libraryData{ | ||
| Name: lib.Name(), | ||
| LicenseURL: "Unknown", | ||
| LicenseName: "Unknown", | ||
| } | ||
| if lib.LicensePath != "" { | ||
| name, _, err := classifier.Identify(lib.LicensePath) | ||
| if err == nil { | ||
| libData.LicenseName = name | ||
| } else { | ||
| glog.Errorf("Error identifying license in %q: %v", lib.LicensePath, err) | ||
| } | ||
| url, err := lib.FileURL(context.Background(), lib.LicensePath) | ||
| if err == nil { | ||
| libData.LicenseURL = url | ||
| } else { | ||
| glog.Warningf("Error discovering license URL: %s", err) | ||
| } | ||
| } | ||
| reportData = append(reportData, libData) | ||
| } | ||
|
|
||
| if templateFile == "" { | ||
| return reportCSV(reportData) | ||
| } else { | ||
| return reportTemplate(reportData) | ||
| } | ||
| } | ||
|
|
||
| func reportCSV(libs []libraryData) error { | ||
| writer := csv.NewWriter(os.Stdout) | ||
| for _, lib := range libs { | ||
| if err := writer.Write([]string{lib.Name, lib.LicenseURL, lib.LicenseName}); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| writer.Flush() | ||
| return writer.Error() | ||
| } | ||
|
|
||
| func reportTemplate(libs []libraryData) error { | ||
| templateBytes, err := ioutil.ReadFile(templateFile) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| tmpl, err := template.New("").Parse(string(templateBytes)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return tmpl.Execute(os.Stdout, libs) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| {{ range . }} | ||
| - {{.Name}} ([{{.LicenseName}}]({{.LicenseURL}})) | ||
| {{- end }} |
Oops, something went wrong.