Merge pull request #27 from github/elr/refactor-to-spdxexp

rename package from expression to spdxexp

README.md

@@ -2,6 +2,18 @@
 
 Golang implementation of a checker for determining if a set of SPDX IDs satisfies an SPDX Expression.
 
+## Installation
+
+There are several ways to include a go package.  To download and install, you can use `go get`.  The command for that is:
+
+```sh
+go get github.com/github/go-spdx@latest
+```
+
+## Packages
+
+- [spdxexp](https://pkg.go.dev/github.com/github/go-spdx/spdxexp) - Expression package validates licenses and determines if a license expression is satisfied by a list of licenses. Validity of a license is determined by the SPDX license list.
+
 ## Public API
 
 _NOTE: The public API is initially limited to the Satisfies and ValidateLicenses functions.  If

expression/compare.go → spdxexp/compare.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 func compareGT(first *node, second *node) bool {
 	if !first.isLicense() || !second.isLicense() {

expression/compare_test.go → spdxexp/compare_test.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"testing"

spdxexp/doc.go

@@ -0,0 +1,7 @@
+/*
+Spdxexp package validates licenses and determines if a license expression is satisfied by a list of licenses.
+Validity of a license is determined by the [SPDX license list].
+
+[SPDX license list]: https://spdx.org/licenses/
+*/
+package spdxexp

expression/license.go → spdxexp/license.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"strings"

expression/license_test.go → spdxexp/license_test.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"testing"

expression/node.go → spdxexp/node.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"sort"
@@ -167,7 +167,7 @@ func (n *node) reconstructedLicenseString() *string {
 	return nil
 }
 
-// Sort an array of license and license reference nodes alphebetically based
+// Sort an array of license and license reference nodes alphabetically based
 // on their reconstructedLicenseString() representation.  The sort function does not expect
 // expression nodes, but if one is in the nodes list, it will sort to the end.
 func sortLicenses(nodes []*node) {

expression/node_test.go → spdxexp/node_test.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"testing"

expression/parse.go → spdxexp/parse.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"errors"

expression/parse_test.go → spdxexp/parse_test.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"errors"

expression/satisfies.go → spdxexp/satisfies.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"errors"

expression/satisfies_test.go → spdxexp/satisfies_test.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"errors"

expression/scan.go → spdxexp/scan.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 /* Translation to Go from javascript code: https://github.com/clearlydefined/spdx-expression-parse.js/blob/master/scan.js */
 

expression/scan_test.go → spdxexp/scan_test.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 import (
 	"errors"

expression/test_helper.go → spdxexp/test_helper.go

@@ -1,4 +1,4 @@
-package expression
+package spdxexp
 
 // getLicenseNode is a test helper method that is expected to create a valid
 // license node.  Use this function when the test data is known to be a valid