sindresorhus/term-img

Support tmux

Open

#1 opened on Mar 20, 2016

View on GitHub
 (4 comments) (8 reactions) (0 assignees)JavaScript (318 stars) (12 forks)user submission
enhancementhelp wanted

Description

It requires some wrapper escape codes to please it.

https://raw.githubusercontent.com/gnachman/iTerm2/master/tests/imgcat

Specifically:

# tmux requires unrecognized OSC sequences to be wrapped with DCS tmux;
# <sequence> ST, and for all ESCs in <sequence> to be replaced with ESC ESC. It
# only accepts ESC backslash for ST.
function print_osc() {
    if [[ $TERM == screen* ]] ; then
        printf "\033Ptmux;\033\033]"
    else
        printf "\033]"
    fi
}

# More of the tmux workaround described above.
function print_st() {
    if [[ $TERM == screen* ]] ; then
        printf "\a\033\\"
    else
        printf "\a"
    fi
}

I will get to this eventually, but I don't use tmux, so not a priority. A pull request would be welcomed :)

Contributor guide

Tech stack
javascriptshell
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
JavaScript knowledgeTerminal escape codestmux basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Study the provided shell functions in the issue body and adapt them into the term img JavaScript code. Look at the existing image printing logic in the repository, likely in the main module file, to integrate the tmux detection and escape sequence wrapping. Review any comments on the issue for further guidance.