@captain_z/zsk 1.8.3 → 1.8.5

package/templates/project-init/.zsk/templates/config.examples.yaml

@@ -0,0 +1,83 @@
+# Example provider/resource/route shapes. Copy only the entries this project
+# actually needs into .zsk/config.yaml.
+#
+# Store secret values in the shell environment, not in config. If credentials
+# live in ~/.zshrc, export them there, for example:
+#   export ACCESS_TOKEN=...
+#   export CONFLUENCE_USER=...
+#   export CONFLUENCE_PASSWORD=...
+# ZSK reads process.env after the shell starts; it does not parse ~/.zshrc.
+
+providers:
+  jira:
+    type: issues
+    adapter: jira
+    baseUrl: https://jira.example.com
+    auth:
+      env: ACCESS_TOKEN
+    defaults:
+      project: ZSK
+      assignee: me
+  confluence:
+    type: document
+    adapter: confluence
+    baseUrl: https://confluence.example.com
+    auth:
+      usernameEnv: CONFLUENCE_USER
+      passwordEnv: CONFLUENCE_PASSWORD
+
+automation:
+  demo:
+    auth:
+      required: true
+      loginUrl: http://localhost:3000/login
+      storageState: .zsk/modules/{module}/_playwright/.auth/user.json
+      envFiles:
+        - ~/.zshrc
+      env:
+        username: DEMO_USERNAME
+        password: DEMO_PASSWORD
+      selectors:
+        username: input[name="username"]
+        password: input[type="password"]
+        submit: button[type="submit"]
+
+resources:
+  - id: core-api
+    type: repository
+    area: Backend Services
+    source:
+      kind: git-submodule
+      path: .zsk/raws/repositories/core-api/repository
+
+  - id: my-bugs
+    type: issues
+    provider: jira
+    query:
+      jql: assignee = currentUser() AND issuetype = Bug ORDER BY updated DESC
+    classify:
+      by: [priority, component, status]
+
+  - id: role-prd
+    type: document
+    area: Confluence
+    provider: confluence
+    source:
+      kind: confluence
+      pageId: "12345"
+
+  - id: public-prd
+    type: document
+    area: Product
+    source:
+      kind: url
+      url: https://example.com/prd
+      fallback:
+        acquisition: [playwright_cli]
+        observation: [computer_use]
+
+routes:
+  - from: my-bugs
+    to:
+      module: permission
+      artifact: issues

package/templates/project-init/.zsk/templates/issue-card.md

@@ -0,0 +1,23 @@
+---
+id: "<issue-id>"
+title: "<issue-title>"
+status: open
+priority: medium
+module: "<module-id>"
+source:
+  resource: "<resource-id>"
+  provider: "<provider-id>"
+  key: "<provider-issue-key>"
+---
+
+# <issue-title>
+
+<!-- zsk:source:start -->
+Provider source summary will be updated by `zsk prepare sync`.
+<!-- zsk:source:end -->
+
+## Local Notes
+
+## Decision
+
+## Next Action

package/templates/project-init/.zsk/templates/module/README.md

@@ -0,0 +1,13 @@
+# Module Template
+
+Copy this template through `zsk module init`; do not create real module
+directories by hand unless the same file contract is preserved.
+
+Required files:
+
+- `module.yaml`
+- `README.md`
+- `proposal.md`
+- `spec.md`
+- `design.md`
+- `tasks.md`

package/templates/project-init/.zsk/templates/module/design.md

@@ -0,0 +1,22 @@
+# Design
+
+## Output Quality Check
+
+status: NEEDS_CLARIFICATION
+owner: design
+source_basis: []
+blocking_items:
+  - Map approved behavior to implementation surfaces.
+next_action: Resolve Interface, data flow, rollout, and verification gaps.
+
+## Module
+
+## Interfaces
+
+## Implementation
+
+## Data Flow
+
+## Risks
+
+## Verification

package/templates/project-init/.zsk/templates/module/module.yaml

@@ -0,0 +1,15 @@
+# yaml-language-server: $schema=__ZSK_MODULE_SCHEMA_URL__
+
+module:
+  id: "<module-id>"
+  name: "<Module Name>"
+
+outputs:
+  docs: .zsk/modules/<module-id>
+  issues: .zsk/modules/<module-id>/_issues
+
+tests:
+  raw_cases: []
+  derived_cases: []
+  automated:
+    e2e: []

