moonbit-agent-guide

Guide MoonBit project development, refactoring, and testing with the moon CLI.

63|2|Updated Aug 27, 2024
One-click install
npx skills add https://github.com/pnsk-lab/hikkaku --skill moonbit-agent-guide-pnsk-lab
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: moonbit-agent-guide
Source: https://github.com/pnsk-lab/hikkaku/tree/main/packages/moonscratch/.agents/skills/moonbit-agent-guide
Command: npx skills add https://github.com/pnsk-lab/hikkaku --skill moonbit-agent-guide-pnsk-lab

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance for developing, refactoring, and testing MoonBit projects, ensuring adherence to best practices and efficient use of the MoonBit tooling ecosystem.

Core Features & Use Cases

  • Project Structure & Conventions: Understand and apply standard MoonBit project layouts, module, and package organization.
  • Tooling Mastery: Learn to effectively use the moon CLI for building, checking, testing, formatting, and code navigation.
  • Best Practices: Follow guidelines for coding, testing (snapshot testing), error handling, and spec-driven development.
  • Use Case: A new developer joins a MoonBit project and needs to understand how to structure their code, run tests, and use IDE features effectively. This Skill serves as their primary guide.

Quick Start

Consult the MoonBit Project Layouts section to understand how to organize your MoonBit project files and directories.

Frequently Asked Questions about moonbit-agent-guide

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

FAQPage Schema
How do I structure a new MoonBit project using standard conventions?

To structure a MoonBit project, organize files and directories according to standard module and package layouts. This ensures proper code navigation, build execution, and package management for efficient development.

What is the best way to run tests and format code in MoonBit?

The best way to run tests and format MoonBit code is by using the `moon` CLI. It provides commands for building, checking, testing, formatting, and navigating your project effectively.

How does snapshot testing work in MoonBit projects?

Snapshot testing in MoonBit captures the expected output of your code to compare against future test runs. It is part of the standard testing guidelines to ensure code stability during refactoring.

Can I use spec-driven development with MoonBit tooling?

Yes, you can use spec-driven development with MoonBit tooling. The development guide supports following specific guidelines for testing, error handling, and spec-driven workflows.

Why does my MoonBit build fail during package management?

MoonBit build failures during package management often stem from improper project layout or package organization. Following standard conventions and using the `moon` CLI correctly addresses common pitfalls.

Do I need to use the moon CLI to check and run MoonBit code?

Yes, you need the `moon` CLI to check and run MoonBit code as it provides the essential tooling for building, checking, running, testing, and generating documentation for your projects.