tldraw/apps/docs/utils/autoLinkDocs.ts
Steve Ruiz 29044867dd
Add docs (#2470)
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]
2024-01-15 12:33:15 +00:00

55 lines
1.8 KiB
TypeScript

/* eslint-disable no-useless-escape */
import { Article } from '@/types/content-types'
import { Database } from 'sqlite'
import sqlite3 from 'sqlite3'
export async function autoLinkDocs(db: Database<sqlite3.Database, sqlite3.Statement>) {
// replace [TLEditor](?) with [TLEditor](/gen/editor/TLEditor)?
// not sure how we would get there but finding an article with the same title
const articles = await db.all('SELECT id, content FROM articles WHERE sectionId != ?', 'gen')
await Promise.all(articles.map((a) => autoLinkDocsForArticle(db, a)))
}
const regex = /\[([^\[\]]*?)\]\(\?\)/g
export async function autoLinkDocsForArticle(
db: Database<sqlite3.Database, sqlite3.Statement>,
{ id, content }: Pick<Article, 'id' | 'content'>
) {
if (!content) return
let didChange = false
let result = content
const matches = content.matchAll(regex)
if (!matches) return
for (const match of Array.from(matches)) {
const [hit, _title] = match
const [title, heading] = _title.split('#')
const article = await db.get(
'SELECT id, sectionId, categoryId FROM articles WHERE title = ? AND sectionId = ?',
title,
'gen'
)
if (!article) throw Error(`Could not find article for ${_title} (${title})`)
let str = ''
if (heading) {
const headingRow = await db.get('SELECT slug FROM headings WHERE slug = ?', heading)
if (!headingRow) throw Error(`Could not find heading for ${_title} (${heading})`)
str = `[\`${title}.${heading}\`](/${article.sectionId}/${article.categoryId}/${article.id}#${headingRow.slug})`
} else {
str = `[\`${title}\`](/${article.sectionId}/${article.categoryId}/${article.id})`
}
result = result.replaceAll(hit, str)
didChange = true
}
if (didChange) {
await db.run('UPDATE articles SET content = ? WHERE id = ?', result, id)
}
}