MMDev - Mattermost Development Tool

MMDev is a command-line tool designed to streamline the development workflow for Mattermost. It provides a unified interface for managing both the server and client components of Mattermost during development.

Features

• Start/stop Mattermost server with development configuration
• Manage webapp development with hot-reloading
• Automated Docker service management for dependencies
• Combined server and webapp development mode with split view
• Code linting for both server and client
• File watching and auto-restart capabilities
• E2E testing support with Playwright and Cypress
• Automatic Mattermost repository detection and navigation

Prerequisites

• Go 1.21 or later
• Docker
• Node.js and npm (for client development)
• PostgreSQL client tools (for health checks)
• NVM (Node Version Manager) configured in ~/.nvm

Installation

go install github.com/jespino/mmdev@latest

After installation, configure the tool:

mmdev config

This will guide you through setting up:

• Jira integration (URL, username, API token)
• Sentry integration (API token)
• Weblate integration (URL, API token)

Usage

Start Everything (Server + Webapp)

mmdev start

This command starts both the server and webapp in a split view with live output from both processes. Use:

• 'tab' to switch between server/webapp panes
• 'r' to restart server (when server pane is selected)
• 's' to toggle between vertical/horizontal split (auto-scrolls to bottom)
• 'q' to quit
• ':' to enter command mode with the following commands:
  • quit: Exit the application
  • client-restart: Stop and restart the webapp process
  • server-restart: Restart the server process

Server Commands

mmdev server start    # Start the server
mmdev server start -w # Start with file watching
mmdev server lint     # Run server code linting
mmdev server generate layers  # Generate app/store layers and plugin API
mmdev server generate mocks   # Generate mock files
mmdev server generate all     # Generate all code (layers and mocks)

Webapp Commands

mmdev webapp start    # Start the webapp
mmdev webapp start -w # Start with file watching
mmdev webapp lint     # Run webapp code linting
mmdev webapp fix      # Run auto-fix on webapp code

Docker Commands

mmdev docker start # Start required Docker services
mmdev docker stop  # Stop Docker services
mmdev docker clean # Remove containers and volumes

Configuration Command

mmdev config # Configure Jira and Sentry integration

Release Dates Command

mmdev dates # Show upcoming Mattermost release dates and milestones

Translation Commands

mmdev translate components           # List available Weblate components
mmdev translate languages           # List available languages
mmdev translate languages --all     # List all available languages
mmdev translate component-stats <project:component>  # Show component translation stats
mmdev translate translate <project:component> <language>  # Interactive translation wizard
mmdev translate translate --ai <project:component> <language>  # Translation wizard with AI suggestions

Translation commands require Weblate configuration in environment variables or ~/.mmdev.toml:

• WEBLATE_URL: Your Weblate instance URL
• WEBLATE_TOKEN: Your Weblate API token

E2E Testing Commands

mmdev e2e playwright run     # Run Playwright E2E tests
mmdev e2e playwright ui      # Open Playwright UI
mmdev e2e playwright report  # Show Playwright test report

mmdev e2e cypress run        # Run Cypress E2E tests
mmdev e2e cypress ui         # Open Cypress UI
mmdev e2e cypress report     # Show Cypress test report

Plugin Commands

mmdev plugin manifest apply  # Generate server/webapp files from plugin manifest
mmdev plugin manifest dist   # Write manifest to dist directory
mmdev plugin manifest check  # Validate plugin manifest

mmdev plugin deploy <plugin-id> <bundle-path>  # Deploy and enable a plugin
mmdev plugin enable <plugin-id>   # Enable a plugin
mmdev plugin disable <plugin-id>  # Disable a plugin
mmdev plugin reset <plugin-id>    # Reset (disable/enable) a plugin
mmdev plugin logs <plugin-id>     # Show plugin logs
mmdev plugin watch <plugin-id>    # Watch plugin logs in real-time

AI-Assisted Development Commands

mmdev aider index-commits         # Create semantic index of git commits
mmdev aider github owner/repo#123 # Process GitHub issue with aider
mmdev aider github-pr owner/repo#123 # Process GitHub Pull Request with aider
mmdev aider jira PROJECT-123      # Process Jira issue with aider
mmdev aider sentry ISSUE-ID       # Process Sentry issue with aider
mmdev aider confluence PAGE-ID    # Process Confluence page with aider

The index-commits command creates a semantic search index of your git repository's commit history. This index is used by the other aider commands to find relevant commits when processing issues. The index should be rebuilt whenever significant new commits are added to the repository.

The aider commands require:

• For GitHub: Public repository access
• For Confluence: Jira credentials (uses same authentication)
• For Jira: Credentials configured in ~/.mmdev.toml or environment variables:
  • JIRA_URL: Your Jira instance URL
  • JIRA_USER: Your Jira username
  • JIRA_TOKEN: Your Jira API token
• For Sentry: Environment variables or ~/.mmdev.toml configuration:
  • SENTRY_TOKEN: Your Sentry authentication token

Docker Services

The tool manages these Docker services automatically:

• PostgreSQL (Database)
• Minio (S3-compatible storage)
• OpenLDAP (Directory service)
• Elasticsearch (Search engine)
• Inbucket (Email testing)
• Redis (Caching)

Development

To contribute to MMDev:

1. Clone the repository
2. Install dependencies: go mod download
3. Make your changes
4. Run tests: go test ./...
5. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.