Skip to content

Make all packages internal #115

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.

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

Merged
merged 1 commit into from
Dec 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 4 additions & 4 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ tasks:
desc: Generate Go code
cmds:
- go get -u "github.com/go-bindata/go-bindata/[email protected]"
- 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/[email protected]
- go generate ./...
- task: go:format
Expand Down Expand Up @@ -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"
Expand All @@ -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"
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docsgen/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down
16 changes: 8 additions & 8 deletions check/check.go → internal/check/check.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down
12 changes: 6 additions & 6 deletions check/check_test.go → internal/check/check_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
@@ -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 (
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading