gleam-reviewer

Reviews Gleam code for idiomatic patterns and best practices.

Updated Jan 21, 2019
One-click install
npx skills add https://github.com/jtdowney/dotfiles --skill gleam-reviewer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gleam-reviewer
Source: https://github.com/jtdowney/dotfiles/tree/main/dot_codex/skills/gleam-reviewer
Command: npx skills add https://github.com/jtdowney/dotfiles --skill gleam-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers write more idiomatic and maintainable Gleam code by identifying common anti-patterns and suggesting best practices.

Core Features & Use Cases

  • Code Analysis: Reviews Gleam code for adherence to functional design, control flow, error handling, and commenting best practices.
  • Idiomatic Suggestions: Provides concrete examples and explanations for improving code structure and readability.
  • Use Case: After writing a new module in Gleam, you can ask the Skill to review it to ensure it follows established conventions before committing.

Quick Start

Review the provided Gleam code snippet for best practices.

Frequently Asked Questions about gleam-reviewer

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

FAQPage Schema
How do I review Gleam code for idiomatic patterns and best practices?

To review Gleam code for idiomatic patterns, analyze function design, control flow, error handling, and comments against functional programming principles and standard library conventions to identify anti-patterns and suggest improvements.

What are common Gleam anti-patterns to avoid when writing modules?

Common Gleam anti-patterns involve non-idiomatic function design, poor error handling, and complex control flow. Identifying these issues helps refactor code to improve maintainability and adhere to established coding standards.

Can I check Gleam code quality for functional programming principles before committing?

Yes, you can check Gleam code quality before committing by reviewing the module for adherence to functional design, control flow, and error handling best practices to ensure established conventions are followed.

Does Gleam code review require understanding the standard library?

Yes, effective Gleam code review requires understanding the standard library and functional programming principles to accurately assess idiomatic patterns and suggest concrete examples for improving code structure.

What is the best way to refactor Gleam code for better readability?

The best way to refactor Gleam code for readability is to review it for idiomatic patterns, focusing on function design and error handling, and apply concrete suggestions to improve code structure and maintainability.