diffplug / diffplug/dormouse

dor send --stdin interprets backslash escapes in piped bytes

Abierto
#355 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
TypeScript
Estrellas
5
Forks
0
Merge medio
14 h 13 min
PR fusionados (30 d)
199

Descripción

## `dor send --stdin` interprets backslash escapes in piped bytes, corrupting the documented use case

`dor send --stdin` reads standard input and forwards it as a **text** input:

```ts
if (flags.stdin === true) {
if (!readStdin) return { ok: false, message: 'stdin is not available' };
return { ok: true, value: [{ kind: 'text', text: await readStdin() }] };
}
```
([send.ts:183-186](https://github.com/diffplug/dormouse/blob/a1782f19b7d8363997eb37c440d1cbc8dfe13829/dor/src/commands/send.ts#L183-L186))

Text inputs then run through `interpretTextEscapes` unless `--raw` is set:

```ts
input += raw ? item.text : interpretTextEscapes(item.text);
```
([send.ts:227-228](https://github.com/diffplug/dormouse/blob/a1782f19b7d8363997eb37c440d1cbc8dfe13829/dor/src/commands/send.ts#L227-L228), converting `\n \r \t \\` at [send.ts:238-253](https://github.com/diffplug/dormouse/blob/a1782f19b7d8363997eb37c440d1cbc8dfe13829/dor/src/commands/send.ts#L238-L253))

### Why this is a footgun for `--stdin`

The flagship stdin example in the help is:

```
cat script.sh | dor send surface:3 --stdin
```
([send.ts:115](https://github.com/diffplug/dormouse/blob/a1782f19b7d8363997eb37c440d1cbc8dfe13829/dor/src/commands/send.ts#L115))

Bytes arriving on stdin are already literal — they are not a shell-authored string where a two-character `\t` stands in for a tab. Shell scripts routinely contain literal backslash sequences (`printf 'a\tb'`, `sed 's/\n/ /'`, `grep -P '\d'`, Windows paths with `\\`). Piping such a file through `--stdin` silently rewrites every `\n`/`\r`/`\t`/`\\`, so the text typed into the target terminal is not the file's contents.

**Repro:** `printf 'printf "a\\tb\\n"\n' | dor send surface:3 --stdin` types a real TAB and newline into the middle of the line instead of the literal `\t`/`\n` the script source contains.

The escape interpretation is desirable for `--text "echo hi\nthere"` (a human types escapes on the command line), but for `--stdin` the input is already-real bytes.

### Design question (why an issue, not a drive-by PR)

The current behavior is *consistent with* the documented contract — the help says "Text input interprets backslash escapes … unless `--raw` is set" ([send.ts:97](https://github.com/diffplug/dormouse/blob/a1782f19b7d8363997eb37c440d1cbc8dfe13829/dor/src/commands/send.ts#L97)), and `--stdin` is documented as text input — so flipping the default is a contract change that needs a maintainer call. Options:

1. **Make `--stdin` raw by default** — treat piped bytes as literal; keep `--text` interpreting escapes. Most aligned with the `cat script.sh | …` example. Would need an opt-in flag if anyone wants escape interpretation on stdin.
2. **Keep current behavior, document it** — call out at the `--stdin` help that it interprets escapes and that `--raw` is needed for literal file contents.

I lean toward option 1, but it changes documented behavior, so I'm leaving the call to a maintainer. Happy to open the PR (including a regression test that pipes a script containing `\t` and asserts the bytes are preserved) once a direction is chosen.

Surfaced by the nightly code-quality survey.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Start in dor/src/commands/send.ts at the stdin handling and text escape conversion described in the issue. Confirm the current behavior with the documented piping example, then wait for the maintainer to choose between raw stdin by default and documenting the existing behavior. Done means the chosen contract is implemented or documented, with a regression test preserving the relevant bytes.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
cli
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
50/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.