Skip to content

Dynamic license terms #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Dynamic license terms #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dca0ed2
Update main.go
kiruthi006 Mar 13, 2025
2c113c8
Create LicenceTerms.json
kiruthi006 Mar 13, 2025
97ca321
Update main.go
kiruthi006 Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions LicenceTerms.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[
"hashicorp, inc.",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Why do we need hashicorp, inc. in this file now ?

Also "copyright" is missing in this list. Can you also move this file under addlicense directory ?

"mozilla public",
"spdx-license-identifier",
]
26 changes: 23 additions & 3 deletions addlicense/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,27 @@ func hasLicense(b []byte) bool {
if len(b) < 1000 {
n = len(b)
}
return bytes.Contains(bytes.ToLower(b[:n]), []byte("copyright")) ||
bytes.Contains(bytes.ToLower(b[:n]), []byte("mozilla public")) ||
bytes.Contains(bytes.ToLower(b[:n]), []byte("spdx-license-identifier"))

// Default conditions
defaultTerms := []string{"hashicorp, inc.", "mozilla public", "spdx-license-identifier"}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: We should now be iterating only on the list present in the json file

We can keep the default terms in the LicenseTerms.json


// Load conditions from config file
configPath := "../LicenceCopywrite.json"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: Having the file path hardcoded over here prevents users from adding any new licenses in the cli
Maybe we can have the file path as a parameter in the hcl config

file, err := os.ReadFile(configPath)
if err == nil {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: We should add the capability for this function to return errors

Instead of having the function silently failing and using default terms, we should let the user know that the Readfile function failed

var customTerms []string
if json.Unmarshal(file, &customTerms) == nil && len(customTerms) > 0 {
defaultTerms = customTerms
}
}

// Check for license terms
content := bytes.ToLower(b[:n])
for _, term := range defaultTerms {
if bytes.Contains(content, []byte(strings.ToLower(term))) {
return true
}
}
return false
}