NixOS/nixfmt

Provide a GitHub Action

Open

#76 opened on Jan 20, 2021

View on GitHub
 (9 comments) (4 reactions) (0 assignees)Haskell (1,506 stars) (74 forks)batch import
enhancementgood first issue

Description

It'd be really great if I could hook up a GitHub Action with nixfmt so it provided annotations to the code about reformatting that needs doing.

Contributor guide

Tech stack
github actions
Domain
ci cddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GitHub ActionsNix language basicsYAML syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Review the existing comments on the issue to understand any specific requirements or constraints. Look at how similar formatting actions (e.g., for Rust's rustfmt or Python's black) are implemented as GitHub Actions. Consider using a Docker based action to run nixfmt directly, or a JavaScript action that invokes nixfmt via a subprocess. Ensure the action outputs annotations for files that need formatting.