web: support schema.rb for rendering ER diagrams #388
Conversation
🦋 Changeset detectedLatest commit: fe9aace The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
MH4GF
had a problem deploying
to
preview - @liam-hq/erd-sample
GitHub Actions
Failure
MH4GF
had a problem deploying
to
preview - erd-web
GitHub Actions
Failure
MH4GF
force-pushed
the
support-schema-rb-for-web
branch
from
ec06fa8 to
b67e2fe
Compare
MH4GF
force-pushed
the
support-schema-rb-for-web
branch
from
b67e2fe to
ee6fb21
Compare
MH4GF
force-pushed
the
support-schema-rb-for-web
branch
from
ee6fb21 to
8515134
Compare
MH4GF
changed the title
| "@liam-hq/db-structure": patch | ||
| --- | ||
|
|
||
| :sparkles: prism's wasm URL can now be overridden |
There was a problem hiding this comment.
📝 Only db-structure is bumped because it is not used in cli.
| @@ -23,8 +25,10 @@ export default async function Page({ | |||
|
|
|||
| const input = await res.text() | |||
|
|
|||
| // Currently supports Postgres only | |||
| const { value: dbStructure, errors } = await parse(input, 'postgres') | |||
| setPrismWasmUrl(path.resolve(process.cwd(), 'prism.wasm')) | |||
There was a problem hiding this comment.
process.cwd() gives the root path of Next.js.
By following the file from here, the wasm file can be accessed in the local environment as well as on Vercel.
ref: Reading files on Vercel during Next.js ISR | François Best
| // Currently supports schema.rb only | ||
| const { value: dbStructure, errors } = await parse(input, 'schemarb') |
There was a problem hiding this comment.
Temporarily changed to support only schema.rb.
I plan to create a PR to implement the format identification process after this.
| outputFileTracingIncludes: { | ||
| '/erd/p/\\[\\.\\.\\.slug\\]': ['./prism.wasm'], | ||
| }, |
There was a problem hiding this comment.
Define the file to be referenced from the request handler function corresponding to the path on Vercel.
| @@ -24,6 +24,7 @@ | |||
| "fmt:biome": "biome check --write --unsafe .", | |||
| "lint": "pnpm run '/^lint:.*/'", | |||
| "lint:biome": "biome check .", | |||
| "postinstall": "cp ../../packages/db-structure/src/parser/schemarb/prism.wasm prism.wasm", | |||
There was a problem hiding this comment.
Here it is ran with postinstall.
There is a possible way to include it in the webpack bundle with CopyWebpackPlugin, but the new turbopack for Next.js that we are currently using is not compatible with the webpack plugin, so I did not adopt it.
MH4GF
requested review from
hoshinotsuyoshi,
FunamaYukina,
junkisai and
sasamuku
and removed request for
a team
Schema.rb format files can now be opened 👍🏻
https://liam-erd-de01oyuvp-route-06-core.vercel.app/erd/p/raw.githubusercontent.com/mastodon/mastodon/877090518682b6c77ba9bdfa0231afd56daec44d/db/schema.rb