MyProject mise tool plugin

This is a Mise plugin for MyProject, a project task runner built with MyCmd.

This is based off of the Mise Plugin Template.

Development Workflow

Setting up development environment

1. Install pre-commit hooks (optional but recommended):

hk install

This sets up automatic linting and formatting on git commits.

Local Testing

1. Link your plugin for development:

mise plugin link --force <TOOL> .

2. Run tests:

mise run test

3. Run linting:

mise run lint

4. Run full CI suite:

mise run ci

Code Quality

This template uses hk for modern linting and pre-commit hooks:

• Automatic formatting: stylua formats Lua code
• Static analysis: luacheck catches Lua issues
• GitHub Actions linting: actionlint validates workflows
• Pre-commit hooks: Runs all checks automatically on git commit

Manual commands:

hk check      # Run all linters (same as mise run lint)
hk fix        # Run linters and auto-fix issues

Debugging

Enable debug output:

MISE_DEBUG=1 mise install <TOOL>@latest

Files

• metadata.lua – Plugin metadata and configuration
• hooks/available.lua – Returns available versions from upstream
• hooks/pre_install.lua – Returns artifact URL for a given version
• hooks/post_install.lua – Post-installation setup (permissions, moving files)
• hooks/env_keys.lua – Environment variables to export (PATH, etc.)
• .github/workflows/ci.yml – GitHub Actions CI/CD pipeline
• mise.toml – Development tools and configuration
• mise-tasks/ – Task scripts for testing
• hk.pkl – Modern linting and pre-commit hook configuration
• .luacheckrc – Lua linting configuration
• stylua.toml – Lua formatting configuration

Documentation

Refer to the mise docs for detailed information:

• Tool plugin development - Complete guide to plugin development
• Lua modules reference - Available Lua modules and functions
• Plugin publishing - How to publish your plugin
• mise-plugins organization - Community plugins repository

Publishing

1. Ensure all tests pass: mise run ci
2. Create a GitHub repository for your plugin
3. Push your code
4. (Optional) Request to transfer to mise-plugins organization
5. Add to the mise registry via PR

License

MIT