Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows
Remove double-commenting from project config example (#1836)
Maximilian Roosca5980aee8cd
diff --git a/dev/wt.example.toml b/dev/wt.example.tomlindex 5e431b19c..0023950a5 100644--- a/dev/wt.example.toml+++ b/dev/wt.example.toml@@ -1,22 +1,25 @@# # Project Configuration#-# Create with `wt config create --project`.+# Create with `wt config create --project`. Examples shown — uncomment and customize for your project.## Location: `.config/wt.toml` (checked into version control and shared with the team).## ## Hooks#-# See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:+# See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.+#+# Single command:#-# # Single command# pre-start = "npm ci"#-# # Multiple named commands (concurrent for post-*, sequential for pre-*)+# Multiple named commands (concurrent for post-*, sequential for pre-*):+## [pre-merge]# test = "npm test"# build = "npm run build"#-# # Pipeline — list of maps, run in order (each map concurrent)+# Pipeline — list of maps, run in order (each map concurrent):+## post-start = [# { install = "npm ci" },# { build = "npm run build", server = "npm run dev" }@@ -24,20 +27,23 @@## ## Dev server URL#-# # URL column in wt list (dimmed when port not listening)+# URL column in `wt list` (dimmed when port not listening):+## [list]# url = "http://localhost:{{ branch | hash_port }}"## ## Forge platform override#-# # Override platform detection for SSH aliases or self-hosted instances+# Override platform detection for SSH aliases or self-hosted instances:+## [forge]# platform = "github" # or "gitlab"-# # hostname = "github.example.com" # API host (GHE / self-hosted GitLab)+# hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)## ## Copy-ignored excludes#-# # Add more gitignored excludes for wt step copy-ignored+# Additional excludes for `wt step copy-ignored`:+## [step.copy-ignored]# exclude = [".cache/", ".turbo/"]#diff --git a/docs/content/config.md b/docs/content/config.mdindex a995c7783..e1d1bdd11 100644--- a/docs/content/config.md+++ b/docs/content/config.md@@ -340,24 +340,31 @@ squash-template = """<!-- PROJECT_CONFIG_START --># Project Configuration-Create with `wt config create --project`.+Create with `wt config create --project`. Examples shown — uncomment and customize for your project.Location: `.config/wt.toml` (checked into version control and shared with the team).## Hooks-See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:+See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.++Single command:```toml-# Single commandpre-start = "npm ci"+```++Multiple named commands (concurrent for post-*, sequential for pre-*):-# Multiple named commands (concurrent for post-*, sequential for pre-*)+```toml[pre-merge]test = "npm test"build = "npm run build"+```-# Pipeline — list of maps, run in order (each map concurrent)+Pipeline — list of maps, run in order (each map concurrent):++```tomlpost-start = [{ install = "npm ci" },{ build = "npm run build", server = "npm run dev" }@@ -366,25 +373,28 @@ post-start = [## Dev server URL+URL column in `wt list` (dimmed when port not listening):+```toml-# URL column in wt list (dimmed when port not listening)[list]url = "http://localhost:{{ branch | hash_port }}"```## Forge platform override+Override platform detection for SSH aliases or self-hosted instances:+```toml-# Override platform detection for SSH aliases or self-hosted instances[forge]platform = "github" # or "gitlab"-# hostname = "github.example.com" # API host (GHE / self-hosted GitLab)+hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)```## Copy-ignored excludes+Additional excludes for `wt step copy-ignored`:+```toml-# Add more gitignored excludes for wt step copy-ignored[step.copy-ignored]exclude = [".cache/", ".turbo/"]```diff --git a/skills/worktrunk/reference/config.md b/skills/worktrunk/reference/config.mdindex 9fcbfd1d5..08673dc4d 100644--- a/skills/worktrunk/reference/config.md+++ b/skills/worktrunk/reference/config.md@@ -339,24 +339,31 @@ squash-template = """<!-- PROJECT_CONFIG_START --># Project Configuration-Create with `wt config create --project`.+Create with `wt config create --project`. Examples shown — uncomment and customize for your project.Location: `.config/wt.toml` (checked into version control and shared with the team).## Hooks-See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:+See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.++Single command:```toml-# Single commandpre-start = "npm ci"+```++Multiple named commands (concurrent for post-*, sequential for pre-*):-# Multiple named commands (concurrent for post-*, sequential for pre-*)+```toml[pre-merge]test = "npm test"build = "npm run build"+```-# Pipeline — list of maps, run in order (each map concurrent)+Pipeline — list of maps, run in order (each map concurrent):++```tomlpost-start = [{ install = "npm ci" },{ build = "npm run build", server = "npm run dev" }@@ -365,25 +372,28 @@ post-start = [## Dev server URL+URL column in `wt list` (dimmed when port not listening):+```toml-# URL column in wt list (dimmed when port not listening)[list]url = "http://localhost:{{ branch | hash_port }}"```## Forge platform override+Override platform detection for SSH aliases or self-hosted instances:+```toml-# Override platform detection for SSH aliases or self-hosted instances[forge]platform = "github" # or "gitlab"-# hostname = "github.example.com" # API host (GHE / self-hosted GitLab)+hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)```## Copy-ignored excludes+Additional excludes for `wt step copy-ignored`:+```toml-# Add more gitignored excludes for wt step copy-ignored[step.copy-ignored]exclude = [".cache/", ".turbo/"]```diff --git a/src/cli/mod.rs b/src/cli/mod.rsindex 5f7ec20e5..d50127399 100644--- a/src/cli/mod.rs+++ b/src/cli/mod.rs@@ -1916,24 +1916,31 @@ squash-template = """<!-- PROJECT_CONFIG_START --># Project Configuration-Create with `wt config create --project`.+Create with `wt config create --project`. Examples shown — uncomment and customize for your project.Location: `.config/wt.toml` (checked into version control and shared with the team).## Hooks-See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:+See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.++Single command:```toml-# Single commandpre-start = "npm ci"+```++Multiple named commands (concurrent for post-*, sequential for pre-*):-# Multiple named commands (concurrent for post-*, sequential for pre-*)+```toml[pre-merge]test = "npm test"build = "npm run build"+```-# Pipeline — list of maps, run in order (each map concurrent)+Pipeline — list of maps, run in order (each map concurrent):++```tomlpost-start = [{ install = "npm ci" },{ build = "npm run build", server = "npm run dev" }@@ -1942,25 +1949,28 @@ post-start = [## Dev server URL+URL column in `wt list` (dimmed when port not listening):+```toml-# URL column in wt list (dimmed when port not listening)[list]url = "http://localhost:{{ branch | hash_port }}"```## Forge platform override+Override platform detection for SSH aliases or self-hosted instances:+```toml-# Override platform detection for SSH aliases or self-hosted instances[forge]platform = "github" # or "gitlab"-# hostname = "github.example.com" # API host (GHE / self-hosted GitLab)+hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)```## Copy-ignored excludes+Additional excludes for `wt step copy-ignored`:+```toml-# Add more gitignored excludes for wt step copy-ignored[step.copy-ignored]exclude = [".cache/", ".turbo/"]```diff --git a/tests/snapshots/integration__integration_tests__help__help_config_create.snap b/tests/snapshots/integration__integration_tests__help__help_config_create.snapindex 7da94c3a5..c5cea439d 100644--- a/tests/snapshots/integration__integration_tests__help__help_config_create.snap+++ b/tests/snapshots/integration__integration_tests__help__help_config_create.snap@@ -304,23 +304,26 @@ With [2m--project[0m, creates [2m.config/wt.toml[0m in the current repositor[107m [0m [2m# # Project Configuration[0m[107m [0m [2m#[0m-[107m [0m [2m# Create with `wt config create --project`.[0m+[107m [0m [2m# Create with `wt config create --project`. Examples shown — uncomment and customize for your project.[0m[107m [0m [2m#[0m[107m [0m [2m# Location: `.config/wt.toml` (checked into version control and shared with the team).[0m[107m [0m [2m#[0m[107m [0m [2m# ## Hooks[0m[107m [0m [2m#[0m-[107m [0m [2m# See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:[0m+[107m [0m [2m# See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.[0m+[107m [0m [2m#[0m+[107m [0m [2m# Single command:[0m[107m [0m [2m#[0m-[107m [0m [2m# # Single command[0m[107m [0m [2m# pre-start = "npm ci"[0m[107m [0m [2m#[0m-[107m [0m [2m# # Multiple named commands (concurrent for post-*, sequential for pre-*)[0m+[107m [0m [2m# Multiple named commands (concurrent for post-*, sequential for pre-*):[0m+[107m [0m [2m#[0m[107m [0m [2m# [pre-merge][0m[107m [0m [2m# test = "npm test"[0m[107m [0m [2m# build = "npm run build"[0m[107m [0m [2m#[0m-[107m [0m [2m# # Pipeline — list of maps, run in order (each map concurrent)[0m+[107m [0m [2m# Pipeline — list of maps, run in order (each map concurrent):[0m+[107m [0m [2m#[0m[107m [0m [2m# post-start = [[0m[107m [0m [2m# { install = "npm ci" },[0m[107m [0m [2m# { build = "npm run build", server = "npm run dev" }[0m@@ -328,20 +331,23 @@ With [2m--project[0m, creates [2m.config/wt.toml[0m in the current repositor[107m [0m [2m#[0m[107m [0m [2m# ## Dev server URL[0m[107m [0m [2m#[0m-[107m [0m [2m# # URL column in wt list (dimmed when port not listening)[0m+[107m [0m [2m# URL column in `wt list` (dimmed when port not listening):[0m+[107m [0m [2m#[0m[107m [0m [2m# [list][0m[107m [0m [2m# url = "http://localhost:{{ branch | hash_port }}"[0m[107m [0m [2m#[0m[107m [0m [2m# ## Forge platform override[0m[107m [0m [2m#[0m-[107m [0m [2m# # Override platform detection for SSH aliases or self-hosted instances[0m+[107m [0m [2m# Override platform detection for SSH aliases or self-hosted instances:[0m+[107m [0m [2m#[0m[107m [0m [2m# [forge][0m[107m [0m [2m# platform = "github" # or "gitlab"[0m-[107m [0m [2m# # hostname = "github.example.com" # API host (GHE / self-hosted GitLab)[0m+[107m [0m [2m# hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)[0m[107m [0m [2m#[0m[107m [0m [2m# ## Copy-ignored excludes[0m[107m [0m [2m#[0m-[107m [0m [2m# # Add more gitignored excludes for wt step copy-ignored[0m+[107m [0m [2m# Additional excludes for `wt step copy-ignored`:[0m+[107m [0m [2m#[0m[107m [0m [2m# [step.copy-ignored][0m[107m [0m [2m# exclude = [".cache/", ".turbo/"][0m[107m [0m [2m#[0mdiff --git a/tests/snapshots/integration__integration_tests__help__help_config_long.snap b/tests/snapshots/integration__integration_tests__help__help_config_long.snapindex 39adf47b0..9b6d46ba7 100644--- a/tests/snapshots/integration__integration_tests__help__help_config_long.snap+++ b/tests/snapshots/integration__integration_tests__help__help_config_long.snap@@ -341,23 +341,26 @@ Default template:[107m [0m [2m[32m"[0m[2m[32m""[0m[32mPROJECT CONFIGURATION[0m-Create with [2mwt config create --project[0m.+Create with [2mwt config create --project[0m. Examples shown — uncomment and customize for your project.Location: [2m.config/wt.toml[0m (checked into version control and shared with the team).[1m[32mHooks[0m-See [2mwt hook --help[0m for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:+See [2mwt hook --help[0m for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.++Single command:-[107m [0m [2m# Single command[0m[107m [0m [2mpre-start = [0m[2m[32m"npm ci"[0m-[107m [0m-[107m [0m [2m# Multiple named commands (concurrent for post-*, sequential for pre-*)[0m++Multiple named commands (concurrent for post-*, sequential for pre-*):+[107m [0m [2m[36m[pre-merge][0m[107m [0m [2mtest = [0m[2m[32m"npm test"[0m[107m [0m [2mbuild = [0m[2m[32m"npm run build"[0m-[107m [0m-[107m [0m [2m# Pipeline — list of maps, run in order (each map concurrent)[0m++Pipeline — list of maps, run in order (each map concurrent):+[107m [0m [2mpost-start = [[0m[107m [0m [2m { install = [0m[2m[32m"npm ci"[0m[2m },[0m[107m [0m [2m { build = [0m[2m[32m"npm run build"[0m[2m, server = [0m[2m[32m"npm run dev"[0m[2m }[0m@@ -365,20 +368,23 @@ See [2mwt hook --help[0m for hook types, execution order, template variables,[1m[32mDev server URL[0m-[107m [0m [2m# URL column in wt list (dimmed when port not listening)[0m+URL column in [2mwt list[0m (dimmed when port not listening):+[107m [0m [2m[36m[list][0m[107m [0m [2murl = [0m[2m[32m"http://localhost:{{ branch | hash_port }}"[0m[1m[32mForge platform override[0m-[107m [0m [2m# Override platform detection for SSH aliases or self-hosted instances[0m+Override platform detection for SSH aliases or self-hosted instances:+[107m [0m [2m[36m[forge][0m[107m [0m [2mplatform = [0m[2m[32m"github"[0m[2m [0m[2m# or "gitlab"[0m-[107m [0m [2m# hostname = "github.example.com" # API host (GHE / self-hosted GitLab)[0m+[107m [0m [2mhostname = [0m[2m[32m"github.example.com"[0m[2m [0m[2m# Example: API host (GHE / self-hosted GitLab)[0m[1m[32mCopy-ignored excludes[0m-[107m [0m [2m# Add more gitignored excludes for wt step copy-ignored[0m+Additional excludes for [2mwt step copy-ignored[0m:+[107m [0m [2m[36m[step.copy-ignored][0m[107m [0m [2mexclude = [[0m[2m[32m".cache/"[0m[2m, [0m[2m[32m".turbo/"[0m[2m][0m