Make all packages internal

.prettierignore

@@ -5,7 +5,7 @@
 .ionide/
 
 # Test files
-/check/checkdata/schema/testdata/input/invalid-schema.json
-/check/checkdata/testdata/packageindexes/invalid-JSON/package_foo_index.json
-/check/checkfunctions/testdata/packageindexes/invalid-JSON/package_foo_index.json
-/check/checkfunctions/testdata/sketches/InvalidJSONMetadataFile/sketch.json
+/internal/check/checkdata/schema/testdata/input/invalid-schema.json
+/internal/check/checkdata/testdata/packageindexes/invalid-JSON/package_foo_index.json
+/internal/check/checkfunctions/testdata/packageindexes/invalid-JSON/package_foo_index.json
+/internal/check/checkfunctions/testdata/sketches/InvalidJSONMetadataFile/sketch.json

Taskfile.yml

@@ -17,8 +17,8 @@ tasks:
     desc: Generate Go code
     cmds:
       - go get -u "github.com/go-bindata/go-bindata/...@v3.1.1"
-      - go-bindata -nocompress -nometadata -o "./check/checkdata/schema/schemadata/bindata.go" --pkg schemadata --prefix "./etc/schemas/" "./etc/schemas/"
-      - go-bindata -nocompress -nometadata -o "./check/checkdata/schema/testdata/bindata.go" --pkg testdata --prefix "./check/checkdata/schema/testdata/input/" "./check/checkdata/schema/testdata/input/"
+      - go-bindata -nocompress -nometadata -o "./internal/check/checkdata/schema/schemadata/bindata.go" --pkg schemadata --prefix "./etc/schemas/" "./etc/schemas/"
+      - go-bindata -nocompress -nometadata -o "./internal/check/checkdata/schema/testdata/bindata.go" --pkg testdata --prefix "./internal/check/checkdata/schema/testdata/input/" "./internal/check/checkdata/schema/testdata/input/"
       - go get -u golang.org/x/tools/cmd/stringer@v0.0.0-20201211192254-72fbef54948b
       - go generate ./...
       - task: go:format
@@ -255,7 +255,7 @@ vars:
   TIMESTAMP:
     sh: echo "$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
   LDFLAGS: >
-    -ldflags '-X github.com/arduino/arduino-lint/configuration.commit={{.COMMIT}} -X github.com/arduino/arduino-lint/configuration.buildTimestamp={{.TIMESTAMP}}'
+    -ldflags '-X github.com/arduino/arduino-lint/internal/configuration.commit={{.COMMIT}} -X github.com/arduino/arduino-lint/internal/configuration.buildTimestamp={{.TIMESTAMP}}'
   GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic"
 
   GOLINTFLAGS: "-min_confidence 0.8 -set_exit_status"
@@ -268,5 +268,5 @@ vars:
 
   WORKFLOW_SCHEMA_PATH: "$(mktemp -t gha-workflow-schema-XXXXXXXXXX.json)"
 
-  CODESPELL_SKIP_OPTION: '--skip "./.git,go.mod,go.sum,./arduino-lint,./arduino-lint.exe,./check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/library.properties,./site"'
+  CODESPELL_SKIP_OPTION: '--skip "./.git,go.mod,go.sum,./arduino-lint,./arduino-lint.exe,./internal/check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/library.properties,./site"'
   CODESPELL_IGNORE_WORDS_OPTION: "--ignore-words ./etc/codespell-ignore-words-list.txt"

docs/CONTRIBUTING.md

@@ -124,7 +124,7 @@ By default, all tests for all arduino-lint's Go packages are run. To run unit te
 packages, you can set the `TARGETS` environment variable, e.g.:
 
 ```
-TARGETS=./check task go:test-unit
+TARGETS=./internal/check task go:test-unit
 ```
 
 Alternatively, to run only some specific test(s), you can specify a regex to match against the test function name, e.g.:
