Merge pull request #6 from moonstream-to/file-headers

solface can now add SPDX header and pragma to codegen output

Author: zomglings

interface.go

@@ -35,6 +35,8 @@ type InterfaceSpecification struct {
 	IncludeAnnotations bool
 	CompoundTypes      []CompoundType
 	SolfaceVersion     string
+	License            string
+	Pragma             string
 }
 
 func GenerateName(nameCounter *int) string {
@@ -213,8 +215,14 @@ func ResolveCompounds(abi DecodedABI) DecodedABIWithCompundTypes {
 	return result
 }
 
-func GenerateInterface(interfaceName string, abi DecodedABI, annotations Annotations, includeAnnotations bool, writer io.Writer) error {
+func GenerateInterface(interfaceName, license, pragma string, abi DecodedABI, annotations Annotations, includeAnnotations bool, writer io.Writer) error {
 	const interfaceTemplate = `
+{{ if .License }}
+// SPDX-License-Identifier: {{.License}}
+{{ end }}
+{{- if .Pragma }}
+pragma solidity {{.Pragma}};
+{{ end }}
 // Interface generated by solface: https://github.com/moonstream-to/solface
 // solface version: {{.SolfaceVersion}}
 {{- $includeAnnotations := .IncludeAnnotations}}
@@ -253,7 +261,7 @@ interface {{.Name}} {
 `
 
 	resolved := ResolveCompounds(abi)
-	spec := InterfaceSpecification{Name: interfaceName, ABI: resolved.EnrichedABI, Annotations: annotations, IncludeAnnotations: includeAnnotations, CompoundTypes: resolved.CompoundTypes, SolfaceVersion: VERSION}
+	spec := InterfaceSpecification{Name: interfaceName, ABI: resolved.EnrichedABI, Annotations: annotations, IncludeAnnotations: includeAnnotations, CompoundTypes: resolved.CompoundTypes, SolfaceVersion: VERSION, License: license, Pragma: pragma}
 
 	templateFuncs := map[string]any{
 		"needsMemory": SolidityTypeRequiresLocation,

interface_test.go

@@ -151,8 +151,8 @@ func TestGenerateInterfaceDiamondCutFacet(t *testing.T) {
 	includeAnnotations := false
 
 	// Replace io.Discard with os.Stdout to inspect output:
-	// err := GenerateInterface("IDiamondCutFacet", abi, os.Stdout)
-	err := GenerateInterface("IDiamondCutFacet", abi, annotations, includeAnnotations, io.Discard)
+	// err := GenerateInterface("IDiamondCutFacet", "", "", abi, annotations, includeAnnotations, os.Stdout)
+	err := GenerateInterface("IDiamondCutFacet", "", "", abi, annotations, includeAnnotations, io.Discard)
 
 	if err != nil {
 		t.Fatalf("Error generating interface: %s", err.Error())
@@ -174,8 +174,8 @@ func TestGenerateInterfaceOwnableERC20(t *testing.T) {
 	includeAnnotations := false
 
 	// Replace io.Discard with os.Stdout to inspect output:
-	// err := GenerateInterface("IOwnableERC20", abi, os.Stdout)
-	err := GenerateInterface("IOwnableERC20", abi, annotations, includeAnnotations, io.Discard)
+	// err := GenerateInterface("IOwnableERC20", "Apache-2.0", "^8.20.0", abi, annotations, includeAnnotations, os.Stdout)
+	err := GenerateInterface("IOwnableERC20", "Apache-2.0", "^8.20.0", abi, annotations, includeAnnotations, io.Discard)
 
 	if err != nil {
 		t.Fatalf("Error generating interface: %s", err.Error())

main.go

@@ -8,13 +8,15 @@ import (
 	"os"
 )
 
-var VERSION string = "0.1.0"
+var VERSION string = "0.1.1"
 
 func main() {
-	var interfaceName string
+	var interfaceName, license, pragma string
 	var addAnnotations bool
 	flag.StringVar(&interfaceName, "name", "", "Name for Solidity interface you would like to generate")
 	flag.BoolVar(&addAnnotations, "annotations", false, "If present, adds annotations to generated interface. Annotations include: interface ID, method selectors, event signatures.")
+	flag.StringVar(&license, "license", "", "License to include in generated interface - adds a comment at the top of the output with this as the SPDX identifier")
+	flag.StringVar(&pragma, "pragma", "", "Solidity pragma to include in generated interface - adds this parameter as the pragma constraint at the top of the output")
 
 	flag.Usage = func() {
 		fmt.Fprintf(flag.CommandLine.Output(), "%s -name <interface name> [-annotations] {<path to ABI file> | stdin}\n\n", os.Args[0])
@@ -55,7 +57,7 @@ func main() {
 		log.Fatalf("Error generating annotations: %s", annotationErr.Error())
 	}
 
-	generateErr := GenerateInterface(interfaceName, abi, annotations, addAnnotations, os.Stdout)
+	generateErr := GenerateInterface(interfaceName, license, pragma, abi, annotations, addAnnotations, os.Stdout)
 	if generateErr != nil {
 		log.Fatalf("Error generating interface (%s): %s", interfaceName, generateErr.Error())
 	}