feat: add examples directory with five self-contained example projects by Copilot · Pull Request #1 · tasteee/dooz

Copilot · 2026-05-15T06:41:25Z

Summary

Adds an examples/ directory containing five standalone dooz project examples. Each one demonstrates a distinct set of features from the README so users can see exactly how each capability is used in practice.

Examples

`simple-scripts`

The floor-level setup: a single dooz.yaml, no extension file. Covers literal patterns and variadic passthrough ([...rest]). Good for teams that only need short command aliases.

`monorepo-workspace`

A pnpm monorepo setup with workspace-scoped commands and a packageExists validator. Demonstrates:

Specificity ranking — build all beats build <name> for the literal token all
Named captures inserted into pnpm --filter
Validator extension (dooz.js) that rejects unknown package names before any command runs

`docker-deploy`

Docker build / run / push / compose commands under dooz. Demonstrates:

Built-in lower filter to normalise service name casing
Specificity ranking — build <service> <tag> beats build <service> when two tokens follow build
tagIsNotLatest validator that blocks accidental docker push api:latest

`git-workflow`

Uses a .dooz/ subdirectory layout instead of a root-level dooz.yaml, keeping the project root clean. Demonstrates:

.dooz/ config discovery
Custom kebab filter ("Add User Auth" → feature/add-user-auth)
isSemanticVersion validator that enforces MAJOR.MINOR.PATCH on release branches and tags
Specificity ranking — push tags beats push [...rest]

`full-featured`

A comprehensive example that exercises every dooz capability in one place:

Resolvers — packageKind derives kind from name; environmentInfo derives region and cluster from environment
Multiple validators per command — deploy gates on both environmentExists and serviceExists
Custom filters — kebab and truncate alongside built-in lower, upper, join, json
All pattern types — literals, named captures, and variadic remainder
Dry / explain modes documented in each README section

Changes

examples/README.md — index table linking all five examples
examples/simple-scripts/dooz.yaml + README.md
examples/monorepo-workspace/dooz.yaml + dooz.js + README.md
examples/docker-deploy/dooz.yaml + dooz.js + README.md
examples/git-workflow/.dooz/dooz.yaml + .dooz/dooz.js + README.md
examples/full-featured/dooz.yaml + dooz.js + README.md

Agent-Logs-Url: https://github.com/tasteee/dooz/sessions/40b2a2ca-7123-4293-825e-69ad9d7f0580 Co-authored-by: tasteee <94029138+tasteee@users.noreply.github.com>

Copilot

Pull request overview

Adds a new examples/ area with multiple standalone projects intended to demonstrate dooz features end-to-end (config discovery, pattern matching, filters, resolvers, validators, dry/explain).

Changes:

Introduces examples/README.md as an index + common “how to run” instructions.
Adds five example projects (simple-scripts, monorepo-workspace, docker-deploy, git-workflow, full-featured) with their own README.md and dooz configs/extensions.
Demonstrates extension authoring via dooz.js (custom filters/validators/resolvers) alongside config-only examples.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
examples/README.md	Adds a top-level index and shared instructions for running examples.
examples/simple-scripts/README.md	Documents the minimal “single dooz.yaml” example and its commands.
examples/simple-scripts/dooz.yaml	Adds basic command aliases plus variadic passthrough patterns.
examples/monorepo-workspace/README.md	Documents pnpm workspace usage, specificity ranking, and a validator.
examples/monorepo-workspace/dooz.yaml	Adds pnpm workspace command patterns using captures + variadics + validator hooks.
examples/monorepo-workspace/dooz.js	Implements a `packageExists` validator.
examples/docker-deploy/README.md	Documents Docker workflow commands, filters, and validator behavior.
examples/docker-deploy/dooz.yaml	Adds Docker build/run/push/compose patterns and validator usage.
examples/docker-deploy/dooz.js	Implements a `tagIsNotLatest` validator.
examples/git-workflow/README.md	Documents `.dooz/` discovery, a kebab filter, semver validation, and ranking.
examples/git-workflow/.dooz/dooz.yaml	Adds git workflow patterns (branching, commit, push/pull, tags, stash, log).
examples/git-workflow/.dooz/dooz.js	Implements `kebab` filter and `isSemanticVersion` validator.
examples/full-featured/README.md	Documents a comprehensive example covering all major dooz capabilities.
examples/full-featured/dooz.yaml	Adds patterns using resolvers/validators/filters, plus “filter demo” commands.
examples/full-featured/dooz.js	Implements resolvers (`packageKind`, `environmentInfo`), validators, and filters (`kebab`, `truncate`).

+
+The simplest possible dooz setup: a single `dooz.yaml` with no extension file.
+
+Every command is a short alias for a longer `npm` or tool invocation. No resolvers, no validators, no captures — just clean pattern-to-command mappings.


+## Features shown
+
+- **Built-in `lower` filter** — `{{service | lower}}` normalises casing without any extension code.
+- **Specificity ranking** — `build <service> <tag>` wins over `build <service>` when two tokens follow `build`.


