clispark 1.20.0 → 1.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clispark",
-  "version": "1.20.0",
+  "version": "1.22.0",
   "description": "Interactive scaffolding tool for new CLI projects",
   "keywords": [
     "cli",

package/templates/dotnet/ARCHITECTURE.md

@@ -94,3 +94,24 @@ There's no separate lint command — analyzer warnings surface as part of a norm
 If you answered "no", this `<PropertyGroup>` isn't present, and `dotnet build` runs with only the SDK's own defaults.
 
 Either way, this choice is permanent and core-managed: `npx clispark update` keeps this block current for a project that opted in, and will never add it to a project that declined. There's no retroactive "turn lint tooling on later" command — rerun `clispark` in a new directory if you want it.
+
+## Shell Completion
+
+`System.CommandLine` 2.0.10's `[suggest]` directive is already part of this project's parsing
+pipeline — no code in `Program.cs` or any command needs to change. To activate it in your shell:
+
+1. Install the registration tool once per machine: `dotnet tool install -g dotnet-suggest`
+2. Install this project as a global tool (see the README's "Building and running" section), then
+   register it once per installation:
+   ```bash
+   dotnet-suggest register --command-path "$(which {{projectName}})"
+   ```
+   (On Windows, use the `.exe` path `dotnet-suggest` prints after `dotnet tool install -g` instead
+   of `which`.)
+3. Add shell integration to your profile once per machine:
+   ```bash
+   dotnet-suggest script bash >> ~/.bashrc   # or: script powershell, script zsh
+   ```
+
+After that, `{{projectName}} <TAB><TAB>` completes command names automatically — the completion
+logic lives entirely in `dotnet-suggest`/`System.CommandLine`, not in this project's own code.

package/templates/dotnet/README.md

@@ -37,6 +37,11 @@ Four example commands ship in `src/Commands/` as copy-paste starting points:
   ```
   See `ARCHITECTURE.md`'s "Argument Types" section for details.
 
+## Shell Completion
+
+Tab-completion works out of the box via `System.CommandLine`'s built-in `[suggest]` support — see
+`ARCHITECTURE.md`'s "Shell Completion" section for the one-time `dotnet-suggest` setup.
+
 ## Logging & debugging
 
 Every command run writes a structured log file (one per invocation, in an OS-appropriate log directory — see `ARCHITECTURE.md`'s "Logging" section). By default the terminal only shows a clean `Error: <message>` on failure, or nothing on success.

package/templates/node/ARCHITECTURE.md

@@ -112,3 +112,25 @@ npm run format  # prettier --write .
 If you answered "no", none of this is present — no config files, no `lint`/`format` scripts, no eslint/prettier devDependencies.
 
 Either way, this choice is permanent and core-managed: `npx clispark update` keeps the lint config and its devDependency versions current for a project that opted in, and will never add any of it to a project that declined. There's no retroactive "turn lint tooling on later" command — rerun `clispark` in a new directory if you want it.
+
+## Shell Autocompletion
+
+If you answered "yes" to "Set up shell autocompletion?" during scaffolding, this project includes
+[`@oclif/plugin-autocomplete`](https://github.com/oclif/plugin-autocomplete) as a runtime
+dependency, registered in `package.json`'s `oclif.plugins` array. Set it up once per shell:
+
+```bash
+<cli> autocomplete bash   # or zsh, powershell
+```
+
+This prints the exact command to append to your shell config (e.g. `~/.bashrc`) and source it.
+After that, `<cli> <TAB><TAB>` completes command names, and `<cli> <command> --<TAB><TAB>`
+completes flag names.
+
+If you answered "no", none of this is present — no `@oclif/plugin-autocomplete` dependency, no
+entry in `oclif.plugins`, and the `autocomplete` command itself doesn't exist.
+
+Either way, this choice is permanent and core-managed: `npx clispark update` keeps the plugin
+dependency version current for a project that opted in, and will never add it to a project that
+declined. There's no retroactive "turn autocompletion on later" command — rerun `clispark` in a
+new directory if you want it.

package/templates/node/README.md

@@ -24,6 +24,12 @@ Two example commands ship in `src/commands/` as copy-paste starting points:
   ```
   See `ARCHITECTURE.md`'s "Argument Types" section for the full set of argument types oclif supports, including a couple this example doesn't use.
 
+## Shell Autocompletion
+
+If you set up autocompletion during scaffolding, run `node bin/run.ts autocomplete bash` (or
+`zsh`/`powershell`) once to see the exact setup command for your shell. See
+`ARCHITECTURE.md`'s "Shell Autocompletion" section for details.
+
 ## Logging & debugging
 
 Every command run writes a structured JSON log file (one per invocation, in an OS-appropriate log directory — see `ARCHITECTURE.md`'s "Logging" section). By default the terminal only shows a clean `Error: <message>` on failure, or nothing on success.

package/templates/node/package.json

@@ -19,7 +19,8 @@
     "commands": "./dist/commands",
     "topicSeparator": " ",
     "plugins": [
-      "@oclif/plugin-help"
+      "@oclif/plugin-help",
+      "@oclif/plugin-autocomplete"
     ]
   },
   "scripts": {
@@ -33,6 +34,7 @@
   },
   "dependencies": {
     "@oclif/core": "^4.0.0",
+    "@oclif/plugin-autocomplete": "^3.2.53",
     "@oclif/plugin-help": "^6.0.0",
     "env-paths": "^3.0.0",
     "pino": "^9.6.0"

package/templates/powershell/ARCHITECTURE.md

@@ -24,3 +24,11 @@ exactly. Cmdlet authors never write their own try/catch or logging calls.
 ## Logging
 
 [PSFramework](https://psframework.org/) — see `Logging/Initialize-Logging.ps1`.
+
+## Shell Completion
+
+Cmdlet-name completion (`Get-H<TAB>` → `Get-Hello`) and parameter-value completion for any
+`[ValidateSet(...)]`-constrained parameter are native PowerShell shell features for every
+imported module — nothing in this project enables them, and nothing could disable them. As soon
+as `Import-Module ./Module.psd1` has run in a session, both kinds of completion work immediately
+for every `Public/` cmdlet.

package/templates/powershell/Public/Complete-Task.ps1

@@ -0,0 +1,10 @@
+function Complete-Task {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory, Position = 0)]
+        [int]$Id
+    )
+    process {
+        Write-Output "Completed task $Id"
+    }
+}

package/templates/powershell/Public/Get-Task.ps1

@@ -0,0 +1,17 @@
+function Get-Task {
+    [CmdletBinding()]
+    param(
+        [Parameter(Position = 0)]
+        [string]$Filter,
+
+        [switch]$Done
+    )
+    process {
+        $base = if ($Filter) { "Listing tasks matching `"$Filter`"" } else { 'Listing all tasks' }
+        if ($Done) {
+            Write-Output "$base (completed only: true)"
+        } else {
+            Write-Output $base
+        }
+    }
+}

package/templates/powershell/Public/New-Task.ps1

@@ -0,0 +1,17 @@
+function New-Task {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory, Position = 0)]
+        [string]$Title,
+
+        [ValidateSet('Low', 'Medium', 'High')]
+        [string]$Priority
+    )
+    process {
+        if ($Priority) {
+            Write-Output "Created task: `"$Title`" (priority: $Priority)"
+        } else {
+            Write-Output "Created task: `"$Title`""
+        }
+    }
+}

package/templates/powershell/README.md

@@ -9,6 +9,13 @@ Import-Module ./Module.psd1
 Get-Hello -Name 'World'
 ```
 
+## Shell Completion
+
+Tab-completion works automatically once the module is imported — no setup needed. If you don't
+want to run `Import-Module ./Module.psd1` in every new session, add that line to your PowerShell
+`$PROFILE` (run `$PROFILE` to see its path; `New-Item -Path $PROFILE -ItemType File -Force` first
+if it doesn't exist yet).
+
 ## Adding a new cmdlet
 
 Run `clispark add` from this directory, or drop a new `.ps1` file into `Public/` following the

package/templates/powershell/tests/Complete-Task.Tests.ps1

@@ -0,0 +1,5 @@
+Describe 'Complete-Task' {
+    It 'marks a task as complete' {
+        Complete-Task -Id 1 | Should -Be 'Completed task 1'
+    }
+}

package/templates/powershell/tests/Get-Task.Tests.ps1

@@ -0,0 +1,13 @@
+Describe 'Get-Task' {
+    It 'lists all tasks by default' {
+        Get-Task | Should -Be 'Listing all tasks'
+    }
+
+    It 'lists tasks matching a filter' {
+        Get-Task -Filter 'groceries' | Should -Be 'Listing tasks matching "groceries"'
+    }
+
+    It 'lists tasks matching a filter, showing only completed ones' {
+        Get-Task -Filter 'groceries' -Done | Should -Be 'Listing tasks matching "groceries" (completed only: true)'
+    }
+}

package/templates/powershell/tests/New-Task.Tests.ps1

@@ -0,0 +1,9 @@
+Describe 'New-Task' {
+    It 'creates a task with just a title' {
+        New-Task -Title 'Buy milk' | Should -Be 'Created task: "Buy milk"'
+    }
+
+    It 'creates a task with an optional priority' {
+        New-Task -Title 'Buy milk' -Priority 'High' | Should -Be 'Created task: "Buy milk" (priority: High)'
+    }
+}