GitHub - EmeaAppGbb/appmodlab-squad-plugin-development: 🕹️ AppMod Lab: Build and publish SQUAD plugins — Integration toolkit · GitHub
Skip to content

EmeaAppGbb/appmodlab-squad-plugin-development

Folders and files

Repository files navigation

╔═══════════════════════════════════════════════════════════════════╗
║                                                                   ║
║   ██████╗ ██╗     ██╗   ██╗ ██████╗ ██╗███╗   ██╗               ║
║   ██╔══██╗██║     ██║   ██║██╔════╝ ██║████╗  ██║               ║
║   ██████╔╝██║     ██║   ██║██║  ███╗██║██╔██╗ ██║               ║
║   ██╔═══╝ ██║     ██║   ██║██║   ██║██║██║╚██╗██║               ║
║   ██║     ███████╗╚██████╔╝╚██████╔╝██║██║ ╚████║               ║
║   ╚═╝     ╚══════╝ ╚═════╝  ╚═════╝ ╚═╝╚═╝  ╚═══╝               ║
║                                                                   ║
║              ⚒️  EXTEND THE SQUAD ⚒️                             ║
║                                                                   ║
╚═══════════════════════════════════════════════════════════════════╝

🔌 PLUGIN INSTALLED → ⚒️ SKILL CRAFTED → 🏪 MARKETPLACE PUBLISHED!

MISSION: Become a SQUAD plugin architect! Build CUSTOM SKILLS, integrate EXTERNAL TOOLS, and share with the community via the SQUAD MARKETPLACE! 🚀🔧


🎮 LEVEL SELECT

🛠️ BUSINESS DOMAIN: SQUAD Plugin Development Itself
📂 CATEGORY: Agentic Software Development
PRIORITY: P3
🛠️ TECH STACK: TypeScript • SQUAD SDK • Jest
🏢 ORG: EmeaAppGbb


🕹️ PLAYER STATS

┌─────────────────────────────────────────────┐
│  BEFORE (Vanilla SQUAD) 🤖                  │
├─────────────────────────────────────────────┤
│  ✅ Core agents: Brain/Eyes/Hands/Mouth     │
│  🎯 Standard skills only                    │
│  🚫 No Jira integration                     │
│  🚫 No custom review rules                  │
│  🚫 No domain-specific ceremonies           │
│  📦 Limited to built-in capabilities        │
└─────────────────────────────────────────────┘

┌─────────────────────────────────────────────┐
│  AFTER (Plugin-Powered) 🔌✨                │
├─────────────────────────────────────────────┤
│  🔌 Jira sync plugin (issues ↔ GitHub)      │
│  🛡️  DB migration safety checker            │
│  📝 Changelog generator with semver         │
│  🎨 Custom skills for any agent             │
│  🏪 Shareable via npm registry              │
│  🌍 Join the SQUAD plugin community!        │
└─────────────────────────────────────────────┘

💥 BOSS BATTLES

Conquer these plugin challenges:

👾 BOSS 💀 ATTACK PATTERN ⚔️ YOUR WEAPON
The Integration Gap No Jira, no Slack, no nothing External tool plugins
The Generic Review Eyes can't check domain rules Custom review skills
The Manual Ceremony Repetitive tasks suck time Custom ceremony plugins
The Isolation Prison Can't share your genius npm publishing
The Config Hell Complex plugin setup Clean SDK API
The Testing Nightmare Mocking SQUAD context Plugin test harness

🎯 QUEST OBJECTIVES

🏆 Setup Plugin SDK — Install, scaffold hello-world
🏆 Build Jira Plugin — Bidirectional issue sync
🏆 Build DB Checker — Migration safety review skill
🏆 Build Changelog Plugin — Semver + conventional commits
🏆 Write Tests — Unit tests for all three plugins
🏆 Package Plugins — npm packaging with peer deps
🏆 Integration Test — Use plugins in sample project
🏆 Publish — Ship to npm (or private registry)


🎨 ARCADE THEMES

╔════════════════════════════════════════╗
║  🔊 SOUND EFFECTS:                     ║
║                                        ║
║  🔌 "PLUGIN INSTALLED!"                ║
║  ⚒️  "SKILL CRAFTED!"                  ║
║  🏪 "MARKETPLACE PUBLISHED!"           ║
║  🧪 "TESTS PASSING!"                   ║
║  📦 "NPM PACKAGE CREATED!"             ║
║  🎯 "SKILL ACTIVATED!"                 ║
║  ✨ "SQUAD EXTENDED!"                  ║
╚════════════════════════════════════════╝

🚀 POWER-UPS UNLOCKED

Build three epic plugins and master:

  • 🔌 SQUAD Plugin SDK — API, lifecycle hooks, config
  • 🎯 Skill Definition — Add capabilities to agents
  • 🛠️ External Integration — Connect SQUAD to any tool
  • 🛡️ Custom Review Rules — Domain-specific checks
  • 📝 Custom Ceremonies — Automate repetitive tasks
  • 📦 npm Packaging — Professional plugin distribution
  • 🧪 Plugin Testing — Mock SQUAD context for tests

⏱️ SPEEDRUN TIME

Estimated Duration: 4–6 hours ⏳

┌──────────────────────────────────────┐
│  🥉 BRONZE:  3 plugins implemented   │
│  🥈 SILVER:  +100% test coverage     │
│  🥇 GOLD:    +Published to npm       │
└──────────────────────────────────────┘

