---

# dependencies:

# - ginkgo

# - goi18n

# - golangci-lint

# - goveralls

# - yamllint

version: "3"

silent: true

dotenv: [".env"]

vars:

FORMAT: json

BINARY_NAME: agenor

DEPLOY_DIR: ./locale/deploy

OUT_DIR: ./locale/out

L10N_DIR: ./locale/out/l10n

#

SOURCE_LANG: en-GB

SOURCE_ACTIVE: "active.{{.SOURCE_LANG}}.{{.FORMAT}}"

#

LANGUAGE_US: en-US

US_OUT_DIR: "{{.OUT_DIR}}/{{.LANGUAGE_US}}"

ACTIVE_US: "{{.BINARY_NAME}}.active.en-US.{{.FORMAT}}"

TRANSLATE_US: "{{.BINARY_NAME}}.translate.en-US.{{.FORMAT}}"

TRANSLATE_US_FILEPATH: "{{.US_OUT_DIR}}/{{.TRANSLATE_US}}"

COVER_DIR: "./"

COVER_FILE: "coverage.out"

COVER_HTML_PATH: "./coverage.html"

GINKGO_REPORT: "ginkgo.report"

tasks:

# === build ================================================

b:

cmds:

- go build ./...

# === test =================================================

# to see how to select tests by label, refer to:

# https://onsi.github.io/ginkgo/#spec-labels

#

# equal: --label-filter="foo"

# not: --label-filter="!foo"

# and: --label-filter="!foo && bar"

# or: --label-filter="!foo || bar"

# regex: --label-filter="/pattern/"

dry:

cmds:

- ginkgo -v --dry-run ./...

clean:

cmds:

- go clean

clean-t:

cmds:

- go clean -testcache

lfs:

cmds:

- go test ./lfs

t:

cmds:

- go test ./...

ta:

cmds:

- go test ./tapable

ten:

cmds:

- go test ./internal/enclave

tk:

cmds:

- go test ./internal/kernel

ti:

cmds:

- go test ./i18n

tl:

cmds:

- go test ./locale

tlc:

cmds:

- go test ./life

tcore:

cmds:

- go test ./core

tf:

cmds:

- go test ./internal/filtering

tf-hiber:

cmds:

- go test ./internal/feat/hiber

tf-res:

cmds:

- go test ./internal/feat/resume

tf-samp:

cmds:

- go test ./internal/feat/sampling

toc:

cmds:

- go test ./collections

tpref:

cmds:

- go test ./pref

t-pers:

cmds:

- go test ./internal/persist

ta:

cmds:

- go test

# this needs to be invoked using -- eg:

# task venus -- -filter RETRO-WAVE,DUB

venus:

cmds:

- go run ./test/cmd/venus/main.go {{.CLI_ARGS}}

# quick venus test

venus-t:

cmds:

- go run ./test/cmd/venus/main.go -path . -filter RETRO-WAVE,DUB -pattern "*|flac"

nex:

cmds:

- go run ./examples/nexus/main.go -path RETRO-WAVE -filter RETRO-WAVE,DUB -pattern "*|flac"

nex-c:

cmds:

- go run ./examples/nexus/main.go -path bass/DUB -filter RETRO-WAVE,bass -pattern "*|flac" -now 4 -delay 10

# === ginkgo ================================================

# initialise a test suite for a package. (only 1 per package)

boot:

cmds:

- ginkgo bootstrap

# run tests suites recursive

g:

cmds:

- ginkgo -r

# invoke as task gen -- <item>

gl:

cmds:

- ginkgo -r --label-filter={{.CLI_ARGS}}

# run tests suites recursive with verbose

gv:

cmds:

- ginkgo -r -v

# generate a test file for the item provided (item_test.go)

# invoke as task gen -- <item>

gen:

cmds:

- ginkgo generate {{.CLI_ARGS}}

# === watch ================================================

watchv:

cmds:

- ginkgo watch -v -r -p ./...

watchvc:

cmds:

- ginkgo watch -v -r -p ./collections

watchvi:

cmds:

- ginkgo watch -v -r -p ./i18n

watch:

cmds:

- ginkgo watch -r -p ./...

# === lint =================================================

lint:

cmds:

- golangci-lint run

linty:

cmds:

- yamllint *.y*ml

# === generate =============================================

enums:

cmds:

- go generate ./enums

# === coverage =============================================

cover-clean:

cmds:

- rm -rf ./coverage

cover-publish:

cmds:

- goveralls -repotoken {{.COVERALLS_TOKEN}}

cover-setup:

cmds:

- mkdir -p ./coverage

cover-ginkgo:

cmds:

- ginkgo run -r -json-report {{.GINKGO_REPORT}} -coverpkg=./... -coverprofile={{.COVER_FILE}} --output-dir {{.COVER_DIR}}

cover-show:

cmds:

- open {{.COVER_HTML_PATH}}

cover-exclude:

cmds:

- ./scripts/apply-coverage-exclusions.sh

cover:

cmds:

- task: cover-setup

- task: cover-ginkgo

- task: cover-exclude

- go tool cover -html=./coverage.out -o {{.COVER_HTML_PATH}}

- open {{.COVER_HTML_PATH}}

# === security =============================================

# for verbose mode:

# govulncheck -show verbose ./...

vuln:

cmds:

- govulncheck ./...

# === i18n =================================================

clear:

cmds:

- rm -rf {{.OUT_DIR}}/* --recursive

# extract i18m messages

extract:

cmds:

- mkdir -p ./locale/out/l10n

- goi18n extract

-format json

-sourceLanguage "en-GB"

-outdir ./locale/out/l10n

# new translation

# where is the default? locale/default/li18ngo.active.en-GB.json not populated

# ! creates: locale/out/l10n/active.en-GB.json => extracted output

# ! creates: locale/out/l10n/translate.en-US.json => empty

newt:

deps: [extract]

cmds:

- touch ./locale/out/l10n/translate.en-US.json

# derive a translation from the default

# ! the default active file does not contain hashes, just the extracted content

# ! the foreign translate file contains the hashes

# ! the active foreign file (locale/out/l10n/active.en-US.json) is empty

# ! pass the translate file(locale/out/l10n/translate.en-US.json) to your translator

#

merge:

cmds:

- goi18n merge

-format json

-sourceLanguage "en-GB"

-outdir ./locale/out/l10n

./locale/out/l10n/active.en-GB.json ./locale/out/l10n/translate.en-US.json

# update existing translations

# after running this task, the translation file generated will

# contain only the new translations. Update the active file,

# with the new translations. Also, need to copy the default

# file (active.en-GB.json) back into ./locale/default

update:

deps: [extract]

cmds:

- goi18n merge

-format json

-sourceLanguage "en-GB"

-outdir ./locale/out

./locale/out/active.en-GB.json ./i18n/deploy/active.en-US.json

# run this after manual translation has occurred to integrate it

# back into the translation file. Unfortunately, this task doesn't

# work properly, because it does not include the hashes. Without

# this task, the new translations must be manually added to the active

# translation file (active.en-US.json).

accept:

cmds:

- goi18n merge

-format json

-sourceLanguage "en-US"

-outdir ./i18n/temp

./locale/out/translate.en-US.json ./i18n/deploy/active.en-US.json