@@ -136,7 +136,7 @@ TEST_REGEX='^TestLibraryProperties.*' task go:test-unit
 Both can be combined as well, typically to run only a specific test:
 
 ```
-TEST_REGEX='^TestFindProjects$' TARGETS=./project task go:test-unit
+TEST_REGEX='^TestFindProjects$' TARGETS=./internal/project task go:test-unit
 ```
 
 #### Integration tests

docsgen/main.go

@@ -19,7 +19,7 @@ package main
 import (
 	"os"
 
-	"github.com/arduino/arduino-lint/cli"
+	"github.com/arduino/arduino-lint/internal/cli"
 	"github.com/spf13/cobra/doc"
 )
 

check/check.go → internal/check/check.go

@@ -19,14 +19,14 @@ package check
 import (
 	"fmt"
 
-	"github.com/arduino/arduino-lint/check/checkconfigurations"
-	"github.com/arduino/arduino-lint/check/checkdata"
-	"github.com/arduino/arduino-lint/check/checkresult"
-	"github.com/arduino/arduino-lint/configuration"
-	"github.com/arduino/arduino-lint/configuration/checkmode"
-	"github.com/arduino/arduino-lint/project"
-	"github.com/arduino/arduino-lint/result"
-	"github.com/arduino/arduino-lint/result/feedback"
+	"github.com/arduino/arduino-lint/internal/check/checkconfigurations"
+	"github.com/arduino/arduino-lint/internal/check/checkdata"
+	"github.com/arduino/arduino-lint/internal/check/checkresult"
+	"github.com/arduino/arduino-lint/internal/configuration"
+	"github.com/arduino/arduino-lint/internal/configuration/checkmode"
+	"github.com/arduino/arduino-lint/internal/project"
+	"github.com/arduino/arduino-lint/internal/result"
+	"github.com/arduino/arduino-lint/internal/result/feedback"
 	"github.com/sirupsen/logrus"
 )
 

check/check_test.go → internal/check/check_test.go

@@ -18,12 +18,12 @@ package check
 import (
 	"testing"
 
-	"github.com/arduino/arduino-lint/check/checkconfigurations"
-	"github.com/arduino/arduino-lint/configuration"
-	"github.com/arduino/arduino-lint/configuration/checkmode"
-	"github.com/arduino/arduino-lint/project"
-	"github.com/arduino/arduino-lint/project/projecttype"
-	"github.com/arduino/arduino-lint/util/test"
+	"github.com/arduino/arduino-lint/internal/check/checkconfigurations"
+	"github.com/arduino/arduino-lint/internal/configuration"
+	"github.com/arduino/arduino-lint/internal/configuration/checkmode"
+	"github.com/arduino/arduino-lint/internal/project"
+	"github.com/arduino/arduino-lint/internal/project/projecttype"
+	"github.com/arduino/arduino-lint/internal/util/test"
 	"github.com/stretchr/testify/assert"
 )
 

check/checkconfigurations/checkconfigurations.go → internal/check/checkconfigurations/checkconfigurations.go

@@ -24,9 +24,9 @@ Package checkconfigurations defines the configuration of each check:
 package checkconfigurations
 
 import (
-	"github.com/arduino/arduino-lint/check/checkfunctions"
-	"github.com/arduino/arduino-lint/configuration/checkmode"
-	"github.com/arduino/arduino-lint/project/projecttype"
+	"github.com/arduino/arduino-lint/internal/check/checkfunctions"
+	"github.com/arduino/arduino-lint/internal/configuration/checkmode"
+	"github.com/arduino/arduino-lint/internal/project/projecttype"
 )
 
 // Type is the type for check configurations.

check/checkconfigurations/checkconfigurations_test.go → internal/check/checkconfigurations/checkconfigurations_test.go

@@ -19,11 +19,11 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/arduino/arduino-lint/check"
-	"github.com/arduino/arduino-lint/check/checkconfigurations"
-	"github.com/arduino/arduino-lint/check/checklevel"
-	"github.com/arduino/arduino-lint/configuration/checkmode"
-	"github.com/arduino/arduino-lint/project/projecttype"
+	"github.com/arduino/arduino-lint/internal/check"
+	"github.com/arduino/arduino-lint/internal/check/checkconfigurations"
+	"github.com/arduino/arduino-lint/internal/check/checklevel"
+	"github.com/arduino/arduino-lint/internal/configuration/checkmode"
+	"github.com/arduino/arduino-lint/internal/project/projecttype"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )

