Skip to content

Commit dcda76a

Browse files
per1234per1234
authored
Merge pull request #107 from arduino/per1234/rename
Rename tool to final name: arduino-lint
2 parents ece3ff1 + 373ab95 commit dcda76a

File tree

74 files changed

+308
-308
lines changed

Some content is hidden

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

74 files changed

+308
-308
lines changed

‎.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Build artifacts
2-
arduino-check
3-
arduino-check.exe
2+
arduino-lint
3+
arduino-lint.exe
44

55
# Test artifacts
66
coverage_unit.txt

‎README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# arduino-check
1+
# arduino-lint
22

3-
`arduino-check` is a command line tool that automatically checks for common problems in your
3+
`arduino-lint` is a command line tool that automatically checks for common problems in your
44
[Arduino](https://www.arduino.cc/) projects:
55

66
- Sketches
77
- Libraries
88

99
## Usage
1010

11-
After installing `arduino-check`, run the command `arduino-check --help` for usage documentation.
11+
After installing `arduino-lint`, run the command `arduino-lint --help` for usage documentation.
1212

1313
A few additional configuration options only of use for internal/development use of the tool can be set via environment
1414
variables:
1515

16-
- `ARDUINO_CHECK_OFFICIAL` - Set to `"true"` to run the checks that only apply to official Arduino projects.
17-
- `ARDUINO_CHECK_LOG_LEVEL` - Messages with this level and above will be logged.
16+
- `ARDUINO_LINT_OFFICIAL` - Set to `"true"` to run the checks that only apply to official Arduino projects.
17+
- `ARDUINO_LINT_LOG_LEVEL` - Messages with this level and above will be logged.
1818
- Supported values: `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic`
19-
- `ARDUINO_CHECK_LOG_FORMAT` - The output format for the logs.
19+
- `ARDUINO_LINT_LOG_FORMAT` - The output format for the logs.
2020
- Supported values: `text`, `json`

‎Taskfile.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ vars:
197197
TIMESTAMP:
198198
sh: echo "$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
199199
LDFLAGS: >
200-
-ldflags '-X github.com/arduino/arduino-check/configuration.commit={{.COMMIT}} -X github.com/arduino/arduino-check/configuration.buildTimestamp={{.TIMESTAMP}}'
200+
-ldflags '-X github.com/arduino/arduino-lint/configuration.commit={{.COMMIT}} -X github.com/arduino/arduino-lint/configuration.buildTimestamp={{.TIMESTAMP}}'
201201
GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic"
202202

203203
GOLINTFLAGS: "-min_confidence 0.8 -set_exit_status"
@@ -206,5 +206,5 @@ vars:
206206

207207
WORKFLOW_SCHEMA_PATH: "$(mktemp -t gha-workflow-schema-XXXXXXXXXX.json)"
208208

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

‎check/check.go

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -19,14 +19,14 @@ package check
1919
import (
2020
"fmt"
2121

22-
"github.com/arduino/arduino-check/check/checkconfigurations"
23-
"github.com/arduino/arduino-check/check/checkdata"
24-
"github.com/arduino/arduino-check/check/checkresult"
25-
"github.com/arduino/arduino-check/configuration"
26-
"github.com/arduino/arduino-check/configuration/checkmode"
27-
"github.com/arduino/arduino-check/project"
28-
"github.com/arduino/arduino-check/result"
29-
"github.com/arduino/arduino-check/result/feedback"
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"
3030
"github.com/sirupsen/logrus"
3131
)
3232

‎check/check_test.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -18,12 +18,12 @@ package check
1818
import (
1919
"testing"
2020

21-
"github.com/arduino/arduino-check/check/checkconfigurations"
22-
"github.com/arduino/arduino-check/configuration"
23-
"github.com/arduino/arduino-check/configuration/checkmode"
24-
"github.com/arduino/arduino-check/project"
25-
"github.com/arduino/arduino-check/project/projecttype"
26-
"github.com/arduino/arduino-check/util/test"
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"
2727
"github.com/stretchr/testify/assert"
2828
)
2929

‎check/checkconfigurations/checkconfigurations.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -24,9 +24,9 @@ Package checkconfigurations defines the configuration of each check:
2424
package checkconfigurations
2525

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

3232
// Type is the type for check configurations.

‎check/checkconfigurations/checkconfigurations_test.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -19,10 +19,10 @@ import (
1919
"fmt"
2020
"testing"
2121

22-
"github.com/arduino/arduino-check/check"
23-
"github.com/arduino/arduino-check/check/checkconfigurations"
24-
"github.com/arduino/arduino-check/check/checklevel"
25-
"github.com/arduino/arduino-check/configuration/checkmode"
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"
2626
"github.com/stretchr/testify/assert"
2727
)
2828

‎check/checkdata/checkdata.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -20,9 +20,9 @@ This is for data required by multiple checks.
2020
package checkdata
2121

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

‎check/checkdata/library.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -21,12 +21,12 @@ import (
2121
"net/http"
2222
"os"
2323

24-
"github.com/arduino/arduino-check/check/checkdata/schema"
25-
"github.com/arduino/arduino-check/check/checkdata/schema/compliancelevel"
26-
"github.com/arduino/arduino-check/project"
27-
"github.com/arduino/arduino-check/project/library/libraryproperties"
28-
"github.com/arduino/arduino-check/result/feedback"
2924
"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"
3030
"github.com/arduino/go-properties-orderedmap"
3131
"github.com/client9/misspell"
3232
"github.com/sirupsen/logrus"

‎check/checkdata/packageindex.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//

‎check/checkdata/packageindex_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -18,8 +18,8 @@ package checkdata
1818
import (
1919
"testing"
2020

21-
"github.com/arduino/arduino-check/project"
22-
"github.com/arduino/arduino-check/project/projecttype"
21+
"github.com/arduino/arduino-lint/project"
22+
"github.com/arduino/arduino-lint/project/projecttype"
2323
"github.com/arduino/go-paths-helper"
2424
"github.com/stretchr/testify/assert"
2525
)

‎check/checkdata/platform.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -16,8 +16,8 @@
1616
package checkdata
1717

1818
import (
19-
"github.com/arduino/arduino-check/project"
20-
"github.com/arduino/arduino-check/project/platform/boardstxt"
19+
"github.com/arduino/arduino-lint/project"
20+
"github.com/arduino/arduino-lint/project/platform/boardstxt"
2121
"github.com/arduino/go-properties-orderedmap"
2222
)
2323

‎check/checkdata/platform_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -18,8 +18,8 @@ package checkdata
1818
import (
1919
"testing"
2020

21-
"github.com/arduino/arduino-check/project"
22-
"github.com/arduino/arduino-check/project/projecttype"
21+
"github.com/arduino/arduino-lint/project"
22+
"github.com/arduino/arduino-lint/project/projecttype"
2323
"github.com/arduino/go-paths-helper"
2424
"github.com/stretchr/testify/assert"
2525
)

‎check/checkdata/schema/compliancelevel/compliancelevel.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//

‎check/checkdata/schema/parsevalidationresult.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//

‎check/checkdata/schema/schema.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//

‎check/checkdata/schema/schema_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// This file is part of arduino-check.
1+
// This file is part of arduino-lint.
22
//
33
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
44
//
55
// This software is released under the GNU General Public License version 3,
6-
// which covers the main part of arduino-check.
6+
// which covers the main part of arduino-lint.
77
// The terms of this license can be found at:
88
// https://www.gnu.org/licenses/gpl-3.0.en.html
99
//
@@ -19,7 +19,7 @@ import (
1919
"regexp"
2020
"testing"
2121

22-
"github.com/arduino/arduino-check/check/checkdata/schema/testdata"
22+
"github.com/arduino/arduino-lint/check/checkdata/schema/testdata"
2323
"github.com/arduino/go-properties-orderedmap"
2424
"github.com/ory/jsonschema/v3"
2525
"github.com/stretchr/testify/require"
@@ -199,14 +199,14 @@ func Test_schemaID(t *testing.T) {
199199
require.NotNil(t, err)
200200

201201
id, err := schemaID("valid-schema.json", testdata.Asset)
202-
require.Equal(t, "https://raw.githubusercontent.com/arduino/arduino-check/main/check/checkdata/schema/testdata/schema-with-references.json", id)
202+
require.Equal(t, "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/schema-with-references.json", id)
203203
require.Nil(t, err)
204204
}
205205

206206
func Test_validationErrorSchemaPointerValue(t *testing.T) {
207207
validationError := ValidationResult{
208208
Result: &jsonschema.ValidationError{
209-
SchemaURL: "https://raw.githubusercontent.com/arduino/arduino-check/main/check/checkdata/schema/testdata/referenced-schema-1.json",
209+
SchemaURL: "https://raw.githubusercontent.com/arduino/arduino-lint/main/check/checkdata/schema/testdata/referenced-schema-1.json",
210210
SchemaPtr: "#/definitions/patternObject/pattern",
211211
},
212212
dataLoader: testdata.Asset,

0 commit comments

Comments
 (0)