dugajean/goke

Go + Make = Goke

goke's Issues

Local (per task) environment variables

Task declarations should accept an env key as well, that essentially allows the user to set up environment variables for a specific task. This variable would override any global ones for this specific task.

Env variables not parsing

When using an env var from global.env and {task}.env in task, they should be substituted with the respective value. Currently it results in an empty string.

For example:

greet-cats:
  run:
    - 'echo "Hello ${CAT}"'
  env:
    CAT: "Kitty"

Outputs Hello . Same goes for this:

global:
  env:
    CAT: "Kitty"

greet-cats:
  run:
    - 'echo "Hello ${CAT}"'

Expected behaviour:

The output should be Hello Kitty.

Implement --init flag

The --init flag would create a goke.yml file if it doesn't exist (in the current dir), with a few sample tasks in it.

Refactor Parser for unit tests

Refactor parser.go, change Parser struct to interface and create mocks using mockery for better unit tests.

Refactor unit tests and add rest of the tests.

Cache bust parser cache based on its mtime

Check out fsnotify

Currently, the watcher is an infinite loop with a 1 second sleep. It works efficiently, but it could be a performance bottleneck. Check out this repo and see if/how we can adopt it:

https://github.com/fsnotify/fsnotify

Rename $(files) constant to {FILES}

Currently if you want to reference the files: section within a task, you'd use $(files). Rename this placeholder with {FILES} instead.

The dollar sign calls are reserved for shell commands.

Accept more file names than just goke.yml for configuration files

Other valid file names could be:

• goke.yaml
• goke.dist.yml

Longer file names would be prioritized when loading them file name.

Running without options causes panic

panic: runtime error: index out of range [1] with length 1

goroutine 1 [running]: main.parseTaskName(...) github.com/dugajean/goke/cmd/cli/main.go:32 main.main() github.com/dugajean/goke/cmd/cli/main.go:25 +0x472

Release Goke as a Chocolatey package

Goke isn't currently very Windows friendly, even though we create a Windows binary. The aim of this issue is to improve the experience of Goke for Windows users.

To do so, this issue suggests the following:

• Update our GitHub actions so that Goke is deployed to Chocolatey on release
• Bring back Windows into the push_pull.yml GitHub Action.
• Ensure CI passes for Windows

Release Goke for linux package managers

Release Goke to .deb, .rpm and .apk package managers.

References -
https://goreleaser.com/customization/nfpm/
https://goreleaser.com/customization/snapcraft/
https://fury.io

Additional unit tests

Write more unit tests for the Executor struct, Parser and Lockfile. Mocks for common file operations are already present under internal/tests/stdlib_wrapper_mock.go.

global section in goke.yml should not be listed under goke -t

goke -t returns a list of all available tasks. But it shouldn't list global.

The global occurrence should be stripped at the parser level, not at the -t flag level.

Implement --quiet flag

This flag essentially disables all output.

Create regex instance outside of functions

This particular line here: https://github.com/dugajean/goke/blob/dev/internal/parser.go#L114

Has two instances within the same file. it would be better if this variable was stored in the global scope of the package, so that I can be used by functions that need it.

Pass args after double dash (--) to each command within the task

Sample command:

greet-cats:
  run:
    - 'echo "Hello Frey"'
    - 'echo "Hello Bunny"'

If the command is called as follows

goke greet-cats --force -- foo -bar

The last part (foo -bar), should be passed down to the two echoes within the task, like so

echo "Hello Frey" foo -bar
echo "Hello Bunny" foo -bar

Currently the user is unable to pass arguments down to the commands. This would be useful for single commands that may need variable information passed to them.