@kiwidata/grimoire 0.1.1

package/templates/context.yml

@@ -0,0 +1,110 @@
+# Grimoire Project Context
+# Captures the deployment environment, related services, and infrastructure
+# that this project depends on or interacts with.
+#
+# This file is NOT a decision record — it describes what IS.
+# Update it when the environment changes (new service, migration, etc.)
+#
+# Created by: grimoire init
+# Last updated: YYYY-MM-DD
+
+# --- Deployment ---
+# How and where this project is deployed.
+
+deployment:
+  # target: ecs | kubernetes | heroku | vercel | lambda | vm | docker-compose | manual
+  target:
+  # regions: [us-east-1, eu-west-1]
+  regions: []
+  # environments and their URLs or identifiers
+  environments:
+    # dev:
+    #   url: https://dev.example.com
+    #   notes: "auto-deploys from main"
+    # staging:
+    #   url: https://staging.example.com
+    # production:
+    #   url: https://example.com
+  # Path to deploy scripts, Helm charts, Terraform, CDK, etc.
+  scripts: []
+    # - path: deploy/
+    #   type: terraform
+    # - path: k8s/
+    #   type: helm
+    # - path: .github/workflows/deploy.yml
+    #   type: github-actions
+
+# --- Related Services ---
+# Sibling services this project communicates with at runtime.
+# These are services your team or org owns — for third-party APIs,
+# use schema.yml's external_api section instead.
+
+services: []
+  # - name: auth-service
+  #   repo: github.com/org/auth-service
+  #   owner: platform-team
+  #   purpose: "Handles OAuth2 flows and token issuance"
+  #   protocol: grpc
+  #   port: 50051
+  # - name: notification-service
+  #   repo: github.com/org/notifications
+  #   owner: platform-team
+  #   purpose: "Email, SMS, and push notifications"
+  #   protocol: rest
+  #   base_url: http://notifications.internal:8080
+  # - name: frontend
+  #   repo: github.com/org/web-app
+  #   owner: product-team
+  #   purpose: "React SPA — consumes this project's API"
+  #   protocol: rest
+
+# --- Infrastructure ---
+# Runtime dependencies: databases, caches, queues, storage, etc.
+
+infrastructure: []
+  # - type: postgres
+  #   purpose: "Primary data store"
+  #   host: "${DATABASE_HOST}"
+  #   notes: "RDS, multi-AZ in production"
+  # - type: redis
+  #   purpose: "Cache and session store"
+  #   host: "${REDIS_HOST}"
+  # - type: rabbitmq
+  #   purpose: "Async task queue"
+  #   host: "${BROKER_HOST}"
+  #   notes: "CloudAMQP in production, docker locally"
+  # - type: s3
+  #   purpose: "User uploads and media"
+  #   bucket: "${MEDIA_BUCKET}"
+
+# --- CI/CD ---
+# Where the build and deploy pipelines live.
+
+ci_cd:
+  # platform: github-actions | gitlab-ci | circleci | jenkins | buildkite
+  platform:
+  # Key workflow files
+  workflows: []
+    # - path: .github/workflows/ci.yml
+    #   purpose: "Lint, test, build on every PR"
+    # - path: .github/workflows/deploy.yml
+    #   purpose: "Deploy to staging on merge to main, production on tag"
+  # deploy_trigger: "merge to main" | "git tag" | "manual"
+  deploy_trigger:
+
+# --- Observability ---
+# Where to look when things break.
+
+observability:
+  # logging:
+  #   platform: datadog | cloudwatch | elk | grafana-loki
+  #   dashboard: https://app.datadoghq.com/logs?query=service:my-project
+  # monitoring:
+  #   platform: datadog | prometheus | cloudwatch
+  #   dashboard: https://grafana.internal/d/api-latency
+  # alerting:
+  #   platform: pagerduty | opsgenie | slack
+  #   channel: "#oncall-alerts"
+  # error_tracking:
+  #   platform: sentry | bugsnag | rollbar
+  #   project: https://sentry.io/org/project/

package/templates/debt-exceptions.yml

