Skip to content

Commit d521897

Browse files
per1234per1234
committed
Make all packages internal
The Go packages of this project were written solely for the use within the project. Making them internal avoids them unintentionally becoming part of the public API, resulting in a greatly increased potential maintenance and support burden and limitations on further development work. It would be interesting to identify the components of the internal API that might be useful to others and expose them intentionally as they reach a state of relative stability. However, for now the public API should be considered only the command line interface and the JSON report structure.
1 parent 54e1502 commit d521897

File tree

321 files changed

+165
-165
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

321 files changed

+165
-165
lines changed

‎.prettierignore‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.ionide/
66

77
# Test files
8-
/check/checkdata/schema/testdata/input/invalid-schema.json
9-
/check/checkdata/testdata/packageindexes/invalid-JSON/package_foo_index.json
10-
/check/checkfunctions/testdata/packageindexes/invalid-JSON/package_foo_index.json
11-
/check/checkfunctions/testdata/sketches/InvalidJSONMetadataFile/sketch.json
8+
/internal/check/checkdata/schema/testdata/input/invalid-schema.json
9+
/internal/check/checkdata/testdata/packageindexes/invalid-JSON/package_foo_index.json
10+
/internal/check/checkfunctions/testdata/packageindexes/invalid-JSON/package_foo_index.json
11+
/internal/check/checkfunctions/testdata/sketches/InvalidJSONMetadataFile/sketch.json

‎Taskfile.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ tasks:
1717
desc: Generate Go code
1818
cmds:
1919
- go get -u "github.com/go-bindata/go-bindata/...@v3.1.1"
20-
- go-bindata -nocompress -nometadata -o "./check/checkdata/schema/schemadata/bindata.go" --pkg schemadata --prefix "./etc/schemas/" "./etc/schemas/"
21-
- go-bindata -nocompress -nometadata -o "./check/checkdata/schema/testdata/bindata.go" --pkg testdata --prefix "./check/checkdata/schema/testdata/input/" "./check/checkdata/schema/testdata/input/"
20+
- go-bindata -nocompress -nometadata -o "./internal/check/checkdata/schema/schemadata/bindata.go" --pkg schemadata --prefix "./etc/schemas/" "./etc/schemas/"
21+
- 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/"
2222
- go get -u golang.org/x/tools/cmd/stringer@v0.0.0-20201211192254-72fbef54948b
2323
- go generate ./...
2424
- task: go:format
@@ -255,7 +255,7 @@ vars:
255255
TIMESTAMP:
256256
sh: echo "$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
257257
LDFLAGS: >
258-
-ldflags '-X github.com/arduino/arduino-lint/configuration.commit={{.COMMIT}} -X github.com/arduino/arduino-lint/configuration.buildTimestamp={{.TIMESTAMP}}'
258+
-ldflags '-X github.com/arduino/arduino-lint/internal/configuration.commit={{.COMMIT}} -X github.com/arduino/arduino-lint/internal/configuration.buildTimestamp={{.TIMESTAMP}}'
259259
GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic"
260260

261261
GOLINTFLAGS: "-min_confidence 0.8 -set_exit_status"
@@ -268,5 +268,5 @@ vars:
268268

269269
WORKFLOW_SCHEMA_PATH: "$(mktemp -t gha-workflow-schema-XXXXXXXXXX.json)"
270270

271-
CODESPELL_SKIP_OPTION: '--skip "./.git,go.mod,go.sum,./arduino-lint,./arduino-lint.exe,./check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/library.properties,./site"'
271+
CODESPELL_SKIP_OPTION: '--skip "./.git,go.mod,go.sum,./arduino-lint,./arduino-lint.exe,./internal/check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/library.properties,./site"'
272272
CODESPELL_IGNORE_WORDS_OPTION: "--ignore-words ./etc/codespell-ignore-words-list.txt"

‎docs/CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions

‎docsgen/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ package main
1919
import (
2020
"os"
2121

22-
"github.com/arduino/arduino-lint/cli"
22+
"github.com/arduino/arduino-lint/internal/cli"
2323
"github.com/spf13/cobra/doc"
2424
)
2525

‎check/check.go‎ renamed to ‎internal/check/check.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ package check
1919
import (
2020
"fmt"
2121

22-
"github.com/arduino/arduino-lint/check/checkconfigurations"
23-
"github.com/arduino/arduino-lint/check/checkdata"
24-
"github.com/arduino/arduino-lint/check/checkresult"
25-
"github.com/arduino/arduino-lint/configuration"
26-
"github.com/arduino/arduino-lint/configuration/checkmode"
27-
"github.com/arduino/arduino-lint/project"
28-
"github.com/arduino/arduino-lint/result"
29-
"github.com/arduino/arduino-lint/result/feedback"
22+
"github.com/arduino/arduino-lint/internal/check/checkconfigurations"
23+
"github.com/arduino/arduino-lint/internal/check/checkdata"
24+
"github.com/arduino/arduino-lint/internal/check/checkresult"
25+
"github.com/arduino/arduino-lint/internal/configuration"
26+
"github.com/arduino/arduino-lint/internal/configuration/checkmode"
27+
"github.com/arduino/arduino-lint/internal/project"
28+
"github.com/arduino/arduino-lint/internal/result"
29+
"github.com/arduino/arduino-lint/internal/result/feedback"
3030
"github.com/sirupsen/logrus"
3131
)
3232

