|
| 1 | +import {expectError, expectAssignable, expectNotAssignable} from 'tsd'; |
| 2 | +import { |
| 3 | + execa, |
| 4 | + execaSync, |
| 5 | + type StdinOption, |
| 6 | + type StdinSyncOption, |
| 7 | + type StdoutStderrOption, |
| 8 | + type StdoutStderrSyncOption, |
| 9 | +} from '../../../index.js'; |
| 10 | + |
| 11 | +// With `binary: true`, the `chunk` argument is an `Uint8Array`. |
| 12 | +const uint8ArrayBinary = { |
| 13 | + * transform(chunk: Uint8Array) { |
| 14 | + yield chunk; |
| 15 | + }, |
| 16 | + binary: true, |
| 17 | +} as const; |
| 18 | + |
| 19 | +await execa('unicorns', {stdin: uint8ArrayBinary}); |
| 20 | +execaSync('unicorns', {stdin: uint8ArrayBinary}); |
| 21 | +await execa('unicorns', {stdin: [uint8ArrayBinary]}); |
| 22 | +execaSync('unicorns', {stdin: [uint8ArrayBinary]}); |
| 23 | +await execa('unicorns', {stdout: uint8ArrayBinary}); |
| 24 | +execaSync('unicorns', {stdout: uint8ArrayBinary}); |
| 25 | +await execa('unicorns', {stderr: uint8ArrayBinary}); |
| 26 | +execaSync('unicorns', {stderr: uint8ArrayBinary}); |
| 27 | +await execa('unicorns', {stdio: ['pipe', 'pipe', 'pipe', uint8ArrayBinary]}); |
| 28 | + |
| 29 | +expectAssignable<StdinOption>(uint8ArrayBinary); |
| 30 | +expectAssignable<StdinSyncOption>(uint8ArrayBinary); |
| 31 | +expectAssignable<StdinOption>([uint8ArrayBinary]); |
| 32 | +expectAssignable<StdinSyncOption>([uint8ArrayBinary]); |
| 33 | +expectAssignable<StdoutStderrOption>(uint8ArrayBinary); |
| 34 | +expectAssignable<StdoutStderrSyncOption>(uint8ArrayBinary); |
| 35 | +expectAssignable<StdoutStderrOption>([uint8ArrayBinary]); |
| 36 | +expectAssignable<StdoutStderrSyncOption>([uint8ArrayBinary]); |
| 37 | + |
| 38 | +// `objectMode: true` takes precedence over `binary: true` for stdin, so the `chunk` argument is `unknown`. |
| 39 | +const uint8ArrayBinaryObjectMode = { |
| 40 | + * transform(chunk: Uint8Array) { |
| 41 | + yield chunk; |
| 42 | + }, |
| 43 | + binary: true, |
| 44 | + objectMode: true, |
| 45 | +} as const; |
| 46 | + |
| 47 | +const stdinObjectModeBinary = { |
| 48 | + * transform(chunk: unknown) { |
| 49 | + yield chunk; |
| 50 | + }, |
| 51 | + binary: true, |
| 52 | + objectMode: true, |
| 53 | +} as const; |
| 54 | + |
| 55 | +expectError(await execa('unicorns', {stdin: uint8ArrayBinaryObjectMode})); |
| 56 | +expectError(execaSync('unicorns', {stdin: uint8ArrayBinaryObjectMode})); |
| 57 | +await execa('unicorns', {stdout: uint8ArrayBinaryObjectMode}); |
| 58 | +execaSync('unicorns', {stdout: uint8ArrayBinaryObjectMode}); |
| 59 | +await execa('unicorns', {stderr: uint8ArrayBinaryObjectMode}); |
| 60 | +execaSync('unicorns', {stderr: uint8ArrayBinaryObjectMode}); |
| 61 | + |
| 62 | +await execa('unicorns', {stdin: stdinObjectModeBinary}); |
| 63 | +execaSync('unicorns', {stdin: stdinObjectModeBinary}); |
| 64 | + |
| 65 | +expectNotAssignable<StdinOption>(uint8ArrayBinaryObjectMode); |
| 66 | +expectNotAssignable<StdinSyncOption>(uint8ArrayBinaryObjectMode); |
| 67 | +expectAssignable<StdoutStderrOption>(uint8ArrayBinaryObjectMode); |
| 68 | +expectAssignable<StdoutStderrSyncOption>(uint8ArrayBinaryObjectMode); |
| 69 | +expectAssignable<StdinOption>(stdinObjectModeBinary); |
| 70 | +expectAssignable<StdinSyncOption>(stdinObjectModeBinary); |
| 71 | + |
| 72 | +const stdoutAnnotatedBinaryObjectMode: StdoutStderrOption = { |
| 73 | + * transform(chunk: Uint8Array) { |
| 74 | + yield chunk; |
| 75 | + }, |
| 76 | + binary: true, |
| 77 | + objectMode: true, |
| 78 | +}; |
| 79 | + |
| 80 | +expectAssignable<StdoutStderrOption>(stdoutAnnotatedBinaryObjectMode); |
| 81 | + |
| 82 | +// A `string` argument is invalid when `binary: true`. |
| 83 | +const stringBinary = { |
| 84 | + * transform(line: string) { |
| 85 | + yield line; |
| 86 | + }, |
| 87 | + binary: true, |
| 88 | +} as const; |
| 89 | + |
| 90 | +const stringBinaryObjectMode = { |
| 91 | + * transform(line: string) { |
| 92 | + yield line; |
| 93 | + }, |
| 94 | + binary: true, |
| 95 | + objectMode: true, |
| 96 | +} as const; |
| 97 | + |
| 98 | +expectError(await execa('unicorns', {stdin: stringBinary})); |
| 99 | +expectError(execaSync('unicorns', {stdin: stringBinary})); |
| 100 | +expectError(await execa('unicorns', {stdin: [stringBinary]})); |
| 101 | +expectError(execaSync('unicorns', {stdin: [stringBinary]})); |
| 102 | +expectError(await execa('unicorns', {stdout: stringBinary})); |
| 103 | +expectError(execaSync('unicorns', {stdout: stringBinary})); |
| 104 | +expectError(await execa('unicorns', {stderr: stringBinary})); |
| 105 | +expectError(execaSync('unicorns', {stderr: stringBinary})); |
| 106 | +expectError(await execa('unicorns', {stdio: ['pipe', 'pipe', 'pipe', stringBinary]})); |
| 107 | +expectError(await execa('unicorns', {stdout: stringBinaryObjectMode})); |
| 108 | +expectError(execaSync('unicorns', {stdout: stringBinaryObjectMode})); |
| 109 | +expectError(await execa('unicorns', {stderr: stringBinaryObjectMode})); |
| 110 | +expectError(execaSync('unicorns', {stderr: stringBinaryObjectMode})); |
| 111 | + |
| 112 | +expectNotAssignable<StdinOption>(stringBinary); |
| 113 | +expectNotAssignable<StdinSyncOption>(stringBinary); |
| 114 | +expectNotAssignable<StdinOption>([stringBinary]); |
| 115 | +expectNotAssignable<StdinSyncOption>([stringBinary]); |
| 116 | +expectNotAssignable<StdoutStderrOption>(stringBinary); |
| 117 | +expectNotAssignable<StdoutStderrSyncOption>(stringBinary); |
| 118 | +expectNotAssignable<StdoutStderrOption>([stringBinary]); |
| 119 | +expectNotAssignable<StdoutStderrSyncOption>([stringBinary]); |
| 120 | +expectNotAssignable<StdoutStderrOption>(stringBinaryObjectMode); |
| 121 | +expectNotAssignable<StdoutStderrSyncOption>(stringBinaryObjectMode); |
| 122 | + |
| 123 | +// An `Uint8Array` argument is invalid without `binary: true`, since the `chunk` is then a `string`. |
| 124 | +const uint8ArrayLine = { |
| 125 | + * transform(chunk: Uint8Array) { |
| 126 | + yield chunk; |
| 127 | + }, |
| 128 | +} as const; |
| 129 | + |
| 130 | +expectError(await execa('unicorns', {stdin: uint8ArrayLine})); |
| 131 | +expectError(execaSync('unicorns', {stdin: uint8ArrayLine})); |
| 132 | +expectError(await execa('unicorns', {stdin: [uint8ArrayLine]})); |
| 133 | +expectError(execaSync('unicorns', {stdin: [uint8ArrayLine]})); |
| 134 | +expectError(await execa('unicorns', {stdout: uint8ArrayLine})); |
| 135 | +expectError(execaSync('unicorns', {stdout: uint8ArrayLine})); |
| 136 | +expectError(await execa('unicorns', {stderr: uint8ArrayLine})); |
| 137 | +expectError(execaSync('unicorns', {stderr: uint8ArrayLine})); |
| 138 | +expectError(await execa('unicorns', {stdio: ['pipe', 'pipe', 'pipe', uint8ArrayLine]})); |
| 139 | + |
| 140 | +expectNotAssignable<StdinOption>(uint8ArrayLine); |
| 141 | +expectNotAssignable<StdinSyncOption>(uint8ArrayLine); |
| 142 | +expectNotAssignable<StdinOption>([uint8ArrayLine]); |
| 143 | +expectNotAssignable<StdinSyncOption>([uint8ArrayLine]); |
| 144 | +expectNotAssignable<StdoutStderrOption>(uint8ArrayLine); |
| 145 | +expectNotAssignable<StdoutStderrSyncOption>(uint8ArrayLine); |
| 146 | +expectNotAssignable<StdoutStderrOption>([uint8ArrayLine]); |
| 147 | +expectNotAssignable<StdoutStderrSyncOption>([uint8ArrayLine]); |
| 148 | + |
| 149 | +// Binary encodings also make output transforms receive binary chunks. |
| 150 | +await execa('unicorns', {encoding: 'buffer', stdin: uint8ArrayLine}); |
| 151 | +execaSync('unicorns', {encoding: 'buffer', stdin: uint8ArrayLine}); |
| 152 | +await execa('unicorns', {encoding: 'buffer', stdout: uint8ArrayLine}); |
| 153 | +execaSync('unicorns', {encoding: 'buffer', stdout: uint8ArrayLine}); |
| 154 | +await execa('unicorns', {encoding: 'buffer', stderr: uint8ArrayLine}); |
| 155 | +execaSync('unicorns', {encoding: 'buffer', stderr: uint8ArrayLine}); |
| 156 | +await execa('unicorns', {encoding: 'buffer', stdio: [uint8ArrayLine, uint8ArrayLine, uint8ArrayLine, uint8ArrayLine]}); |
| 157 | +execaSync('unicorns', {encoding: 'buffer', stdio: [uint8ArrayLine, uint8ArrayLine, uint8ArrayLine, uint8ArrayLine]}); |
| 158 | + |
| 159 | +// A bare generator function always receives string lines unless `encoding` is binary. |
| 160 | +const uint8ArrayGenerator = function * (chunk: Uint8Array) { |
| 161 | + yield chunk; |
| 162 | +}; |
| 163 | + |
| 164 | +expectError(await execa('unicorns', {stdin: uint8ArrayGenerator})); |
| 165 | +expectError(execaSync('unicorns', {stdin: uint8ArrayGenerator})); |
| 166 | +expectError(await execa('unicorns', {stdout: uint8ArrayGenerator})); |
| 167 | +expectError(execaSync('unicorns', {stdout: uint8ArrayGenerator})); |
| 168 | +expectError(await execa('unicorns', {stderr: uint8ArrayGenerator})); |
| 169 | +expectError(execaSync('unicorns', {stderr: uint8ArrayGenerator})); |
| 170 | +expectError(await execa('unicorns', {stdio: ['pipe', 'pipe', 'pipe', uint8ArrayGenerator]})); |
| 171 | + |
| 172 | +expectNotAssignable<StdinOption>(uint8ArrayGenerator); |
| 173 | +expectNotAssignable<StdinSyncOption>(uint8ArrayGenerator); |
| 174 | +expectNotAssignable<StdoutStderrOption>(uint8ArrayGenerator); |
| 175 | +expectNotAssignable<StdoutStderrSyncOption>(uint8ArrayGenerator); |
| 176 | + |
| 177 | +await execa('unicorns', {encoding: 'buffer', stdin: uint8ArrayGenerator}); |
| 178 | +execaSync('unicorns', {encoding: 'buffer', stdin: uint8ArrayGenerator}); |
| 179 | +await execa('unicorns', {encoding: 'buffer', stdout: uint8ArrayGenerator}); |
| 180 | +execaSync('unicorns', {encoding: 'buffer', stdout: uint8ArrayGenerator}); |
| 181 | +await execa('unicorns', {encoding: 'buffer', stderr: uint8ArrayGenerator}); |
| 182 | +execaSync('unicorns', {encoding: 'buffer', stderr: uint8ArrayGenerator}); |
| 183 | +await execa('unicorns', {encoding: 'buffer', stdio: [uint8ArrayGenerator, uint8ArrayGenerator, uint8ArrayGenerator, uint8ArrayGenerator]}); |
| 184 | +execaSync('unicorns', {encoding: 'buffer', stdio: [uint8ArrayGenerator, uint8ArrayGenerator, uint8ArrayGenerator, uint8ArrayGenerator]}); |
| 185 | + |
| 186 | +// Conversely, a binary `encoding` makes the `chunk` a `Uint8Array`, so a `string` transform is rejected. |
| 187 | +const stringGenerator = function * (line: string) { |
| 188 | + yield line; |
| 189 | +}; |
| 190 | + |
| 191 | +expectError(await execa('unicorns', {encoding: 'buffer', stdin: stringGenerator})); |
| 192 | +expectError(execaSync('unicorns', {encoding: 'buffer', stdin: stringGenerator})); |
| 193 | +expectError(await execa('unicorns', {encoding: 'buffer', stdout: stringGenerator})); |
| 194 | +expectError(execaSync('unicorns', {encoding: 'buffer', stdout: stringGenerator})); |
| 195 | + |
| 196 | +// This applies to every binary `encoding`, not just `'buffer'`. |
| 197 | +await execa('unicorns', {encoding: 'hex', stdout: uint8ArrayGenerator}); |
| 198 | +execaSync('unicorns', {encoding: 'hex', stdout: uint8ArrayGenerator}); |
| 199 | +await execa('unicorns', {encoding: 'base64', stdout: uint8ArrayGenerator}); |
| 200 | +execaSync('unicorns', {encoding: 'base64', stdout: uint8ArrayGenerator}); |
| 201 | +expectError(await execa('unicorns', {encoding: 'hex', stdout: stringGenerator})); |
| 202 | +expectError(execaSync('unicorns', {encoding: 'hex', stdout: stringGenerator})); |
0 commit comments