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
54 lines
1.5 KiB
TypeScript
54 lines
1.5 KiB
TypeScript
import glob from 'glob'
|
|
import path from 'path'
|
|
import { REPO_ROOT, readJsonIfExists } from './file'
|
|
|
|
export type PackageJson = { name: string; private?: boolean; workspaces?: string[] } & Record<
|
|
string,
|
|
any
|
|
>
|
|
export interface Package {
|
|
packageJson: PackageJson
|
|
relativePath: string
|
|
path: string
|
|
name: string
|
|
}
|
|
|
|
async function readPackage(packageJsonFile: string): Promise<Package> {
|
|
const packageJsonPath = path.resolve(packageJsonFile)
|
|
const packageJson = await readJsonIfExists(packageJsonFile)
|
|
if (!packageJson) {
|
|
throw new Error(`No package.json found at ${packageJsonPath}`)
|
|
}
|
|
|
|
const packagePath = path.dirname(packageJsonPath)
|
|
|
|
return {
|
|
packageJson,
|
|
relativePath: path.relative(REPO_ROOT, packagePath),
|
|
path: packagePath,
|
|
name: packageJson.name,
|
|
}
|
|
}
|
|
|
|
async function getChildWorkspaces(parent: Package): Promise<Package[]> {
|
|
if (!parent.packageJson.workspaces) return []
|
|
|
|
const foundPackages = []
|
|
for (const workspace of parent.packageJson.workspaces) {
|
|
const workspacePath = path.join(parent.path, workspace)
|
|
for (const packageJsonFilePath of glob.sync(path.join(workspacePath, 'package.json'))) {
|
|
const child = await readPackage(packageJsonFilePath)
|
|
foundPackages.push(child)
|
|
if (child.packageJson.workspaces) {
|
|
foundPackages.push(...(await getChildWorkspaces(child)))
|
|
}
|
|
}
|
|
}
|
|
|
|
return foundPackages
|
|
}
|
|
|
|
export async function getAllWorkspacePackages() {
|
|
const rootWorkspace = await readPackage(path.join(REPO_ROOT, 'package.json'))
|
|
return await getChildWorkspaces(rootWorkspace)
|
|
}
|