‎check/check_test.go‎ renamed to ‎internal/check/check_test.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ package check
1818
import (
1919
"testing"
2020

21-
"github.com/arduino/arduino-lint/check/checkconfigurations"
22-
"github.com/arduino/arduino-lint/configuration"
23-
"github.com/arduino/arduino-lint/configuration/checkmode"
24-
"github.com/arduino/arduino-lint/project"
25-
"github.com/arduino/arduino-lint/project/projecttype"
26-
"github.com/arduino/arduino-lint/util/test"
21+
"github.com/arduino/arduino-lint/internal/check/checkconfigurations"
22+
"github.com/arduino/arduino-lint/internal/configuration"
23+
"github.com/arduino/arduino-lint/internal/configuration/checkmode"
24+
"github.com/arduino/arduino-lint/internal/project"
25+
"github.com/arduino/arduino-lint/internal/project/projecttype"
26+
"github.com/arduino/arduino-lint/internal/util/test"
2727
"github.com/stretchr/testify/assert"
2828
)
2929

‎check/checkconfigurations/checkconfigurations.go‎ renamed to ‎internal/check/checkconfigurations/checkconfigurations.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ Package checkconfigurations defines the configuration of each check:
2424
package checkconfigurations
2525

2626
import (
27-
"github.com/arduino/arduino-lint/check/checkfunctions"
28-
"github.com/arduino/arduino-lint/configuration/checkmode"
29-
"github.com/arduino/arduino-lint/project/projecttype"
27+
"github.com/arduino/arduino-lint/internal/check/checkfunctions"
28+
"github.com/arduino/arduino-lint/internal/configuration/checkmode"
29+
"github.com/arduino/arduino-lint/internal/project/projecttype"
3030
)
3131

3232
// Type is the type for check configurations.

‎check/checkconfigurations/checkconfigurations_test.go‎ renamed to ‎internal/check/checkconfigurations/checkconfigurations_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ import (
1919
"fmt"
2020
"testing"
2121

22-
"github.com/arduino/arduino-lint/check"
23-
"github.com/arduino/arduino-lint/check/checkconfigurations"
24-
"github.com/arduino/arduino-lint/check/checklevel"
25-
"github.com/arduino/arduino-lint/configuration/checkmode"
26-
"github.com/arduino/arduino-lint/project/projecttype"
22+
"github.com/arduino/arduino-lint/internal/check"
23+
"github.com/arduino/arduino-lint/internal/check/checkconfigurations"
24+
"github.com/arduino/arduino-lint/internal/check/checklevel"
25+
"github.com/arduino/arduino-lint/internal/configuration/checkmode"
26+
"github.com/arduino/arduino-lint/internal/project/projecttype"
2727
"github.com/stretchr/testify/assert"
2828
"github.com/stretchr/testify/require"
2929
)

‎check/checkdata/checkdata.go‎ renamed to ‎internal/check/checkdata/checkdata.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ This is for data required by multiple checks.
2020
package checkdata
2121

2222
import (
23-
"github.com/arduino/arduino-lint/project"
24-
"github.com/arduino/arduino-lint/project/packageindex"
25-
"github.com/arduino/arduino-lint/project/projecttype"
23+
"github.com/arduino/arduino-lint/internal/project"
24+
"github.com/arduino/arduino-lint/internal/project/packageindex"
25+
"github.com/arduino/arduino-lint/internal/project/projecttype"
2626
"github.com/arduino/go-paths-helper"
2727
)
2828

‎check/checkdata/library.go‎ renamed to ‎internal/check/checkdata/library.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ import (
2222
"os"
2323

2424
"github.com/arduino/arduino-cli/arduino/libraries"
25-
"github.com/arduino/arduino-lint/check/checkdata/schema"
26-
"github.com/arduino/arduino-lint/check/checkdata/schema/compliancelevel"
27-
"github.com/arduino/arduino-lint/project"
28-
"github.com/arduino/arduino-lint/project/library/libraryproperties"
29-
"github.com/arduino/arduino-lint/result/feedback"
25+
"github.com/arduino/arduino-lint/internal/check/checkdata/schema"
26+
"github.com/arduino/arduino-lint/internal/check/checkdata/schema/compliancelevel"
27+
"github.com/arduino/arduino-lint/internal/project"
28+
"github.com/arduino/arduino-lint/internal/project/library/libraryproperties"
29+
"github.com/arduino/arduino-lint/internal/result/feedback"
3030
"github.com/arduino/go-properties-orderedmap"
3131
"github.com/client9/misspell"
3232
"github.com/sirupsen/logrus"

0 commit comments

Comments
 (0)