@@ -0,0 +1,61 @@
+# Grimoire Debt Exceptions
+# Explicitly accepted technical debt — items the scanner should skip.
+#
+# Each exception requires a reason, an owner, and a Fowler quadrant classification:
+#   deliberate-prudent:    "We know, and it's the right trade-off for now"
+#   deliberate-reckless:   "We know, and we're cutting corners"
+#   inadvertent-prudent:   "We didn't know then, and fixing isn't worth it now"
+#   inadvertent-reckless:  "We didn't know, and the cost to fix is too high right now"
+#
+# Exceptions can target:
+#   - A specific debt register item (by id)
+#   - A file path pattern (glob) + category
+#   - A file path pattern (glob) + all categories
+#
+# Expired exceptions are automatically re-flagged during scanning.
+#
+# Created by: grimoire init
+# Last updated: YYYY-MM-DD
+
+exceptions: []
+
+# --- Examples ---
+#
+# Accept a specific debt register item:
+#
+#   - id: debt-003
+#     reason: "Splitting config types would break the plugin API contract.
+#              Revisit when we version the plugin API."
+#     quadrant: deliberate-prudent
+#     owner: fred
+#     accepted: 2026-04-06
+#     expires: 2026-10-01
+#
+# Accept all debt in vendored/generated code:
+#
+#   - pattern: "src/vendor/**"
+#     category: "*"
+#     reason: "Vendored code — we don't own it"
+#     quadrant: deliberate-prudent
+#     owner: fred
+#     accepted: 2026-04-06
+#
+# Accept structural bloat in a specific file:
+#
+#   - pattern: "src/legacy/monolith.py"
+#     category: structural_bloat
+#     reason: "Scheduled for full rewrite in Q3. Incremental refactoring
+#              would conflict with the rewrite branch."
+#     quadrant: deliberate-prudent
+#     owner: jane
+#     accepted: 2026-04-06
+#     expires: 2026-07-01
+#
+# Accept all complexity findings in generated migration files:
+#
+#   - pattern: "**/migrations/**"
+#     category: structural_bloat
+#     reason: "Auto-generated by framework — complexity is inherent"
+#     quadrant: deliberate-prudent
+#     owner: team
+#     accepted: 2026-04-06

package/templates/decision.md

@@ -0,0 +1,50 @@
+---
+status: proposed
+date: YYYY-MM-DD
+decision-makers: []
+---
+
+# <Short Title: Problem and Solution>
+
+## Context and Problem Statement
+<!-- Why are we making this decision? What forces are at play? -->
+
+## Decision Drivers
+<!-- Key factors influencing this decision -->
+-
+-
+
+## Considered Options
+1.
+2.
+3.
+
+## Decision Outcome
+Chosen option: "", because [justification].
+
+### Consequences
+- Good:
+- Bad:
+
+### Quality Attributes
+<!-- Delete rows that don't apply. Targets should be measurable. Leave blank if not yet known — the review stage will flag missing targets for quality-sensitive decisions. -->
+
+| Attribute        | Target | Measurement |
+|------------------|--------|-------------|
+| Latency (p95)    |        |             |
+| Throughput       |        |             |
+| Availability     |        |             |
+| Recovery time    |        |             |
+| Data freshness   |        |             |
+| Concurrent users |        |             |
+| Storage growth   |        |             |
+| Security (CIA)   |        |             |
+
+### Cost of Ownership
+<!-- What are the ongoing costs and benefits of this decision? -->
+- **Maintenance burden**: <!-- What does this add to ongoing maintenance? New dependencies to update, monitoring to watch, migrations to run, concepts for new devs to learn? -->
+- **Ongoing benefits**: <!-- What does this save or enable over time? -->
+- **Sunset criteria**: <!-- Under what conditions should we revisit, replace, or remove this? -->
+
+### Confirmation
+<!-- How will we verify this decision was correct? Metrics, tests, review date? -->

package/templates/dupignore

