29044867dd
This PR adds the docs app back into the tldraw monorepo. ## Deploying We'll want to update our deploy script to update the SOURCE_SHA to the newest release sha... and then deploy the docs pulling api.json files from that release. We _could_ update the docs on every push to main, but we don't have to unless something has changed. Right now there's no automated deployments from this repo. ## Side effects To make this one work, I needed to update the lock file. This might be ok (new year new lock file), and everything builds as expected, though we may want to spend some time with our scripts to be sure that things are all good. I also updated our prettier installation, which decided to add trailing commas to every generic type. Which is, I suppose, [correct behavior](https://github.com/prettier/prettier-vscode/issues/955)? But that caused diffs in every file, which is unfortunate. ### Change Type - [x] `internal` — Any other changes that don't affect the published package[^2]
88 lines
2.4 KiB
TypeScript
88 lines
2.4 KiB
TypeScript
import { readFile, writeFile as writeFileUnchecked } from 'fs/promises'
|
|
import json5 from 'json5'
|
|
import { basename, dirname, join, relative } from 'path'
|
|
import prettier from 'prettier'
|
|
import { fileURLToPath } from 'url'
|
|
import { nicelog } from './nicelog'
|
|
|
|
const __filename = fileURLToPath(import.meta.url)
|
|
const __dirname = dirname(__filename)
|
|
const isBublic = basename(join(__dirname, '../..')) === 'bublic'
|
|
export const REPO_ROOT = join(__dirname, isBublic ? '../../../' : '../..')
|
|
export const BUBLIC_ROOT = join(__dirname, '../..')
|
|
|
|
export async function readJsonIfExists(file: string) {
|
|
const fileContents = await readFileIfExists(file)
|
|
if (fileContents === null) {
|
|
return null
|
|
}
|
|
return json5.parse(fileContents)
|
|
}
|
|
|
|
export async function readFileIfExists(file: string) {
|
|
try {
|
|
return await readFile(file, 'utf8')
|
|
} catch {
|
|
return null
|
|
}
|
|
}
|
|
|
|
const prettierConfigPromise = prettier.resolveConfig(__dirname)
|
|
export async function writeCodeFile(
|
|
generator: string,
|
|
language: 'typescript' | 'javascript',
|
|
filePath: string,
|
|
code: string
|
|
) {
|
|
const formattedCode = await prettier.format(
|
|
`
|
|
// This file is automatically generated by ${generator}.
|
|
// Do not edit manually.
|
|
|
|
${code}
|
|
`,
|
|
{
|
|
...(await prettierConfigPromise),
|
|
parser: language === 'typescript' ? 'typescript' : 'babel',
|
|
}
|
|
)
|
|
await writeStringFile(filePath, formattedCode)
|
|
}
|
|
|
|
export async function writeStringFile(filePath: string, contents: string) {
|
|
await writeFile(filePath, Buffer.from(contents, 'utf-8'))
|
|
}
|
|
|
|
export async function writeFile(filePath: string, contents: Buffer) {
|
|
if (process.env.CI) {
|
|
let existingContents: Buffer | null = null
|
|
try {
|
|
existingContents = await readFile(filePath)
|
|
} catch {
|
|
// Ignore
|
|
}
|
|
if (existingContents && !existingContents.equals(contents)) {
|
|
nicelog(
|
|
`Asset file ${relative(
|
|
REPO_ROOT,
|
|
filePath
|
|
)} has changed. Please run this script again and commit the changes.`
|
|
)
|
|
nicelog('Contents before:')
|
|
nicelog(existingContents.toString('utf-8'))
|
|
nicelog('\nContents after:')
|
|
nicelog(contents.toString('utf-8'))
|
|
|
|
process.exit(1)
|
|
}
|
|
}
|
|
await writeFileUnchecked(filePath, contents, 'utf-8')
|
|
}
|
|
|
|
export async function writeJsonFile(filePath: string, contents: unknown) {
|
|
const formattedJson = await prettier.format(JSON.stringify(contents, null, '\t'), {
|
|
...(await prettierConfigPromise),
|
|
parser: 'json',
|
|
})
|
|
await writeStringFile(filePath, formattedJson)
|
|
}
|