Feat/init template improvements (#12)

* feat(init): improve generated scaffold ergonomics

* fix(task): use bumped version for release commits

* chore: release v1.2.0

Author: YNDmitry

README.md

@@ -40,6 +40,8 @@ wfkit init --name my-site
 ```
 
 Add `--init-git` if you want the scaffold to initialize a local repository immediately.
+Add `--skip-install` if you only want the files and do not want to install dependencies yet.
+Use `--force` if you explicitly want to write scaffold files into an existing non-empty directory.
 
 This creates a new folder in your current directory:
 
@@ -49,6 +51,7 @@ my-site/
 
 Inside it, `wfkit` generates:
 
+- `README.md`
 - `package.json`
 - `wfkit.json`
 - `vite.config.js`
@@ -85,6 +88,8 @@ The generated project is organized for Webflow:
 
 ```text
 src/
+  features/
+    site-status.ts
   global/
     index.ts
     modules/
@@ -94,6 +99,7 @@ src/
       index.ts
   utils/
     dom.ts
+    webflow.ts
 build/
   webflow-vite-plugin.js
 docs/
@@ -105,9 +111,11 @@ dist/assets/
 How it works:
 
 - `src/global/index.ts` is the one explicit global entry
+- `src/features/*` is for reusable behaviors that can be mounted from global or page entries
 - `src/global/modules/*` contains reusable global behaviors that you choose to import from the global entry
 - `src/pages/*/index.ts` is for per-page code
-- `src/utils/*` is shared code that can be used from both global and page entries
+- `src/utils/dom.ts` contains low-level DOM helpers
+- `src/utils/webflow.ts` contains DRY mount helpers that align page and feature bootstrapping with the Webflow runtime
 - `docs/index.md` is the default markdown entry for the docs hub page
 - `dist/assets/wfkit-manifest.json` is generated during build and used by `wfkit` to resolve the correct output files
 
@@ -157,7 +165,7 @@ bun install
 Then:
 
 ```bash
-bun run start
+bun run dev
 ```
 
 This starts:
@@ -310,14 +318,17 @@ This checks:
 
 Create a new project scaffold.
 
+The scaffold is TypeScript-first and installs dependencies by default unless you pass `--skip-install`.
+
 Options:
 
 - `--name` Project name
 - `--pages-dir` Directory for page scripts
 - `--global-entry` Global entry file
 - `--global-var` Global variable name
 - `--init-git` Initialize a local git repository
-- `--types` Generate TypeScript types
+- `--skip-install` Skip dependency installation after generating the scaffold
+- `--force` Allow writing scaffold files into an existing non-empty directory
 - `--package-manager` Package manager: `bun`, `npm`, `yarn`, `pnpm`
 
 ### `wfkit proxy`

Taskfile.yml

@@ -87,9 +87,6 @@ tasks:
 
   release:prepare:
     desc: "Bump the release version and create a release commit. Usage: task release:prepare TYPE=patch"
-    vars:
-      RELEASE_VERSION:
-        sh: node -p "require('./npm/package.json').version"
     preconditions:
       - sh: test -n "{{.TYPE}}"
         msg: "TYPE is required. Use patch, minor, major, or an exact semver version."
@@ -99,7 +96,7 @@ tasks:
       - task: version:bump
         vars: { TYPE: "{{.TYPE}}" }
       - git add npm/package.json
-      - 'git commit -m "chore: release v{{.RELEASE_VERSION}}"'
+      - 'node -e "const { execFileSync } = require(''node:child_process''); const version = require(''./npm/package.json'').version; execFileSync(''git'', [''commit'', ''-m'', ''chore: release v'' + version], { stdio: ''inherit'' });"'
 
   release:patch:
     desc: "Verify, bump the patch version, and create a release commit"

cmd/wfkit/main.go

@@ -10,6 +10,7 @@ import (
 	"os"
 	"os/exec"
 	"os/signal"
+	"path/filepath"
 	"runtime"
 	"strings"
 	"syscall"
@@ -164,8 +165,9 @@ func interactiveMode(c *cli.Context) error {
 func initMode(c *cli.Context) error {
 	name := c.String("name")
 	packageManager := c.String("package-manager")
-	types := c.Bool("types")
 	initGit := c.Bool("init-git")
+	skipInstall := c.Bool("skip-install")
+	force := c.Bool("force")
 
 	// Попытка загрузить глобальный конфиг для подстановки значений по умолчанию
 	importConfig, _ := globalconfig.LoadConfig()
@@ -182,6 +184,7 @@ func initMode(c *cli.Context) error {
 
 	// If the user didn't provide specific flags (or just ran 'wfkit init'), ask them interactively
 	if c.NumFlags() == 0 {
+		installDependencies := true
 		err := huh.NewForm(
 			huh.NewGroup(
 				huh.NewInput().
@@ -205,8 +208,9 @@ func initMode(c *cli.Context) error {
 					).
 					Value(&packageManager),
 				huh.NewConfirm().
-					Title("Use TypeScript?").
-					Value(&types),
+					Title("Install dependencies now?").
+					Description("Installs the generated project's local CLI and frontend tooling immediately.").
+					Value(&installDependencies),
 				huh.NewConfirm().
 					Title("Initialize git repository?").
 					Description("Runs `git init` in the new project directory.").
@@ -217,10 +221,12 @@ func initMode(c *cli.Context) error {
 		if err != nil {
 			return err
 		}
+
+		skipInstall = !installDependencies
 	}
 
 	if repositoryName == "" {
-		repositoryName = name
+		repositoryName = filepath.Base(filepath.Clean(name))
 	}
 
 	// Сохраняем введенные данные в глобальный конфиг, чтобы использовать их в следующий раз
@@ -248,13 +254,16 @@ func initMode(c *cli.Context) error {
 	}
 
 	opts := initconfig.Options{
-		Name:           name,
+		ProjectDir:     name,
+		Name:           filepath.Base(filepath.Clean(name)),
 		PagesDir:       pagesDir,
 		GlobalEntry:    globalEntry,
 		GlobalVar:      globalVar,
-		Types:          types,
 		InitGit:        initGit,
+		Force:          force,
+		SkipInstall:    skipInstall,
 		PackageManager: packageManager,
+		CLIValue:       c.App.Version,
 		GitHubUser:     githubUser,
 		RepositoryName: repositoryName,
 	}
@@ -263,21 +272,49 @@ func initMode(c *cli.Context) error {
 		return fmt.Errorf("initialization failed: %w", err)
 	}
 
+	nextSteps := []string{fmt.Sprintf("cd %s", name)}
+	if skipInstall {
+		nextSteps = append(nextSteps, packageManagerInstallCommand(packageManager))
+	}
+	nextSteps = append(nextSteps, packageManagerScriptCommand(packageManager, "dev"), "wfkit doctor")
+
 	utils.PrintSuccessScreen(
 		"Project initialized",
 		"Your Webflow project scaffold is ready.",
 		[]utils.SummaryMetric{
-			{Label: "Project", Value: name, Tone: "success"},
+			{Label: "Project", Value: opts.Name, Tone: "success"},
 			{Label: "Package manager", Value: packageManager, Tone: "info"},
-			{Label: "TypeScript", Value: map[bool]string{true: "on", false: "off"}[types], Tone: "info"},
+			{Label: "Dependencies", Value: map[bool]string{true: "skipped", false: "installed"}[skipInstall], Tone: "info"},
 		},
-		fmt.Sprintf("cd %s", name),
-		fmt.Sprintf("%s run start", packageManager),
-		"wfkit doctor",
+		nextSteps...,
 	)
 	return nil
 }
 
+func packageManagerScriptCommand(packageManager, script string) string {
+	switch packageManager {
+	case "bun":
+		return fmt.Sprintf("bun run %s", script)
+	case "yarn", "pnpm":
+		return fmt.Sprintf("%s %s", packageManager, script)
+	default:
+		return fmt.Sprintf("npm run %s", script)
+	}
+}
+
+func packageManagerInstallCommand(packageManager string) string {
+	switch packageManager {
+	case "bun":
+		return "bun install"
+	case "yarn":
+		return "yarn"
+	case "pnpm":
+		return "pnpm install"
+	default:
+		return "npm install"
+	}
+}
+
 // updateMode checks for and processes updates
 func updateMode(c *cli.Context) error {
 	updateManager := updater.NewUpdateManager(c.App.Version)
@@ -1033,8 +1070,9 @@ func main() {
 					&cli.StringFlag{Name: "pages-dir", Value: "src/pages", Usage: "Directory for pages"},
 					&cli.StringFlag{Name: "global-entry", Value: "src/global/index.ts", Usage: "Global entry file"},
 					&cli.StringFlag{Name: "global-var", Value: "WF", Usage: "Global variable name"},
-					&cli.BoolFlag{Name: "types", Value: true, Usage: "Generate TypeScript types"},
 					&cli.BoolFlag{Name: "init-git", Usage: "Initialize a local git repository inside the project"},
+					&cli.BoolFlag{Name: "skip-install", Usage: "Skip dependency installation after generating the scaffold"},
+					&cli.BoolFlag{Name: "force", Usage: "Allow writing scaffold files into an existing non-empty directory"},
 					&cli.StringFlag{Name: "package-manager", Value: "bun", Usage: "Package manager (npm, yarn, pnpm, bun)"},
 				},
 				Action: initMode,

internal/initialize/config/opts.go

@@ -1,13 +1,18 @@
 // internal/initialize/config/opts.go
 package config
 
+import "path/filepath"
+
 type Options struct {
+	ProjectDir     string
 	PagesDir       string `default:"src/pages"`
 	GlobalEntry    string `default:"src/global/index.ts"`
 	GlobalVar      string `default:"WF"`
-	Types          bool
 	InitGit        bool
+	Force          bool
+	SkipInstall    bool
 	PackageManager string `default:"bun"`
+	CLIValue       string
 	Name           string
 	GitHubUser     string
 	RepositoryName string
@@ -17,6 +22,12 @@ type Options struct {
 
 // Метод для установки значений по умолчанию
 func (o *Options) SetDefaultValues() {
+	if o.ProjectDir == "" {
+		o.ProjectDir = o.Name
+	}
+	if o.Name == "" && o.ProjectDir != "" {
+		o.Name = filepath.Base(filepath.Clean(o.ProjectDir))
+	}
 	if o.PagesDir == "" {
 		o.PagesDir = "src/pages"
 	}

internal/initialize/init.go

@@ -19,7 +19,7 @@ func initProject(opts config.Options, installDependencies func(string) error, in
 	// Установка значений по умолчанию
 	opts.SetDefaultValues()
 
-	restoreDir, err := prepareProjectDir(opts.Name)
+	restoreDir, err := prepareProjectDir(opts.ProjectDir, opts.Force)
 	if err != nil {
 		return err
 	}
@@ -44,6 +44,11 @@ func initProject(opts config.Options, installDependencies func(string) error, in
 		return err
 	}
 
+	// Создание README проекта
+	if err := steps.CreateProjectReadme(opts); err != nil {
+		return err
+	}
+
 	// Создание .gitignore
 	if err := steps.CreateGitignore(); err != nil {
 		return err
@@ -70,8 +75,10 @@ func initProject(opts config.Options, installDependencies func(string) error, in
 	}
 
 	// Установка зависимостей
-	if err := installDependencies(opts.PackageManager); err != nil {
-		return err
+	if !opts.SkipInstall {
+		if err := installDependencies(opts.PackageManager); err != nil {
+			return err
+		}
 	}
 
 	if opts.InitGit {
@@ -84,7 +91,7 @@ func initProject(opts config.Options, installDependencies func(string) error, in
 	return nil
 }
 
-func prepareProjectDir(name string) (func() error, error) {
+func prepareProjectDir(name string, force bool) (func() error, error) {
 	projectDir := filepath.Clean(name)
 	if projectDir == "" || projectDir == "." {
 		return nil, fmt.Errorf("project name must not be empty")
@@ -95,6 +102,26 @@ func prepareProjectDir(name string) (func() error, error) {
 		return nil, fmt.Errorf("failed to get current directory: %w", err)
 	}
 
+	info, err := os.Stat(projectDir)
+	switch {
+	case err == nil && !info.IsDir():
+		return nil, fmt.Errorf("project path %s already exists and is not a directory", projectDir)
+	case err == nil:
+		entries, readErr := os.ReadDir(projectDir)
+		if readErr != nil {
+			return nil, fmt.Errorf("failed to inspect project directory %s: %w", projectDir, readErr)
+		}
+		if len(entries) > 0 && !force {
+			return nil, fmt.Errorf("project directory %s is not empty; rerun with --force to overwrite scaffold files", projectDir)
+		}
+	case os.IsNotExist(err):
+		if err := os.MkdirAll(projectDir, 0755); err != nil {
+			return nil, fmt.Errorf("failed to create project directory %s: %w", projectDir, err)
+		}
+	default:
+		return nil, fmt.Errorf("failed to inspect project directory %s: %w", projectDir, err)
+	}
+
 	if err := os.MkdirAll(projectDir, 0755); err != nil {
 		return nil, fmt.Errorf("failed to create project directory %s: %w", projectDir, err)
 	}