Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Add Taskfile for common project actions #4

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
per1234 merged 1 commit into arduino:main from per1234:add-taskfile
Oct 27, 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
5 changes: 5 additions & 0 deletions .prettierignore
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# IDE files
.idea/
.vscode/
.vs/
.ionide/
12 changes: 12 additions & 0 deletions .prettierrc
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"semi": false,
"printWidth": 120,
"overrides": [
{
"files": "*.md",
"options": {
"proseWrap": "always"
}
}
]
}
193 changes: 193 additions & 0 deletions Taskfile.yml
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
version: "3"

tasks:
build:
desc: Build the project
cmds:
- go build -v

test:
desc: Run tests
cmds:
- task: go:test-unit
- task: schema:compile

go:test-unit:
desc: Run unit tests
cmds:
- go test -short -run '{{ default ".*" .TEST_REGEX }}' {{ default "-v" .GOFLAGS }} -coverprofile=coverage_unit.txt {{ default .DEFAULT_PACKAGES .PACKAGES }}

schema:compile:
desc: Compile JSON schema
cmds:
- npx ajv-cli compile -s "./etc/schema/*.json"

check:
desc: Lint and check formatting of all files
cmds:
- task: go:check
- task: docs:check
- task: config:check
- task: check-spelling

lint:
desc: Lint all files
cmds:
- task: go:lint
- task: docs:lint
- task: config:lint

check-formatting:
desc: Check formatting of all files
cmds:
- task: go:check-formatting
- task: docs:check-formatting
- task: config:check-formatting

format:
desc: Format all files
cmds:
- task: go:format
- task: docs:format
- task: config:format

go:check:
desc: Lint and check formatting of Go code
cmds:
- task: go:lint
- task: go:check-formatting

go:lint:
desc: Lint Go code
cmds:
- go vet {{ default .DEFAULT_PACKAGES .PACKAGES }}
- "'{{.GOLINTBIN}}' {{.GOLINTFLAGS}} {{ default .DEFAULT_TARGETS .TARGETS }}"

go:check-formatting:
desc: Check Go code formatting
cmds:
- |
RESULTS="$(gofmt -l {{ default .DEFAULT_PATHS .PATHS }})"
echo "$RESULTS"
test -z "$RESULTS"

go:format:
desc: Format Go code
cmds:
- go fmt {{ default .DEFAULT_PACKAGES .PACKAGES }}

docs:check:
desc: Lint and check formatting of documentation files
cmds:
- task: docs:check-formatting
- task: docs:check-links

docs:lint:
desc: Lint documentation files
cmds:
- task: docs:check-license

docs:check-license:
desc: Check if the license file is correctly formatted
cmds:
- |
EXPECTED_LICENSE_FILE="\"LICENSE.txt\""
EXPECTED_LICENSE_TYPE="\"GPL-3.0\"" # https://spdx.org/licenses/

# See: https://github.com/licensee/licensee
LICENSEE_OUTPUT="$(licensee detect --json --confidence=100)"

DETECTED_LICENSE_FILE="$(echo "$LICENSEE_OUTPUT" | jq .matched_files[0].filename | tr --delete '\r')"
echo "Detected license file: $DETECTED_LICENSE_FILE"
if [ "$DETECTED_LICENSE_FILE" != "$EXPECTED_LICENSE_FILE" ]; then
echo "ERROR: detected license file doesn't match expected: $EXPECTED_LICENSE_FILE"
exit 1
fi

DETECTED_LICENSE_TYPE="$(echo "$LICENSEE_OUTPUT" | jq .matched_files[0].matched_license | tr --delete '\r')"
echo "Detected license type: $DETECTED_LICENSE_TYPE"
if [ "$DETECTED_LICENSE_TYPE" != "$EXPECTED_LICENSE_TYPE" ]; then
echo "ERROR: detected license type doesn't match expected $EXPECTED_LICENSE_TYPE"
exit 1
fi

docs:check-links:
desc: Check for dead links in documentation
cmds:
- |
npx --package markdown-link-check --call '
STATUS=0
for file in $(find -name "*.md"); do
markdown-link-check --quiet "$file"
STATUS=$(( $STATUS + $? ))
done
exit $STATUS'

docs:check-formatting:
desc: Check formatting of documentation files
cmds:
- npx {{ .PRETTIER }} --check "**/*.md"

docs:format:
desc: Format documentation files
cmds:
- npx {{ .PRETTIER }} --write "**/*.md"

config:check:
desc: Lint and check formatting of configuration files
cmds:
- task: config:check-formatting
- task: config:lint

config:lint:
desc: Lint configuration files
cmds:
- task: workflow:validate

workflow:validate:
desc: Validate GitHub Actions workflows against JSON schema
cmds:
- wget --output-document={{ .WORKFLOW_SCHEMA_PATH }} https://json.schemastore.org/github-workflow
- npx ajv-cli validate -s {{ .WORKFLOW_SCHEMA_PATH }} -d "./.github/workflows/*.{yml,yaml}"
Comment on lines +147 to +151
Copy link
Contributor

@silvanocerza silvanocerza Oct 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this! Maybe we could add it in the the CLI repo too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm certainly in favor. I've been using the JSON schema locally for the last couple months and found it to be pretty useful. I created a Jira task about it (ATL-657).

silvanocerza reacted with thumbs up emoji

config:check-formatting:
desc: Check formatting of configuration files
cmds:
- npx {{ .PRETTIER }} --check "**/*.{yml,yaml}"
- npx {{ .PRETTIER }} --check "**/*.json"

config:format:
desc: Format configuration files
cmds:
- npx {{ .PRETTIER }} --write "**/*.{yml,yaml}"
- npx {{ .PRETTIER }} --write "**/*.json"

check-spelling:
desc: Check for commonly misspelled words
cmds:
- poetry install --no-root
- poetry run codespell {{ .CODESPELL_SKIP_OPTION }} {{ .CODESPELL_IGNORE_WORDS_OPTION }}

correct-spelling:
desc: Correct commonly misspelled words where possible
cmds:
- poetry install --no-root
- poetry run codespell --write-changes {{ .CODESPELL_SKIP_OPTION }} {{ .CODESPELL_IGNORE_WORDS_OPTION }}

vars:
DEFAULT_PACKAGES:
sh: echo `go list ./... | tr '\n' ' '`
DEFAULT_PATHS:
sh: echo '`go list -f '{{"{{"}}.Dir{{"}}"}}' ./...`'
GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic"

GOLINTBIN:
sh: go list -f {{"{{"}}".Target{{"}}"}}" golang.org/x/lint/golint
GOLINTFLAGS: "-min_confidence 0.8 -set_exit_status"

PRETTIER: prettier@2.1.2

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

CODESPELL_SKIP_OPTION: '--skip "./.git,./go.mod,./go.sum,./arduino-check,./arduino-check.exe"'
CODESPELL_IGNORE_WORDS_OPTION: "--ignore-words ./etc/codespell-ignore-words-list.txt"
1 change: 1 addition & 0 deletions etc/codespell-ignore-words-list.txt
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ot
18 changes: 18 additions & 0 deletions poetry.lock
View file Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions pyproject.toml
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[tool.poetry]
name = "arduino-check"
version = "0.0.0"
description = "arduino-check"
authors = ["Arduino <info@arduino.cc>"]

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
codespell = ">=1.17.1"

AltStyle によって変換されたページ (->オリジナル) /