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]
52 lines
1.3 KiB
TypeScript
52 lines
1.3 KiB
TypeScript
import fs from 'fs'
|
|
import { Octokit } from 'octokit'
|
|
import path from 'path'
|
|
import { TLDRAW_PACKAGES_TO_INCLUDE_IN_DOCS } from './package-list'
|
|
|
|
const octokit = new Octokit({
|
|
auth: process.env.GITHUB_ACCESS_TOKEN,
|
|
})
|
|
|
|
const { log: nicelog } = console
|
|
|
|
export async function fetchApiSource() {
|
|
try {
|
|
const API_DIRECTORY = path.join(process.cwd(), 'api')
|
|
|
|
if (fs.existsSync(API_DIRECTORY)) {
|
|
fs.rmSync(API_DIRECTORY, { recursive: true })
|
|
}
|
|
|
|
fs.mkdirSync(API_DIRECTORY)
|
|
|
|
for (const folderName of TLDRAW_PACKAGES_TO_INCLUDE_IN_DOCS) {
|
|
const filePath = path.join(API_DIRECTORY, folderName + '.api.json')
|
|
|
|
nicelog(`• Fetching API for ${folderName}...`)
|
|
|
|
const res = await octokit.request('GET /repos/{owner}/{repo}/contents/{path}', {
|
|
owner: 'tldraw',
|
|
repo: 'tldraw',
|
|
path: `packages/${folderName}/api/api.json`,
|
|
branch: process.env.SOURCE_SHA || 'main',
|
|
headers: {
|
|
'X-GitHub-Api-Version': '2022-11-28',
|
|
accept: 'application/vnd.github.VERSION.raw',
|
|
},
|
|
})
|
|
|
|
if (res.status === 200) {
|
|
nicelog(`• Writing ${filePath}...`)
|
|
fs.writeFileSync(filePath, (res as any).data)
|
|
} else {
|
|
throw Error(`x Could not get API for ${folderName}.`)
|
|
}
|
|
}
|
|
|
|
nicelog('✔ Complete!')
|
|
} catch (error) {
|
|
nicelog(`x Could not generate site content.`)
|
|
|
|
throw error
|
|
}
|
|
}
|