🛠️ STARTER PACK (Prerequisites)

Load up your dev environment:

  • ✅ Strong TypeScript development experience
  • ✅ Familiarity with SQUAD (agents, skills, ceremonies)
  • ✅ npm publishing experience (or account)
  • ✅ Basic Jira API knowledge (for plugin 1)

📂 LOOT TABLE (Key Files)

squad-plugins-lab/
├── plugins/
│   ├── jira-integration/          # 🔌 Plugin 1
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── 🎯 index.ts        # Plugin entry
│   │   │   ├── 📡 jira-client.ts  # API client
│   │   │   └── 🔄 issue-sync.ts   # Sync logic
│   │   └── tests/
│   ├── db-migration-checker/      # 🛡️  Plugin 2
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── 🎯 index.ts
│   │   │   ├── 🔍 migration-parser.ts
│   │   │   └── ⚠️  safety-rules.ts
│   │   └── tests/
│   └── changelog-generator/       # 📝 Plugin 3
│       ├── package.json
│       ├── src/
│       │   ├── 🎯 index.ts
│       │   ├── 📜 commit-parser.ts
│       │   ├── ✍️  changelog-writer.ts
│       │   └── 🔢 version-bumper.ts
│       └── tests/
├── test-project/                  # 🧪 Integration test
│   ├── .squad/
│   │   └── team.yml               # Uses all 3 plugins!
│   └── prisma/migrations/         # Test data
└── docs/
    ├── 📖 plugin-sdk-reference.md
    └── 📦 publishing-guide.md

🌊 LEVEL PROGRESSION

🎮 BRANCH FLOW

           main (🏁 Complete lab)
             │
    ┌────────┴────────┬────────┬────────┬────────┐
 legacy    step-1    step-2   step-3   step-4   step-5
  (📦)       ↓         ↓        ↓        ↓        ↓
          SDK      Jira     DB      Changelog  Test &
          Setup    Plugin   Checker  Plugin    Publish

Plugin Roster:

  1. 🔌 Jira Integration — Sync GitHub ↔ Jira issues
  2. 🛡️ DB Migration Checker — Detect destructive changes
  3. 📝 Changelog Generator — Semver + conventional commits

🔌 PLUGIN SHOWCASE

Plugin 1: Jira Integration 🎫

// Adds skill: sync-jira-issues
// Brain can create Jira tickets from GitHub issues
// Bidirectional status sync
// Auto-link PRs to Jira stories

Plugin 2: DB Migration Safety Checker 🛡️

// Adds review skill to Eyes
// Detects: DROP TABLE, DROP COLUMN, data loss risks
// Flags destructive changes before deploy
// Suggests safe migration patterns

Plugin 3: Changelog Generator 📝

// Adds ceremony: generate-changelog
// Parses conventional commits
// Categorizes: feat, fix, breaking
// Calculates semver bump (major/minor/patch)

🎯 ACHIEVEMENT UNLOCKED CONDITIONS

  • ✅ SQUAD Plugin SDK documented (API reference)
  • ✅ Jira plugin syncs issues (or mocked simulation)
  • ✅ DB checker detects destructive changes (DROP TABLE, etc.)
  • ✅ Changelog plugin produces correct Markdown
  • ✅ All three plugins pass unit & integration tests
  • ✅ Plugins install via SQUAD team.yml
  • ✅ Sample project demos all three plugins
  • ✅ APPMODLAB.md complete with SDK reference
  • ✅ Guide is clear and reproducible

🌟 FINAL BOSS: THE INTEGRATION TEST

╔══════════════════════════════════════════════╗
║                                              ║
║   Configure test-project with all 3 plugins ║
║                                              ║
║   Run a SQUAD development session:          ║
║     1. Make a DB migration → Safety check ✅ ║
║     2. Commit changes → Changelog gen ✅     ║
║     3. Create issue → Jira sync ✅           ║
║                                              ║
║   ALL PLUGINS WORKING = VICTORY! 🏆         ║
║                                              ║
╚══════════════════════════════════════════════╝

🎊 VICTORY SCREEN

YOU DEFEATED:

  • 🚫 Integration limitations
  • 🚫 Generic review rules
  • 🚫 Manual repetitive tasks
  • 🚫 Plugin development complexity
  • 🚫 Distribution challenges

YOU UNLOCKED:

  • 🔌 Jira + SQUAD integration
  • 🛡️ Custom safety review skills
  • 📝 Automated changelog generation
  • 🏪 npm publishing prowess
  • 🌍 SQUAD community contributor status!
┌─────────────────────────────────────────┐
│                                         │
│   🎮 YOU ARE NOW A PLUGIN MASTER 🎮     │
│                                         │
│   Share your creations! 🌍🔌            │
│                                         │
└─────────────────────────────────────────┘

🎵 Now playing: Electric Code by Plugin Architect 💿
🔌 Status: 3 PLUGINS READY FOR DEPLOYMENT!

📖 Full lab guide: See APPMODLAB.md for SDK deep dive
🏆 Credits: Built with ⚒️ by EmeaAppGbb


🌌 May your plugins be powerful and your npm downloads plentiful! 🌌

About

🕹️ AppMod Lab: Build and publish SQUAD plugins — Integration toolkit

Topics

Resources

Stars

Watchers

Forks

Packages

Contributors