@@ -0,0 +1,93 @@
+# Glob patterns excluded from duplicate detection (jscpd).
+# Matched against paths relative to project root. One glob per line.
+# Lines starting with # are comments.
+#
+# This file is independent of .grimoire/mapignore (structure scan).
+# Edit here to silence duplicate-detection noise without hiding
+# directories from the project map.
+
+# Version control
+**/.git/**
+
+# Dependencies
+**/node_modules/**
+**/.venv/**
+**/venv/**
+**/env/**
+**/vendor/**
+**/bower_components/**
+**/third_party/**
+**/external/**
+**/libs/**
+**/Pods/**
+**/Carthage/**
+**/site-packages/**
+**/deps/**
+**/.pnpm-store/**
+**/.yarn/**
+
+# Build output
+**/dist/**
+**/build/**
+**/.next/**
+**/.nuxt/**
+**/out/**
+**/target/**
+**/.gradle/**
+**/bin/**
+**/obj/**
+
+# Caches
+**/__pycache__/**
+**/.pytest_cache/**
+**/.mypy_cache/**
+**/.ruff_cache/**
+**/.tox/**
+**/.cache/**
+**/.parcel-cache/**
+**/.turbo/**
+
+# Coverage and test artifacts
+**/coverage/**
+**/.nyc_output/**
+**/htmlcov/**
+
+# Generated code — Protobuf, gRPC
+**/*_pb2.py
+**/*_pb2_grpc.py
+**/*.pb.go
+**/*.pb.cc
+**/*.pb.h
+**/*_pb.js
+**/*_pb.d.ts
+**/*.pb.dart
+
+# Generated code — OpenAPI / Swagger clients
+**/generated/**
+**/*_generated.*
+**/*.generated.*
+**/openapi/**
+**/swagger/**
+
+# Generated code — GraphQL
+**/__generated__/**
+**/graphql.schema.json
+
+# Minified / bundled assets
+**/*.min.js
+**/*.min.css
+**/*.bundle.js
+**/*.chunk.js
+
+# Database migrations (often near-duplicate boilerplate)
+**/migrations/**
+**/alembic/versions/**
+
+# Lock files and compiled artifacts
+**/*.lock
+**/*.map
+
+# Snapshots / fixtures (duplication here is intentional)
+**/__snapshots__/**
+**/fixtures/**
+**/testdata/**

package/templates/example.feature

@@ -0,0 +1,24 @@
+Feature: Login with two-factor authentication
+  As a user
+  I want to verify my identity with a second factor
+  So that my account is protected from unauthorized access
+
+  Background:
+    Given I am on the login page
+
+  Scenario: Successful login with valid TOTP code
+    Given I have entered valid credentials
+    When I enter a valid TOTP code
+    Then I should be redirected to the dashboard
+
+  Scenario: Login rejected with expired TOTP code
+    Given I have entered valid credentials
+    When I enter an expired TOTP code
+    Then I should see an error message "Code expired"
+    And I should remain on the verification page
+
+  Scenario: Login rejected with invalid TOTP code
+    Given I have entered valid credentials
+    When I enter an invalid TOTP code
+    Then I should see an error message "Invalid code"
+    And I should remain on the verification page

package/templates/manifest.md

@@ -0,0 +1,29 @@
+---
+status: draft
+complexity:
+branch:
+design_ref:
+---
+
+# Change: <Brief description>
+
+## Why
+<!-- 1-2 sentences: what problem or opportunity does this address? How will you know it's solved? -->
+
+## Non-goals
+<!-- What is explicitly out of scope? What should this change NOT do, NOT handle, or NOT affect? Downstream skills use this to catch scope creep during planning and review. -->
+
+## Feature Changes
+<!-- List each feature file affected. Use ADDED, MODIFIED, or REMOVED. -->
+- **ADDED** `<capability>/<name>.feature` —
+- **MODIFIED** `<capability>/<name>.feature` —
+- **REMOVED** `<capability>/<name>.feature` —
+
+## Scenarios Added
+<!-- List new scenarios by file -->
+
+## Scenarios Modified
+<!-- List changed scenarios with brief description of what changed -->
+
+## Decisions
+<!-- List any ADRs created or superseded as part of this change -->

package/templates/mapignore

@@ -0,0 +1,58 @@
+# Directories and patterns to ignore when scanning the codebase
+# Uses glob-style patterns, one per line
+# Lines starting with # are comments
+
+# Version control
+.git
+
+# Dependencies
+node_modules
+.venv
+venv
+env
+vendor
+bower_components
+third_party
+external
+Pods
+Carthage
+site-packages
+.pnpm-store
+.yarn
+
+# Build output
+dist
+build
+.next
+.nuxt
+out
+target
+.gradle
+obj
+
+# Caches
+__pycache__
+.pytest_cache
+.mypy_cache
+.ruff_cache
+.tox
+.cache
+.parcel-cache
+.turbo
+
+# Coverage and test artifacts
+coverage
+.nyc_output
+htmlcov
+
+# IDE and OS
+.idea
+.vscode
+.DS_Store
+
+# Package metadata
+*.egg-info
+.eggs
+
+# Containers
+.docker

package/templates/mapkeys

@@ -0,0 +1,65 @@
+# Key files that indicate what a directory is for
+# Format: filename = type
+# Lines starting with # are comments
+
+# Node / JavaScript / TypeScript
+package.json = node-package
+tsconfig.json = typescript-config
+index.ts = module-entry
+index.js = module-entry
+routes.ts = api-routes
+routes.js = api-routes
+middleware.ts = middleware
+middleware.js = middleware
+eslint.config.js = linter-config
+.eslintrc.js = linter-config
+.eslintrc.json = linter-config
+jest.config.js = test-config
+jest.config.ts = test-config
+vitest.config.ts = test-config
+
+# Python
+pyproject.toml = python-package
+setup.py = python-package
+setup.cfg = python-config
+requirements.txt = python-deps
+Pipfile = python-deps
+__init__.py = python-module
+conftest.py = pytest-fixtures
+pytest.ini = test-config
+
+# Django
+urls.py = django-urls
+views.py = django-views
+models.py = django-models
+serializers.py = drf-serializers
+admin.py = django-admin
+apps.py = django-app
+settings.py = django-settings
+manage.py = django-management
+middleware.py = middleware
+
+# FastAPI / Flask
+main.py = app-entry
+app.py = app-entry
+
+# Background tasks
+tasks.py = background-tasks
+celery.py = task-queue
+
+# Database
+alembic.ini = db-migrations
+schema.prisma = db-schema
+
+# Build / Deploy
+Dockerfile = container
+docker-compose.yml = container-orchestration
+docker-compose.yaml = container-orchestration
+Makefile = build-system
+Procfile = deployment
+
+# Go
+go.mod = go-module
+
+# Rust
+Cargo.toml = rust-package