package/templates/project-init/.zsk/templates/module/proposal.md

@@ -0,0 +1,20 @@
+# Proposal
+
+## Output Quality Check
+
+status: NEEDS_CLARIFICATION
+owner: proposal
+source_basis: []
+blocking_items:
+  - Fill the proposal from reviewed sources.
+next_action: Record scope, non-goals, success criteria, and open questions.
+
+## Problem
+
+## Scope
+
+## Non-Goals
+
+## Success Criteria
+
+## Open Questions

package/templates/project-init/.zsk/templates/module/spec.md

@@ -0,0 +1,22 @@
+# Spec
+
+## Output Quality Check
+
+status: NEEDS_CLARIFICATION
+owner: spec
+source_basis: []
+blocking_items:
+  - Fill observable behavior and acceptance criteria from reviewed sources.
+next_action: Resolve missing behavior questions before design.
+
+## Functional Requirements
+
+## Non-Functional Requirements
+
+## Acceptance Criteria
+
+## Scenarios
+
+## Edge Cases
+
+## Open Questions

package/templates/project-init/.zsk/templates/module/tasks.md

@@ -0,0 +1,16 @@
+# Tasks
+
+## Output Quality Check
+
+status: NEEDS_CLARIFICATION
+owner: task
+source_basis: []
+blocking_items:
+  - Convert design into executable tasks.
+next_action: Add ordered tasks with dependencies, owners, and evidence hooks.
+
+## Task Queue
+
+- [ ] Define the first implementation task.
+
+## Evidence Hooks

package/templates/project-init/.zsk/raws/index.md

@@ -1,18 +0,0 @@
-# Raw Source Index
-
-Immutable fact sources for this project. Generated and refreshed by `zsk prep`.
-
-Active source snapshots should be organized by prepare responsibility lane:
-
-- `prepare/product/` for SRS, PRD, business process, acceptance semantics, and work items.
-- `prepare/product/{topic}/product-brief.md` and `roadmap.md` for preproposal-generated product direction and MVP/phase decomposition after checkpoint review.
-- `prepare/backend/` for backend repositories, API contracts, data model, and service-boundary evidence.
-- `prepare/design/` for design/prototype sources, screen maps, and visual assets.
-- `prepare/design/{topic}/design-source-needs.md` for preproposal design-source readiness gaps after checkpoint review.
-- `prepare/ux/` for user flows, interaction notes, IA, and usability evidence.
-- `prepare/ux/{topic}/ux-readiness.md` for preproposal journey/flow/IA/readiness seeds after checkpoint review.
-- `prepare/qa/` for test cases, acceptance scenarios, regression matrices, and QA evidence.
-
-| Provider | Type | Status | Snapshot / Origin |
-| --- | --- | --- | --- |
-|  |  |  |  |

package/templates/project-init/.zsk/raws/manifest.json

@@ -1,4 +0,0 @@
-{
-  "version": 1,
-  "resources": []
-}

package/templates/project-init/.zsk/raws/prepare/backend/index.md

@@ -1,4 +0,0 @@
-# Backend Sources
-
-Backend repositories, API contracts, OpenAPI files, data model notes, auth boundaries, and integration evidence.
-

package/templates/project-init/.zsk/raws/prepare/design/index.md

@@ -1,3 +0,0 @@
-# Design Sources
-
-Design handoff files, wireframes, prototype exports, visual assets, design tokens, and platform snapshots.

package/templates/project-init/.zsk/raws/prepare/index.md

@@ -1,4 +0,0 @@
-# Prepare Source Lanes
-
-Reusable source snapshots for prepare. Iterations and releases should reference these snapshots instead of copying source content.
-

package/templates/project-init/.zsk/raws/prepare/product/index.md

@@ -1,4 +0,0 @@
-# Product Sources
-
-SRS, PRD, business process, acceptance semantics, product decisions, and work items.
-

package/templates/project-init/.zsk/raws/prepare/qa/index.md

@@ -1,4 +0,0 @@
-# QA Sources
-
-QA cases, acceptance cases, regression matrices, test data, and verification source material.
-

package/templates/project-init/.zsk/raws/prepare/ux/index.md

@@ -1,3 +0,0 @@
-# UX Sources
-
-User flows, interaction maps, screen behavior notes, usability findings, and experience research artifacts.