kezhenxu94 commented on code in PR #103: URL: https://github.com/apache/skywalking-eyes/pull/103#discussion_r866779231
########## pkg/deps/summary.go: ########## @@ -0,0 +1,114 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you 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 deps + +import ( + "bytes" + "os" + "path/filepath" + "regexp" + "text/template" + + "github.com/apache/skywalking-eyes/pkg/header" + "github.com/apache/skywalking-eyes/pkg/license" +) + +var fileNamePattern = regexp.MustCompile(`[^a-zA-Z0-9\\.\-]`) + +type SummaryRenderContext struct { + LicenseContent string // Current project license content + Groups []*SummaryRenderLicenseGroup // All dependency license groups +} + +type SummaryRenderLicenseGroup struct { + Name string // Aggregate all same license ID dependencies + Deps []*SummaryRenderLicense // Same license ID dependencies +} + +type SummaryRenderLicense struct { + Name string // Dependency name + Version string // Dependency version + Location string // The filename of generated license file + LicenseID string // License ID +} + +func GenerateDependencyLicenseFilename(result *Result) string { + filename := string(fileNamePattern.ReplaceAll([]byte(result.Dependency), []byte("-"))) + return "license-" + filename + ".txt" +} + +func ParseTemplate(path string) (*template.Template, error) { + absPath, err := filepath.Abs(path) + if err != nil { + return nil, err + } + tpl, err := os.ReadFile(absPath) + if err != nil { + return nil, err + } + return template.New("summary").Parse(string(tpl)) +} + +// GenerateSummary generate the summary content by template, license config and dependency report +func GenerateSummary(tpl *template.Template, head *header.ConfigHeader, rep *Report) (string, error) { + var r bytes.Buffer + context, err := generateSummaryRenderContext(head, rep) + if err != nil { + return "", err + } + if err := tpl.Execute(&r, context); err != nil { + return "", err + } + return r.String(), nil +} + +func generateSummaryRenderContext(head *header.ConfigHeader, rep *Report) (*SummaryRenderContext, error) { + // the license id of the project + licenseContent, err := license.GetLicenseContent(head.License.SpdxID) + if err != nil { + return nil, err + } Review Comment: > Sure, If the `head.License.SpdxID` is not set, should I just throw a new error? or another config could get the license? You can use this method to get the license content, but notice only use this as a fallback when the users don't specify spdxID https://github.com/apache/skywalking-eyes/blob/985866ce7e324454f61e22eb2db2e998db09d6f3/pkg/header/config.go#L171 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@skywalking.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
