Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: make Taskfile initialization less verbose by default #2011

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.

Sign up for GitHub

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
pd93 merged 6 commits into from
Jan 29, 2025
Merged

feat: make Taskfile initialization less verbose by default #2011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
83d9086
change what is printed when creating Taskfile
HeCorr Jan 22, 2025
47dcf53
include additional new line with -i -v
HeCorr Jan 22, 2025
88e6977
print init success text in green
HeCorr Jan 26, 2025
e9b0aca
fix TestInit, create and pass in a logger
HeCorr Jan 26, 2025
2707f18
move logging outside of InitTaskfile
HeCorr Jan 29, 2025
53ab1e8
move TestInit into init_test.go file
HeCorr Jan 29, 2025
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
15 changes: 12 additions & 3 deletions cmd/task/task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func main() {
}

func run() error {
logger := &logger.Logger{
log := &logger.Logger{
Stdout: os.Stdout,
Stderr: os.Stderr,
Verbose: flags.Verbose,
Expand All @@ -69,17 +69,26 @@ func run() error {
}

if flags.Experiments {
return experiments.List(logger)
return experiments.List(log)
}

if flags.Init {
wd, err := os.Getwd()
if err != nil {
return err
}

if err := task.InitTaskfile(os.Stdout, wd); err != nil {
return err
}

if !flags.Silent {
if flags.Verbose {
log.Outf(logger.Default, "%s\n", task.DefaultTaskfile)
}
log.Outf(logger.Green, "%s created in the current directory\n", task.DefaultTaskFilename)
}

return nil
}

Expand Down Expand Up @@ -146,7 +155,7 @@ func run() error {
return err
}
if experiments.AnyVariables.Enabled {
logger.Warnf("The 'Any Variables' experiment flag is no longer required to use non-map variable types. If you wish to use map variables, please use 'TASK_X_MAP_VARIABLES' instead. See https://github.com/go-task/task/issues/1585\n")
log.Warnf("The 'Any Variables' experiment flag is no longer required to use non-map variable types. If you wish to use map variables, please use 'TASK_X_MAP_VARIABLES' instead. See https://github.com/go-task/task/issues/1585\n")
}

// If the download flag is specified, we should stop execution as soon as
Expand Down
13 changes: 6 additions & 7 deletions init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
package task

import (
"fmt"
"io"
"os"

"github.com/go-task/task/v3/errors"
"github.com/go-task/task/v3/internal/filepathext"
)

const defaultTaskfile = `# https://taskfile.dev
const DefaultTaskfile = `# https://taskfile.dev

version: '3'

Expand All @@ -23,19 +22,19 @@ tasks:
silent: true
`

const defaultTaskfileName = "Taskfile.yml"
const DefaultTaskFilename = "Taskfile.yml"

// InitTaskfile Taskfile creates a new Taskfile
// InitTaskfile creates a new Taskfile
func InitTaskfile(w io.Writer, dir string) error {
f := filepathext.SmartJoin(dir, defaultTaskfileName)
f := filepathext.SmartJoin(dir, DefaultTaskFilename)

if _, err := os.Stat(f); err == nil {
return errors.TaskfileAlreadyExistsError{}
}

if err := os.WriteFile(f, []byte(defaultTaskfile), 0o644); err != nil {
if err := os.WriteFile(f, []byte(DefaultTaskfile), 0o644); err != nil {
return err
}
fmt.Fprintf(w, "%s created in the current directory\n", defaultTaskfile)

return nil
}
31 changes: 31 additions & 0 deletions init_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package task_test

import (
"io"
"os"
"testing"

"github.com/go-task/task/v3"
"github.com/go-task/task/v3/internal/filepathext"
)

func TestInit(t *testing.T) {
t.Parallel()

const dir = "testdata/init"
file := filepathext.SmartJoin(dir, "Taskfile.yml")

_ = os.Remove(file)
if _, err := os.Stat(file); err == nil {
t.Errorf("Taskfile.yml should not exist")
}

if err := task.InitTaskfile(io.Discard, dir); err != nil {
t.Error(err)
}

if _, err := os.Stat(file); err != nil {
t.Errorf("Taskfile.yml should exist")
}
_ = os.Remove(file)
}
21 changes: 0 additions & 21 deletions task_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1011,27 +1011,6 @@ func TestCmdsVariables(t *testing.T) {
assert.Contains(t, buff.String(), tf)
}

func TestInit(t *testing.T) {
t.Parallel()

const dir = "testdata/init"
file := filepathext.SmartJoin(dir, "Taskfile.yml")

_ = os.Remove(file)
if _, err := os.Stat(file); err == nil {
t.Errorf("Taskfile.yml should not exist")
}

if err := task.InitTaskfile(io.Discard, dir); err != nil {
t.Error(err)
}

if _, err := os.Stat(file); err != nil {
t.Errorf("Taskfile.yml should exist")
}
_ = os.Remove(file)
}

func TestCyclicDep(t *testing.T) {
t.Parallel()

Expand Down
Loading