nushell / nushell/nufmt

Expose project as https://pre-commit.com/ hook

Open Beginner friendly
#218 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
230
Forks
40
Avg merge
15h 30m
Merged PRs (30d)
1

Description

Describe the solution you'd like
Please describe the desired behavior.

Add a .pre-commit-hooks.yaml file to the project to let other projects easily
configure a pre-commit hook to format their nushell files with nufmt.

Describe alternatives you've considered
Please describe alternative solutions or features you have considered.

Right now I manually have a local system hook that i paste into my projects that have Nushell code and use pre-commit.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the requested .pre-commit-hooks.yaml file and review the linked pre-commit hook authoring guidance. Define the hook so other projects can invoke nufmt to format Nushell files, then verify that the configuration is complete and usable by a pre-commit consumer.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.