check/checkdata/checkdata.go → internal/check/checkdata/checkdata.go

@@ -20,9 +20,9 @@ This is for data required by multiple checks.
 package checkdata
 
 import (
-	"github.com/arduino/arduino-lint/project"
-	"github.com/arduino/arduino-lint/project/packageindex"
-	"github.com/arduino/arduino-lint/project/projecttype"
+	"github.com/arduino/arduino-lint/internal/project"
+	"github.com/arduino/arduino-lint/internal/project/packageindex"
+	"github.com/arduino/arduino-lint/internal/project/projecttype"
 	"github.com/arduino/go-paths-helper"
 )
 

check/checkdata/library.go → internal/check/checkdata/library.go

@@ -22,11 +22,11 @@ import (
 	"os"
 
 	"github.com/arduino/arduino-cli/arduino/libraries"
-	"github.com/arduino/arduino-lint/check/checkdata/schema"
-	"github.com/arduino/arduino-lint/check/checkdata/schema/compliancelevel"
-	"github.com/arduino/arduino-lint/project"
-	"github.com/arduino/arduino-lint/project/library/libraryproperties"
-	"github.com/arduino/arduino-lint/result/feedback"
+	"github.com/arduino/arduino-lint/internal/check/checkdata/schema"
+	"github.com/arduino/arduino-lint/internal/check/checkdata/schema/compliancelevel"
+	"github.com/arduino/arduino-lint/internal/project"
+	"github.com/arduino/arduino-lint/internal/project/library/libraryproperties"
+	"github.com/arduino/arduino-lint/internal/result/feedback"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/client9/misspell"
 	"github.com/sirupsen/logrus"

check/checkdata/packageindex_test.go → internal/check/checkdata/packageindex_test.go

@@ -18,8 +18,8 @@ package checkdata
 import (
 	"testing"
 
-	"github.com/arduino/arduino-lint/project"
-	"github.com/arduino/arduino-lint/project/projecttype"
+	"github.com/arduino/arduino-lint/internal/project"
+	"github.com/arduino/arduino-lint/internal/project/projecttype"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/assert"
 )

check/checkdata/platform.go → internal/check/checkdata/platform.go

@@ -16,8 +16,8 @@
 package checkdata
 
 import (
-	"github.com/arduino/arduino-lint/project"
-	"github.com/arduino/arduino-lint/project/platform/boardstxt"
+	"github.com/arduino/arduino-lint/internal/project"
+	"github.com/arduino/arduino-lint/internal/project/platform/boardstxt"
 	"github.com/arduino/go-properties-orderedmap"
 )
 

check/checkdata/platform_test.go → internal/check/checkdata/platform_test.go

@@ -18,8 +18,8 @@ package checkdata
 import (
 	"testing"
 
-	"github.com/arduino/arduino-lint/project"
-	"github.com/arduino/arduino-lint/project/projecttype"
+	"github.com/arduino/arduino-lint/internal/project"
+	"github.com/arduino/arduino-lint/internal/project/projecttype"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/assert"
 )

check/checkdata/schema/schema_test.go → internal/check/checkdata/schema/schema_test.go

@@ -19,7 +19,7 @@ import (
 	"regexp"
 	"testing"
 
-	"github.com/arduino/arduino-lint/check/checkdata/schema/testdata"
+	"github.com/arduino/arduino-lint/internal/check/checkdata/schema/testdata"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/ory/jsonschema/v3"
 	"github.com/stretchr/testify/require"
@@ -199,14 +199,14 @@ func Test_schemaID(t *testing.T) {
 	require.NotNil(t, err)
 
 	id, err := schemaID("valid-schema.json", testdata.Asset)
-	require.Equal(t, "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/schema-with-references.json", id)
+	require.Equal(t, "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/schema-with-references.json", id)
 	require.Nil(t, err)
 }
 
 func Test_validationErrorSchemaPointerValue(t *testing.T) {
 	validationError := ValidationResult{
 		Result: &jsonschema.ValidationError{
-			SchemaURL: "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/referenced-schema-1.json",
+			SchemaURL: "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/referenced-schema-1.json",
 			SchemaPtr: "#/definitions/patternObject/pattern",
 		},
 		dataLoader: testdata.Asset,

check/checkdata/schema/testdata/bindata.go → internal/check/checkdata/schema/testdata/bindata.go

@@ -1,11 +1,11 @@
 // Package testdata Code generated by go-bindata. (@generated) DO NOT EDIT.
 // sources:
-// check/checkdata/schema/testdata/input/invalid-schema.json
-// check/checkdata/schema/testdata/input/referenced-schema-1.json
-// check/checkdata/schema/testdata/input/referenced-schema-2.json
-// check/checkdata/schema/testdata/input/schema-without-id.json
-// check/checkdata/schema/testdata/input/valid-schema-with-references.json
-// check/checkdata/schema/testdata/input/valid-schema.json
+// internal/check/checkdata/schema/testdata/input/invalid-schema.json
+// internal/check/checkdata/schema/testdata/input/referenced-schema-1.json
+// internal/check/checkdata/schema/testdata/input/referenced-schema-2.json
+// internal/check/checkdata/schema/testdata/input/schema-without-id.json
+// internal/check/checkdata/schema/testdata/input/valid-schema-with-references.json
+// internal/check/checkdata/schema/testdata/input/valid-schema.json
 package testdata
 
 import (
@@ -82,7 +82,7 @@ func invalidSchemaJson() (*asset, error) {
 
 var _referencedSchema1Json = []byte(`{
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/referenced-schema-1.json",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/referenced-schema-1.json",
   "title": "Schema for use in unit tests",
   "definitions": {
     "patternObject": {
@@ -112,7 +112,7 @@ func referencedSchema1Json() (*asset, error) {
 
 var _referencedSchema2Json = []byte(`{
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/referenced-schema-2.json",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/referenced-schema-2.json",
   "title": "Schema for use in unit tests",
   "definitions": {
     "minLengthObject": {
@@ -182,7 +182,7 @@ func schemaWithoutIdJson() (*asset, error) {
 
 var _validSchemaWithReferencesJson = []byte(`{
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/schema-with-references.json",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/schema-with-references.json",
   "title": "Schema for use in unit tests",
   "type": "object",
   "properties": {
@@ -242,7 +242,7 @@ func validSchemaWithReferencesJson() (*asset, error) {
 
 var _validSchemaJson = []byte(`{
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/schema-with-references.json",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/schema-with-references.json",
   "title": "Schema for use in unit tests",
   "type": "object",
   "properties": {

check/checkdata/schema/testdata/input/referenced-schema-1.json → internal/check/checkdata/schema/testdata/input/referenced-schema-1.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/referenced-schema-1.json",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/referenced-schema-1.json",
   "title": "Schema for use in unit tests",
   "definitions": {
     "patternObject": {

check/checkdata/schema/testdata/input/referenced-schema-2.json → internal/check/checkdata/schema/testdata/input/referenced-schema-2.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/referenced-schema-2.json",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/referenced-schema-2.json",
   "title": "Schema for use in unit tests",
   "definitions": {
     "minLengthObject": {

check/checkdata/schema/testdata/input/valid-schema-with-references.json → internal/check/checkdata/schema/testdata/input/valid-schema-with-references.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/schema-with-references.json",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/schema-with-references.json",
   "title": "Schema for use in unit tests",
   "type": "object",
   "properties": {

check/checkdata/schema/testdata/input/valid-schema.json → internal/check/checkdata/schema/testdata/input/valid-schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/schema-with-references.json",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/internal/check/checkdata/schema/testdata/schema-with-references.json",
   "title": "Schema for use in unit tests",
   "type": "object",
   "properties": {

check/checkdata/sketch.go → internal/check/checkdata/sketch.go

@@ -17,7 +17,7 @@ package checkdata
 
 import (
 	"github.com/arduino/arduino-cli/arduino/sketches"
-	"github.com/arduino/arduino-lint/project"
+	"github.com/arduino/arduino-lint/internal/project"
 )
 
 // InitializeForSketch gathers the check data for the specified sketch project.

check/checkfunctions/checkfunctions.go → internal/check/checkfunctions/checkfunctions.go

@@ -22,9 +22,9 @@ import (
 	"regexp"
 	"strings"
 
-	"github.com/arduino/arduino-lint/check/checkdata"
-	"github.com/arduino/arduino-lint/check/checkresult"
-	"github.com/arduino/arduino-lint/project/sketch"
+	"github.com/arduino/arduino-lint/internal/check/checkdata"
+	"github.com/arduino/arduino-lint/internal/check/checkresult"
+	"github.com/arduino/arduino-lint/internal/project/sketch"
 	"github.com/arduino/go-paths-helper"
 )
 

check/checkfunctions/checkfunctions_test.go → internal/check/checkfunctions/checkfunctions_test.go

@@ -20,10 +20,10 @@ import (
 	"regexp"
 	"testing"
 
-	"github.com/arduino/arduino-lint/check/checkdata"
-	"github.com/arduino/arduino-lint/check/checkresult"
-	"github.com/arduino/arduino-lint/project"
-	"github.com/arduino/arduino-lint/project/projecttype"
+	"github.com/arduino/arduino-lint/internal/check/checkdata"
+	"github.com/arduino/arduino-lint/internal/check/checkresult"
+	"github.com/arduino/arduino-lint/internal/project"
+	"github.com/arduino/arduino-lint/internal/project/projecttype"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/assert"
 )

check/checkfunctions/library.go → internal/check/checkfunctions/library.go

@@ -26,12 +26,12 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/utils"
-	"github.com/arduino/arduino-lint/check/checkdata"
-	"github.com/arduino/arduino-lint/check/checkdata/schema"
-	"github.com/arduino/arduino-lint/check/checkdata/schema/compliancelevel"
-	"github.com/arduino/arduino-lint/check/checkresult"
-	"github.com/arduino/arduino-lint/project/library"
-	"github.com/arduino/arduino-lint/project/sketch"
+	"github.com/arduino/arduino-lint/internal/check/checkdata"
+	"github.com/arduino/arduino-lint/internal/check/checkdata/schema"
+	"github.com/arduino/arduino-lint/internal/check/checkdata/schema/compliancelevel"
+	"github.com/arduino/arduino-lint/internal/check/checkresult"
+	"github.com/arduino/arduino-lint/internal/project/library"
+	"github.com/arduino/arduino-lint/internal/project/sketch"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
 	"github.com/go-git/go-git/v5/plumbing/object"

check/checkfunctions/library_test.go → internal/check/checkfunctions/library_test.go

@@ -21,10 +21,10 @@ import (
 	"testing"
 	"time"
 
-	"github.com/arduino/arduino-lint/check/checkdata"
-	"github.com/arduino/arduino-lint/check/checkresult"
-	"github.com/arduino/arduino-lint/project"
-	"github.com/arduino/arduino-lint/project/projecttype"
+	"github.com/arduino/arduino-lint/internal/check/checkdata"
+	"github.com/arduino/arduino-lint/internal/check/checkresult"
+	"github.com/arduino/arduino-lint/internal/project"
+	"github.com/arduino/arduino-lint/internal/project/projecttype"
 	"github.com/arduino/go-paths-helper"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing/object"

check/checkfunctions/packageindex.go → internal/check/checkfunctions/packageindex.go

@@ -16,8 +16,8 @@
 package checkfunctions
 
 import (
-	"github.com/arduino/arduino-lint/check/checkdata"
-	"github.com/arduino/arduino-lint/check/checkresult"
+	"github.com/arduino/arduino-lint/internal/check/checkdata"
+	"github.com/arduino/arduino-lint/internal/check/checkresult"
 )
 
 // The check functions for package indexes.