Skip to content

Use "rule" term instead of "check" #125

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 4 commits into from
Dec 21, 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
Jump to file
Failed to load files.
Loading
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
/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
/internal/rule/schema/testdata/input/invalid-schema.json
/internal/project/projectdata/testdata/packageindexes/invalid-JSON/package_foo_index.json
/internal/rule/rulefunction/testdata/packageindexes/invalid-JSON/package_foo_index.json
/internal/rule/rulefunction/testdata/sketches/InvalidJSONMetadataFile/sketch.json
6 changes: 3 additions & 3 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/...@v3.1.1"
- 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-bindata -nocompress -nometadata -o "./internal/rule/schema/schemadata/bindata.go" --pkg schemadata --prefix "./etc/schemas/" "./etc/schemas/"
- go-bindata -nocompress -nometadata -o "./internal/rule/schema/testdata/bindata.go" --pkg testdata --prefix "./internal/rule/schema/testdata/input/" "./internal/rule/schema/testdata/input/"
- go get -u golang.org/x/tools/cmd/stringer@v0.0.0-20201211192254-72fbef54948b
- go generate ./...
- task: go:format
Expand Down Expand Up @@ -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,./internal/check/checkfunctions/testdata/libraries/MisspelledSentenceParagraphValue/library.properties,./site"'
CODESPELL_SKIP_OPTION: '--skip "./.git,go.mod,go.sum,./arduino-lint,./arduino-lint.exe,./internal/rule/rulefunction/testdata/libraries/MisspelledSentenceParagraphValue/library.properties,./site"'
CODESPELL_IGNORE_WORDS_OPTION: "--ignore-words ./etc/codespell-ignore-words-list.txt"
2 changes: 1 addition & 1 deletion 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=./internal/check task go:test-unit
TARGETS=./internal/rule 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 Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
**arduino-lint** is a command line tool that checks for common problems with [Arduino](https://www.arduino.cc/)
projects.

Its focus is on the structure, metadata, and configuration of Arduino projects, rather than the code. Checks cover
Its focus is on the structure, metadata, and configuration of Arduino projects, rather than the code. Rules cover
[specification](https://arduino.github.io/arduino-cli/latest/library-specification) compliance, Library Manager
submission [requirements](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ), and best practices.

Expand Down
99 changes: 0 additions & 99 deletions internal/check/check.go

This file was deleted.

97 changes: 0 additions & 97 deletions internal/check/checkconfigurations/checkconfigurations_test.go

This file was deleted.

Loading