4f70a4f4e8
Describe what your pull request does. If appropriate, add GIFs or images showing the before and after. ### Change Type - [x] `sdk` — Changes the tldraw SDK - [x] `galaxy brain` — Architectural changes ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [ ] Unit Tests - [ ] End to end tests ### Release Notes #### BREAKING CHANGES - The `Migrations` type is now called `LegacyMigrations`. - The serialized schema format (e.g. returned by `StoreSchema.serialize()` and `Store.getSnapshot()`) has changed. You don't need to do anything about it unless you were reading data directly from the schema for some reason. In which case it'd be best to avoid that in the future! We have no plans to change the schema format again (this time was traumatic enough) but you never know. - `compareRecordVersions` and the `RecordVersion` type have both disappeared. There is no replacement. These were public by mistake anyway, so hopefully nobody had been using it. - `compareSchemas` is a bit less useful now. Our migrations system has become a little fuzzy to allow for simpler UX when adding/removing custom extensions and 3rd party dependencies, and as a result we can no longer compare serialized schemas in any rigorous manner. You can rely on this function to return `0` if the schemas are the same. Otherwise it will return `-1` if the schema on the right _seems_ to be newer than the schema on the left, but it cannot guarantee that in situations where migration sequences have been removed over time (e.g. if you remove one of the builtin tldraw shapes). Generally speaking, the best way to check schema compatibility now is to call `store.schema.getMigrationsSince(persistedSchema)`. This will throw an error if there is no upgrade path from the `persistedSchema` to the current version. - `defineMigrations` has been deprecated and will be removed in a future release. For upgrade instructions see https://tldraw.dev/docs/persistence#Updating-legacy-shape-migrations-defineMigrations - `migrate` has been removed. Nobody should have been using this but if you were you'll need to find an alternative. For migrating tldraw data, you should stick to using `schema.migrateStoreSnapshot` and, if you are building a nuanced sync engine that supports some amount of backwards compatibility, also feel free to use `schema.migratePersistedRecord`. - the `Migration` type has changed. If you need the old one for some reason it has been renamed to `LegacyMigration`. It will be removed in a future release. - the `Migrations` type has been renamed to `LegacyMigrations` and will be removed in a future release. - the `SerializedSchema` type has been augmented. If you need the old version specifically you can use `SerializedSchemaV1` --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
36 lines
1 KiB
TypeScript
36 lines
1 KiB
TypeScript
import { namedTypes } from 'ast-types'
|
|
import { readFileSync, writeFileSync } from 'fs'
|
|
import glob from 'glob'
|
|
import path from 'path'
|
|
import { parse, print, visit } from 'recast'
|
|
|
|
export function sortUnions(tsbuildDir: string) {
|
|
for (const file of glob.sync(path.join(tsbuildDir, '**/*.d.ts'))) {
|
|
const code = parse(readFileSync(file, 'utf8'), { parser: require('recast/parsers/typescript') })
|
|
|
|
visit(code, {
|
|
visitTSUnionType(path) {
|
|
this.traverse(path)
|
|
const val = path.value as namedTypes.TSUnionType
|
|
val.types = val.types.sort((a, b) => {
|
|
const aText = print(a).code
|
|
const bText = print(b).code
|
|
return aText.localeCompare(bText)
|
|
})
|
|
return false
|
|
},
|
|
visitTSTypeLiteral(path) {
|
|
this.traverse(path)
|
|
const val = path.value as namedTypes.TSTypeLiteral
|
|
val.members = val.members.sort((a, b) => {
|
|
const aText = print(a).code
|
|
const bText = print(b).code
|
|
return aText.localeCompare(bText)
|
|
})
|
|
return false
|
|
},
|
|
})
|
|
|
|
writeFileSync(file, print(code).code)
|
|
}
|
|
}
|