sindresorhus/np

Use Ink for the initial UI

Open

#570 opened on Oct 11, 2020

View on GitHub
 (0 comments) (4 reactions) (0 assignees)JavaScript (7,314 stars) (349 forks)batch import
enhancementhelp wanted

Description

https://github.com/vadimdemedes/ink

It would give us more control of the UI and let us do even cooler things with interactivity.

We would still use listr for the actual progress output, unless someone ports listr to Ink.

Anyone that wants to tackle this should have a lot of experience with Node.js and React. It's not an easy issue.

Contributor guide

Tech stack
nodejsreact
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
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.
mostly clear
Prerequisites
Node.js experienceReact experience
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue proposes replacing the current UI with Ink for better interactivity. Investigate the Ink library (https://github.com/vadimdemedes/ink) and understand how to integrate it with the existing CLI structure of np. The current implementation uses listr for progress output; consider whether listr can be ported to Ink or if a separate solution is needed. Review the np codebase to identify where UI components are rendered and how Ink can be introduced without breaking existing functionality. No linked PRs or comments provide additional context.