1
0

Compare commits

..

No commits in common. "f1f7e62853991f8680e93c536d755ca70efdcfe0" and "31ff39d0c0751ac144bb42babaf766be09039615" have entirely different histories.

55 changed files with 63 additions and 32 deletions

View File

@ -5,19 +5,19 @@ Effortlessly craft the perfect LICENSE for your Git repo in seconds with a singl
## Usage ## Usage
This command will generate ISC `LICENSE` file in your current directory, including current year, and your name read from Git configuration: This command will generate ISC `LICENSE` file in your current directory, including current year, and your name read from Git configuration:
```bash ```bash
licensmith add ISC licensmith --license ISC
``` ```
By default, Licensmith read your local repository looking for user details (name and e-mail), as a fallback it uses global configuration. By default, Licensmith read your local repository looking for user details (name and e-mail), as a fallback it uses global configuration.
You can also specify different values using: You can also specify different values using:
```bash ```bash
licensmith add ISC --name "John Doe" --email "jdoe@example.com" licensmith --license ISC --name "John Doe" --email "jdoe@example.com"
``` ```
To list available templates run: To list available templates run:
```bash ```bash
licensmith list licensmith --list
``` ```
## Installation ## Installation

View File

@ -1,4 +1,4 @@
package internal package main
import ( import (
"errors" "errors"

10
go.mod
View File

@ -2,12 +2,4 @@ module git.brono.cloud/wzykubek/licensmith
go 1.23.4 go 1.23.4
require ( require gopkg.in/yaml.v3 v3.0.1 // indirect
github.com/spf13/cobra v1.8.1
gopkg.in/yaml.v3 v3.0.1
)
require (
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/spf13/pflag v1.0.5 // indirect
)

9
go.sum
View File

@ -1,12 +1,3 @@
github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

View File

@ -1,4 +1,4 @@
package internal package main
import ( import (
"time" "time"

View File

@ -1,4 +1,4 @@
package internal package main
import ( import (
"bytes" "bytes"
@ -19,7 +19,7 @@ type Licenser struct {
func (l *Licenser) ParseTemplate() (LicenseTemplate, error) { func (l *Licenser) ParseTemplate() (LicenseTemplate, error) {
tmplPath := "templates/" + l.LicenseID + ".tmpl" tmplPath := "templates/" + l.LicenseID + ".tmpl"
data, err := EmbedFS.ReadFile(tmplPath) data, err := TemplatesDir.ReadFile(tmplPath)
if err != nil { if err != nil {
return LicenseTemplate{}, err return LicenseTemplate{}, err
} }

47
main.go
View File

@ -1,9 +1,52 @@
package main package main
import ( import (
"git.brono.cloud/wzykubek/licensmith/cmd" "flag"
"fmt"
"os"
) )
func main() { func main() {
cmd.Execute() OutputFile := flag.String("output", "LICENSE", "Specify different output file")
LicenseID := flag.String("license", "", "Specify license by SPDX ID (e.g. BSD-3-Clause)")
AuthorName := flag.String("name", "", "Set the author name (read from Git by default)")
AuthorEmail := flag.String("email", "", "Set the author email (read from Git by default)")
ListLicenses := flag.Bool("list", false, "List available licenses")
flag.Parse()
if *ListLicenses {
listLicenses()
os.Exit(0)
}
if *LicenseID == "" {
fmt.Printf("Error: No license specified\n\nUse --license LICENSE\n\nAvailable licenses:\n")
listLicenses()
os.Exit(1)
}
licenseCtx, err := NewLicenseContext(*AuthorName, *AuthorEmail)
if err != nil && err.Error() == "can't read Git config" {
fmt.Printf(
"Error: Can't read Git config.\n\nUse --name \"NAME\" and --email EMAIL instead.\n",
)
os.Exit(3)
}
licenser := Licenser{
LicenseID: *LicenseID,
LicenseContext: licenseCtx,
OutputFile: *OutputFile,
}
err = licenser.Generate()
if err != nil && err.Error() == "usupported license" {
fmt.Printf("Error: There is no '%s' license\n\nAvailable licenses:\n", *LicenseID)
listLicenses()
os.Exit(2)
}
if err = licenser.WriteFile(); err != nil {
panic(err)
}
} }

View File

@ -1,4 +1,4 @@
package internal package main
import ( import (
"embed" "embed"
@ -6,8 +6,8 @@ import (
"strings" "strings"
) )
//go:embed templates/* //go:embed all:templates
var EmbedFS embed.FS var TemplatesDir embed.FS
type LicenseTemplate struct { type LicenseTemplate struct {
Title string `yaml:"title"` Title string `yaml:"title"`
@ -19,8 +19,8 @@ type LicenseTemplate struct {
Body string Body string
} }
func ListTemplates() []string { func listTemplates() []string {
files, err := fs.ReadDir(EmbedFS, "templates") files, err := fs.ReadDir(TemplatesDir, "templates")
if err != nil { if err != nil {
panic(err) panic(err)
} }
@ -32,3 +32,8 @@ func ListTemplates() []string {
return tmplList return tmplList
} }
func listLicenses() {
tmplList := listTemplates()
println(strings.Join(tmplList, ", "))
}