mflux-dev-env

Configures the mflux development environment using uv, justfile recipes, and ty type checking.

2.4k|187|Updated Aug 10, 2024
One-click install
npx skills add https://github.com/mflux-community/mflux --skill mflux-dev-env-mflux-community
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: mflux-dev-env
Source: https://github.com/mflux-community/mflux/tree/main/.cursor/skills/mflux-dev-env
Command: npx skills add https://github.com/mflux-community/mflux --skill mflux-dev-env-mflux-community

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Contributors to the mflux repository need a canonical, repeatable way to set up their local environment and run lint, format, build, test, and type-check commands without guessing which tools or flags the project expects. ## Core Features & Use Cases - Environment Setup Guidance: Documents the macOS arm64 expectation, the uv package manager preference, and the just (≥ 1.50) prerequisite for running project recipes. - Canonical Command Reference: Maps common tasks to justfile recipes such as just install, just lint, just format, just check, just build, and just typecheck. - Type Checker Migration Baseline: Explains the astral ty type checker setup, the pinned version, and the planned burn-down strategy for re-enabling ignored rules from the mypy-to-ty migration. - Use Case: A new contributor clones the mflux repo and asks how to run the pre-commit checks; the Skill directs them to just check and explains that tests must keep MFLUX_PRESERVE_TEST_OUTPUT=1 enabled. ## Quick Start Ask the AI to set up the mflux repository locally and run the lint, format, and type-check commands using the project's justfile recipes.

Frequently Asked Questions about mflux-dev-env

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up the mflux development environment?▼

The mflux repo expects macOS arm64 and uses uv plus justfile recipes. Install just version 1.50 or higher via brew, then run `just install` to set up dependencies and `just check` to run the full pre-commit suite.

How do I run lint and format checks in mflux?▼

Run `just lint` for linting and `just format` for formatting. The justfile also provides `just fmt-justfile` to auto-fix justfile formatting, which CI verifies with `just --fmt --check`.

What type checker does mflux use?▼

mflux uses astral's ty type checker, pinned exactly in pyproject.toml dev dependencies and mirrored in the pre-commit config. Run it with `just typecheck` or `uv run ty check`.

Why are some ty rules set to ignore in pyproject.toml?▼

The ignored rules are a one-time migration baseline from mypy to ty, covering pre-existing violations with counts in comments. The plan is to re-enable them piecemeal by deleting one ignore line, fixing the errors, and committing; new ignore lines must not be added.

Can I run mflux tests without the justfile?▼

You can run Python commands directly with `uv run`, but keep the MFLUX_PRESERVE_TEST_OUTPUT=1 environment variable enabled when running tests. The justfile test recipes already set this variable for you.