+  - description: Run a service container interactively
+    input: run <service> [...rest]
+    output: docker run --rm {{rest}} {{service | lower}}
+
+  - description: Push a versioned image to the registry
+    input: push <service> <tag>
+    output: docker push {{service | lower}}:{{tag}}
+    validates: [tagIsNotLatest]
+
+  - description: View logs for a running container
+    input: logs <service> [...rest]
+    output: docker logs {{service}} {{rest}}
+
+  - description: Stop a named running container
+    input: stop <service>
+    output: docker stop {{service}}
+


+
+  - description: Print deployment metadata for an environment
+    input: info <environment>
+    output: echo "Region{{':'}} {{region}}, Cluster{{':'}} {{cluster}}"


+
+  - description: Print extra args joined with a separator
+    input: flags <name> [...rest]
+    output: echo "{{name}} -> {{rest | join(' | ')}}"


+  - description: Deploy a service to an environment
+    input: deploy <environment> <service>
+    output: ./scripts/deploy.sh {{environment}} {{service | lower}}
+    uses: [environmentInfo]


+- **`environmentInfo` resolver** — reads `environment`, returns `region` and `cluster` for use in the template.
+- **Three validators** — `packageExists`, `environmentExists`, `serviceExists` each have a clear `description` used as the failure message.
+- **`kebab` custom filter** — converts space-separated words to a lowercase hyphenated slug.
+- **`truncate` custom filter** — shortens a value to a max character count and appends `…`; takes a numeric argument: `{{name | truncate(10)}}`.


tasteee · 2026-05-15T06:53:40Z

@copilot please see comments and apply fixes

Agent-Logs-Url: https://github.com/tasteee/dooz/sessions/c15381f0-9c8e-46a3-a9b4-97181ab868e4 Co-authored-by: tasteee <94029138+tasteee@users.noreply.github.com>

Copilot · 2026-05-15T06:57:37Z

@copilot please see comments and apply fixes

Done in af85d01. Here's a summary of every fix applied:

simple-scripts/README.md — changed "no captures" to "no named captures" (the config does use [...rest] variadic passthrough).
docker-deploy/dooz.yaml — changed build <service> to build <service> [...rest] so both build patterns genuinely compete on dooz build api 1.4.2, with build <service> <tag> winning via specificity. Also added --name {{service | lower}} to the run command so logs and stop reference the correct container name.
docker-deploy/README.md — updated the commands table and the "Features shown" section to reflect the above.
full-featured/dooz.yaml — removed shell quotes from the flags template (quotes become literal " argv tokens); replaced {{':'}} with a literal colon and removed surrounding quotes in the info template; removed uses: [environmentInfo] from deploy since region/cluster aren't referenced in its output.
full-featured/README.md — removed shell quotes from the flags expected output; updated info expected output to match the new template; changed … to ... in the truncate filter description.

Copilot AI and others added 2 commits May 15, 2026 06:39

feat: add examples directory with 5 self-contained example projects

8dd16dc

Agent-Logs-Url: https://github.com/tasteee/dooz/sessions/40b2a2ca-7123-4293-825e-69ad9d7f0580 Co-authored-by: tasteee <94029138+tasteee@users.noreply.github.com>

style: fix coding rule violations in example extension files

e67d4ae

Agent-Logs-Url: https://github.com/tasteee/dooz/sessions/40b2a2ca-7123-4293-825e-69ad9d7f0580 Co-authored-by: tasteee <94029138+tasteee@users.noreply.github.com>

Copilot AI assigned Copilot and tasteee May 15, 2026

Copilot created this pull request from a session on behalf of tasteee May 15, 2026 06:42 View session

Copilot finished work on behalf of tasteee May 15, 2026 06:42

Copilot AI requested a review from tasteee May 15, 2026 06:42

tasteee requested review from Copilot and removed request for tasteee May 15, 2026 06:45

tasteee marked this pull request as ready for review May 15, 2026 06:45

Copilot started reviewing on behalf of tasteee May 15, 2026 06:46 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

Copilot started work on behalf of tasteee May 15, 2026 06:53 View session

fix: address all code reviewer comments on examples

af85d01

Agent-Logs-Url: https://github.com/tasteee/dooz/sessions/c15381f0-9c8e-46a3-a9b4-97181ab868e4 Co-authored-by: tasteee <94029138+tasteee@users.noreply.github.com>

Copilot finished work on behalf of tasteee May 15, 2026 06:58

Copilot AI requested a review from tasteee May 15, 2026 06:58

tasteee approved these changes May 16, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add examples directory with five self-contained example projects - #1

feat: add examples directory with five self-contained example projects#1
tasteee with Copilot wants to merge 3 commits into
mainfrom
copilot/add-examples-directory

Copilot AI commented May 15, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

tasteee commented May 15, 2026

Uh oh!

Copilot AI commented May 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		The simplest possible dooz setup: a single `dooz.yaml` with no extension file.

		Every command is a short alias for a longer `npm` or tool invocation. No resolvers, no validators, no captures — just clean pattern-to-command mappings.

Conversation

Copilot AI commented May 15, 2026

Summary

Examples

simple-scripts

monorepo-workspace

docker-deploy

git-workflow

full-featured

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

tasteee commented May 15, 2026

Uh oh!

Copilot AI commented May 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

`simple-scripts`

`monorepo-workspace`

`docker-deploy`

`git-workflow`

`full-featured`