jashkenas/coffeescript

Proposal: multiline should be documented inside REPL

Open

#5,114 opened on Oct 1, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)CoffeeScript (16,577 stars) (1,980 forks)batch import
enhancementhelp wanted

Description

I eventually found the Ctrl-V answer in StackOverflow, but not before I'd used the REPL for about 2 weeks thinking that multiline was broken in the REPL. Also, while StackOverflow told me to use Ctrl-V to enter multiline mode, it didn't mention to use that keycode to exit. So, as a Unix user, I hit Ctrl-D and the REPL quit. It would be nice if the REPL told people about Ctrl-V to enter and exit multiline mode. Also, it would be nice if it told people about .help.

CoffeeScript version 2.3.1 Node v10.4.0

Contributor guide

Tech stack
None
Domain
clidocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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.
clear
Prerequisites
CoffeeScript REPL usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requests adding a help message to the CoffeeScript REPL that informs users about Ctrl+V for multiline entry/exit and the .help command. The implementation involves modifying the REPL source code, likely in `lib/coffee script/repl.js`, to display this information on startup or via a .help command. Refer to Node.js REPL implementation patterns for guidance.
Proposal: multiline should be documented inside REPL · jashkenas/coffeescript#5114 | Good First Issue