feat: a few fixes and improvements on task --init

* Fixed check for an existing Taskfile: look for all possibilities, and
  not only `Taskfile.yml` specifically.
* Changed default extension from `.yml` to `.yaml`.
* Added a description (`desc`) to the `default` task. Important to at
  lest `task --list` work by default (a core feature).
* Added `yaml-language-server` comment.

Author: andreynering

Taskfile.yml renamed to Taskfile.yaml

@@ -6,11 +6,12 @@ import (
 
 	"github.com/go-task/task/v3/errors"
 	"github.com/go-task/task/v3/internal/filepathext"
+	"github.com/go-task/task/v3/taskfile"
 )
 
-const defaultTaskFilename = "Taskfile.yml"
+const defaultFilename = "Taskfile.yaml"
 
-//go:embed taskfile/templates/default.yml
+//go:embed taskfile/templates/default.yaml
 var DefaultTaskfile string
 
 // InitTaskfile creates a new Taskfile at path.
@@ -20,22 +21,30 @@ var DefaultTaskfile string
 //
 // The final file path is always returned and may be different from the input path.
 func InitTaskfile(path string) (string, error) {
-	fi, err := os.Stat(path)
-	if err == nil && !fi.IsDir() {
+	info, err := os.Stat(path)
+	if err == nil && !info.IsDir() {
 		return path, errors.TaskfileAlreadyExistsError{}
 	}
 
-	if fi != nil && fi.IsDir() {
-		path = filepathext.SmartJoin(path, defaultTaskFilename)
-		// path was a directory, so check if Taskfile.yml exists in it
-		if _, err := os.Stat(path); err == nil {
+	if info != nil && info.IsDir() {
+		// path was a directory, check if there is a Taskfile already
+		if hasDefaultTaskfile(path) {
 			return path, errors.TaskfileAlreadyExistsError{}
 		}
+		path = filepathext.SmartJoin(path, defaultFilename)
 	}
 
 	if err := os.WriteFile(path, []byte(DefaultTaskfile), 0o644); err != nil {
 		return path, err
 	}
-
 	return path, nil
 }
+
+func hasDefaultTaskfile(dir string) bool {
+	for _, name := range taskfile.DefaultTaskfiles {
+		if _, err := os.Stat(filepathext.SmartJoin(dir, name)); err == nil {
+			return true
+		}
+	}
+	return false
+}

init.go

@@ -12,22 +12,21 @@ func TestInitDir(t *testing.T) {
 	t.Parallel()
 
 	const dir = "testdata/init"
-	file := filepathext.SmartJoin(dir, "Taskfile.yml")
+	file := filepathext.SmartJoin(dir, "Taskfile.yaml")
+
+	defer os.Remove(file)
 
-	_ = os.Remove(file)
 	if _, err := os.Stat(file); err == nil {
-		t.Errorf("Taskfile.yml should not exist")
+		t.Errorf("Taskfile.yaml should not exist")
 	}
 
 	if _, err := task.InitTaskfile(dir); err != nil {
 		t.Error(err)
 	}
 
 	if _, err := os.Stat(file); err != nil {
-		t.Errorf("Taskfile.yml should exist")
+		t.Errorf("Taskfile.yaml should exist")
 	}
-
-	_ = os.Remove(file)
 }
 
 func TestInitFile(t *testing.T) {
@@ -36,7 +35,8 @@ func TestInitFile(t *testing.T) {
 	const dir = "testdata/init"
 	file := filepathext.SmartJoin(dir, "Tasks.yml")
 
-	_ = os.Remove(file)
+	defer os.Remove(file)
+
 	if _, err := os.Stat(file); err == nil {
 		t.Errorf("Tasks.yml should not exist")
 	}
@@ -48,5 +48,4 @@ func TestInitFile(t *testing.T) {
 	if _, err := os.Stat(file); err != nil {
 		t.Errorf("Tasks.yml should exist")
 	}
-	_ = os.Remove(file)
 }

init_test.go

@@ -114,8 +114,8 @@ func TestSearch(t *testing.T) {
 			name:               "find ../../Taskfile.yml using no entrypoint or dir by walking",
 			entrypoint:         "",
 			dir:                "",
-			possibleFilenames:  []string{"Taskfile.yml"},
-			expectedEntrypoint: filepath.Join(wd, "..", "..", "Taskfile.yml"),
+			possibleFilenames:  []string{"Taskfile.yaml"},
+			expectedEntrypoint: filepath.Join(wd, "..", "..", "Taskfile.yaml"),
 		},
 		{
 			name:               "find foo.txt first if listed first in possible filenames",

internal/fsext/fs_test.go

@@ -19,7 +19,7 @@ type FileNode struct {
 
 func NewFileNode(entrypoint, dir string, opts ...NodeOption) (*FileNode, error) {
 	// Find the entrypoint file
-	resolvedEntrypoint, err := fsext.Search(entrypoint, dir, defaultTaskfiles)
+	resolvedEntrypoint, err := fsext.Search(entrypoint, dir, DefaultTaskfiles)
 	if err != nil {
 		return nil, err
 	}

taskfile/node_file.go

@@ -12,7 +12,8 @@ import (
 )
 
 var (
-	defaultTaskfiles = []string{
+	// DefaultTaskfiles is the list of Taskfile file names supported by default.
+	DefaultTaskfiles = []string{
 		"Taskfile.yml",
 		"taskfile.yml",
 		"Taskfile.yaml",
@@ -66,7 +67,7 @@ func RemoteExists(ctx context.Context, u url.URL) (*url.URL, error) {
 
 	// If the request was not successful, append the default Taskfile names to
 	// the URL and return the URL of the first successful request
-	for _, taskfile := range defaultTaskfiles {
+	for _, taskfile := range DefaultTaskfiles {
 		// Fixes a bug with JoinPath where a leading slash is not added to the
 		// path if it is empty
 		if u.Path == "" {

taskfile/taskfile.go

@@ -0,0 +1,15 @@
+# https://taskfile.dev
+#
+# yaml-language-server: $schema=https://taskfile.dev/schema.json
+
+version: '3'
+
+vars:
+  GREETING: Hello, world!
+
+tasks:
+  default:
+    desc: Print a greeting message
+    cmds:
+      - echo "{{.GREETING}}"
+    silent: true

taskfile/templates/default.yaml

@@ -43,6 +43,7 @@ vars:
 
 tasks:
   default:
+    desc: Print a greeting message
     cmds:
       - echo "{{.GREETING}}"
     silent: true
@@ -111,6 +112,7 @@ vars:
 
 tasks:
   default:
+    desc: Print a greeting message
     cmds:
       - echo "{{.GREETING}}"
     silent: true