coala / coala/projects

Project Proposal: More Interactive CLIs

Open
#708 1 comment 0 reactions 0 assignees View on GitHub
Project Proposal
Dominant language
JavaScript
Stars
118
Forks
225
PR merge metrics
No merged PRs in 30d

Description

Currently, all the coala CLI interactions occur through numeric inputs which is very slow and cumbersome in most cases. This can be improved greatly by building more interactive CLIs using tools like [PyInquirer](https://github.com/CITGuru/PyInquirer). We have a lot of areas where the CLI can be improved.

For example we can use:
- the [checkbox question type](https://github.com/CITGuru/PyInquirer#checkbox---type-checkbox) for coala-quickstart.
- the [checkbox question type](https://github.com/CITGuru/PyInquirer#checkbox---type-checkbox) again when we run `coala`.

Apart from replacing number based inputs, we can:
- add auto-complete in prompting for bears in both `coala` and `coala-quickstart`.
- add a fuzzy finder like in `git` when we enter an invalid option to the CLI.

This could be a GSoC size project once all the potential areas of implementation are identified.

**Note**: If you're not familiar with using such CLIs, checkout:
- npm/yarn
- eslint CLI - `eslint --init`

Contributor guide

No contributing guide indexed for this repository

Research direction

No implementation files or tests are named. Start by inventorying the CLI entry points for coala and coala-quickstart, then review the existing numeric prompts and the PyInquirer examples linked in the issue. Done means the potential interaction areas are identified and the scope for checkboxes, autocomplete, and invalid-option search is agreed.

Written by the indexing model from the issue text.

Assessment

Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.