Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nix flake show: add the description if it exists #10980

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kjeremy
Copy link

@kjeremy kjeremy commented Jun 27, 2024

Motivation

Displays the description of the package if it exists. This information is already present in the json output.

I have a flake with many packages and dev shells and this helps discoverability.

Context

#10977

Priorities and Process

Add 👍 to pull requests you find important.

The Nix maintainer team uses a GitHub project board to schedule and track reviews.

@kjeremy kjeremy requested a review from edolstra as a code owner June 27, 2024 19:42
@github-actions github-actions bot added the new-cli Relating to the "nix" command label Jun 27, 2024
@kjeremy
Copy link
Author

kjeremy commented Jul 1, 2024

This has been really helpful for my team. What do I need to do to get it merged?

@edolstra
Copy link
Member

edolstra commented Jul 1, 2024

The problem with showing descriptions in nix flake show is that they can be pretty long, which can break the tree output rendering (especially if they contain newlines).

@kjeremy
Copy link
Author

kjeremy commented Jul 1, 2024

@edolstra I can think of a few approaches:

  1. Strip newlines and maybe limit the length
  2. Fix the tree views to work with multiline output

I can tackle either one if I get some direction.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flakes new-cli Relating to the "nix" command
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants