Basic `om show` - Githubissues

juspay / omnix

🚧 A Nix wrapper to improve developer experience

https://omnix.page

GNU Affero General Public License v3.0

64 stars 4 forks source link

Basic `om show` #147

Closed srid closed 1 month ago

srid commented 1 month ago

Goal

om show's goal: enable anyone (engineer to CEO) to "inspect" a project, and start interacting with it immediately.

What

Make the om show command render the information returned by nix flake show --json | jq but nicely.

Display the following:

meta.description of derivations
Tangentially related (for future work?): #97

[!note] For this task, begin with implementing basic functionality. We can improve om show in subsequent PRs over time.

Open questions:

How well can we present the information?
- Tabular form?
- Tips? For e.g., telling user to run nix develop .#foo to launch the foo devShell. Same for checks, packages.
- Running services: how do we treat process-compose groups in special manner? (Could happen in a different PR of course, but worth thinking ahead now)

Implementation considerations:

Put common functionality in omnix crate, so it can be used by omnix-gui later on
- Consider moving existing code from omnix-gui to omnix if necessary (refactoring omnix-gui in the process)

Test on

om show github:nammayatri/nammayatri
om show github:juspay/omnix
om show github:srid/nixos-config

srid commented 1 month ago

(Just pushed some commits to main, so as to sort out the common stuff)