f9ed1bf2c9
Typescript's type aliases (`type X = thing`) can refer to basically
anything, which makes it hard to write an automatic document formatter
for them. Interfaces on the other hand are only object, so they play
much nicer with docs. Currently, object-flavoured type aliases don't
really get expanded at all on our docs site, which means we have a bunch
of docs content that's not shown on the site.
This diff introduces a lint rule that forces `interface X {foo: bar}`s
instead of `type X = {foo: bar}` where possible, as it results in a much
better documentation experience:
Before:
<img width="437" alt="Screenshot 2024-05-22 at 15 24 13"
src="https://github.com/tldraw/tldraw/assets/1489520/32606fd1-6832-4a1e-aa5f-f0534d160c92">
After:
<img width="431" alt="Screenshot 2024-05-22 at 15 33 01"
src="https://github.com/tldraw/tldraw/assets/1489520/4e0d59ee-c38e-4056-b9fd-6a7f15d28f0f">
### Change Type
- [x] `sdk` — Changes the tldraw SDK
- [x] `docs` — Changes to the documentation, examples, or templates.
- [x] `improvement` — Improving existing features
76 lines
1.9 KiB
TypeScript
76 lines
1.9 KiB
TypeScript
import { execFile } from 'child_process'
|
|
import { nicelog } from './nicelog'
|
|
|
|
interface ExecOpts {
|
|
pwd?: string
|
|
processStdoutLine?: (line: string) => void
|
|
processStderrLine?: (line: string) => void
|
|
env?: Partial<NodeJS.ProcessEnv>
|
|
}
|
|
|
|
export function prefixOutput(prefix: string) {
|
|
return {
|
|
processStdoutLine: (line: string) => process.stdout.write(`${prefix}${line}\n`),
|
|
processStderrLine: (line: string) => process.stderr.write(`${prefix}${line}\n`),
|
|
}
|
|
}
|
|
|
|
export async function exec(
|
|
command: string,
|
|
args: (string | null)[],
|
|
{
|
|
pwd = process.cwd(),
|
|
processStdoutLine = (line) => process.stdout.write(`${line}\n`),
|
|
processStderrLine = (line) => process.stderr.write(`${line}\n`),
|
|
env,
|
|
}: ExecOpts = {}
|
|
): Promise<string> {
|
|
nicelog(`> $ ${command} ${args.join(' ')} (in ${pwd}))`)
|
|
return new Promise((resolve, reject) => {
|
|
const data: string[] = []
|
|
|
|
const childProcess = execFile(
|
|
command,
|
|
args.filter((arg): arg is string => !!arg),
|
|
{ cwd: pwd, env: { ...process.env, ...env } },
|
|
(err) => {
|
|
if (err) reject(err)
|
|
else resolve(data.join(''))
|
|
}
|
|
)
|
|
|
|
let pendingStdoutLine = ''
|
|
childProcess.stdout!.on('data', (chunk) => {
|
|
const chunkString: string = chunk.toString('utf-8')
|
|
data.push(chunkString)
|
|
|
|
const lines = chunkString.split('\n')
|
|
lines[0] = pendingStdoutLine + lines[0]
|
|
pendingStdoutLine = lines.pop() ?? ''
|
|
|
|
for (const line of lines) {
|
|
processStdoutLine(line)
|
|
}
|
|
})
|
|
childProcess.stdout!.on('close', () => {
|
|
processStdoutLine(pendingStdoutLine)
|
|
})
|
|
|
|
let pendingStderrLine = ''
|
|
childProcess.stderr!.on('data', (chunk) => {
|
|
const chunkString: string = chunk.toString('utf-8')
|
|
data.push(chunkString)
|
|
|
|
const lines = chunkString.split('\n')
|
|
lines[0] = pendingStderrLine + lines[0]
|
|
pendingStderrLine = lines.pop() ?? ''
|
|
|
|
for (const line of lines) {
|
|
processStderrLine(line)
|
|
}
|
|
})
|
|
childProcess.stderr!.on('close', () => {
|
|
processStderrLine(pendingStderrLine)
|
|
})
|
|
})
|
|
}
|