fmt

Run make fmt to format Rust code and check license headers.

11.5k|578|Updated Apr 13, 2021
One-click install
npx skills add https://github.com/quickwit-oss/quickwit --skill fmt
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fmt
Source: https://github.com/quickwit-oss/quickwit/tree/main/.claude/skills/fmt
Command: npx skills add https://github.com/quickwit-oss/quickwit --skill fmt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The fmt skill helps ensure code quality by validating that source files adhere to formatting standards, preventing style drift and making reviews easier.

Core Features & Use Cases

  • Enforces Rust formatting across the quickwit/ repository.
  • Verifies license headers and log formatting conventions during a codebase check.
  • Use Case: run the quickwit project formatting check before a PR to guarantee consistent style.

Quick Start

Run make fmt from the quickwit subdirectory to verify code formatting.

Frequently Asked Questions about fmt

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

FAQPage Schema
How do I check Rust code formatting before submitting a pull request?

To check Rust code formatting, run the `make fmt` command from the quickwit subdirectory. This validates source files against formatting standards, checks license headers, and enforces log style rules to prevent style drift.

What does code formatting enforcement check besides style?

Code formatting enforcement checks Rust style, verifies that license headers are present in source files, and enforces log formatting conventions. This ensures comprehensive code quality and policy compliance across the repository.

Do I need a local Rust toolchain to run code formatting checks?

Yes, you need a local Rust toolchain and `make` installed to execute code formatting checks deterministically. These environment prerequisites are required to run the `make fmt` command successfully.

Why should I enforce code formatting standards in my repository?

Enforcing code formatting standards prevents style drift and makes code reviews easier. By validating that source files adhere to consistent formatting rules, you maintain code quality and reduce manual review overhead.

Can I use this code formatting check on any Rust project?

This code formatting check is specifically applied to the quickwit/ subdirectory. It enforces Rust formatting, license headers, and log style rules tailored to the quickwit repository, ensuring consistent style for that project.