Repository navigation
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #1082 +/- ##
==========================================
- Coverage 93.44% 93.18% -0.27%
==========================================
Files 278 281 +3
Lines 27815 28105 +290
Branches 2789 2813 +24
==========================================
+ Hits 25993 26189 +196
- Misses 1800 1894 +94
Partials 22 22 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
| File | Main | PR | Change |
|---|---|---|---|
orama-db.json |
29.15 MB | 29.15 MB | -2.00 B (-0.0%) |
Performance estimate (single CI run)
- Generation time: 15.6% slower (5.65 s → 6.53 s)
- Peak memory: 4.1% lower (1.33 GB → 1.28 GB)
web Generator
Output size: 62 files changed · net +173.00 B
File size details
| File | Main | PR | Change |
|---|---|---|---|
assets/SearchBox-DjNnuz7W.js |
84.67 KB | — | -84.67 KB (-100.0%) |
assets/SearchBox-DD9L4y_U.js |
— | 84.67 KB | +84.67 KB |
assets/dist-DruvUqXN.js |
30.42 KB | — | -30.42 KB (-100.0%) |
assets/dist-7Sv3Eu0L.js |
— | 30.42 KB | +30.42 KB |
assets/SideBar-DaKBoTPQ.js |
25.62 KB | — | -25.62 KB (-100.0%) |
assets/SideBar-Brrk92eF.js |
— | 25.62 KB | +25.62 KB |
assets/client-BY1cXtbt.js |
— | 25.08 KB | +25.08 KB |
assets/client-DxC3O6Ca.js |
24.91 KB | — | -24.91 KB (-100.0%) |
assets/Combination-d5oRXla-.js |
16.11 KB | — | -16.11 KB (-100.0%) |
assets/Combination-C6mYSeMI.js |
— | 16.11 KB | +16.11 KB |
assets/ThemeToggle-DVZdvZ7l.js |
13.65 KB | — | -13.65 KB (-100.0%) |
assets/ThemeToggle-t7UMm7iR.js |
— | 13.65 KB | +13.65 KB |
assets/dist-DVEbYasF.js |
10.20 KB | — | -10.20 KB (-100.0%) |
assets/dist-BiOceZL-.js |
— | 10.20 KB | +10.20 KB |
assets/Layout-C5yPmBoc.js |
10.13 KB | — | -10.13 KB (-100.0%) |
assets/Layout-DXy0PTpC.js |
— | 10.13 KB | +10.13 KB |
assets/compat-ByVaDh64.js |
10.13 KB | — | -10.13 KB (-100.0%) |
assets/compat-BGVxnT5A.js |
— | 10.13 KB | +10.13 KB |
assets/Tooltip-C41LEB8U.js |
7.93 KB | — | -7.93 KB (-100.0%) |
assets/Tooltip-D0_5WcN-.js |
— | 7.93 KB | +7.93 KB |
assets/dist-DNbUuC3x.js |
6.99 KB | — | -6.99 KB (-100.0%) |
assets/dist-B_8yU3XK.js |
— | 6.99 KB | +6.99 KB |
assets/jsx-runtime-CW012A50.js |
5.67 KB | — | -5.67 KB (-100.0%) |
assets/jsx-runtime-CWJMV0zg.js |
— | 5.67 KB | +5.67 KB |
assets/dist-cDFsq_2f.js |
3.93 KB | — | -3.93 KB (-100.0%) |
assets/dist-mb3JM3jT.js |
— | 3.93 KB | +3.93 KB |
assets/CodeTabs-DT17uorw.js |
3.89 KB | — | -3.89 KB (-100.0%) |
assets/CodeTabs-CPzzUAfT.js |
— | 3.89 KB | +3.89 KB |
assets/CodeBox-BNILFdqT.js |
3.44 KB | — | -3.44 KB (-100.0%) |
assets/CodeBox-UjtYavEZ.js |
— | 3.44 KB | +3.44 KB |
assets/hooks.module-BbOQEtt2.js |
3.40 KB | — | -3.40 KB (-100.0%) |
assets/hooks.module-CFIEcDZS.js |
— | 3.40 KB | +3.40 KB |
assets/FunctionSignature-BQoQjJ6P.js |
2.28 KB | — | -2.28 KB (-100.0%) |
assets/FunctionSignature-Rfd1uwFe.js |
— | 2.28 KB | +2.28 KB |
assets/Banner-Zf4myBWm.js |
2.13 KB | — | -2.13 KB (-100.0%) |
assets/Banner-C5QQ94Xt.js |
— | 2.13 KB | +2.13 KB |
assets/ChangeHistory-C3DUcRCX.js |
1.77 KB | — | -1.77 KB (-100.0%) |
assets/ChangeHistory-D9LG4HXo.js |
— | 1.77 KB | +1.77 KB |
assets/DataTag-CTUSGgLj.js |
856.00 B | — | -856.00 B (-100.0%) |
assets/DataTag-DtiaU1SZ.js |
— | 856.00 B | +856.00 B |
assets/DocumentationIndex-D_jFywVL.js |
833.00 B | — | -833.00 B (-100.0%) |
assets/DocumentationIndex-B2JfRHAn.js |
— | 833.00 B | +833.00 B |
assets/ArrowUpRightIcon-BSpTwAaB.js |
618.00 B | — | -618.00 B (-100.0%) |
assets/ArrowUpRightIcon-Bbb8DgHe.js |
— | 618.00 B | +618.00 B |
assets/Badge-CZF-RiB7.js |
616.00 B | — | -616.00 B (-100.0%) |
assets/Badge-C-ltoqbN.js |
— | 616.00 B | +616.00 B |
assets/AlertBox-BNnsWt2b.js |
591.00 B | — | -591.00 B (-100.0%) |
assets/AlertBox-3_Yfvgqh.js |
— | 591.00 B | +591.00 B |
assets/CodeBracketIcon-TvXI-m3T.js |
512.00 B | — | -512.00 B (-100.0%) |
assets/CodeBracketIcon-C36OD0aC.js |
— | 512.00 B | +512.00 B |
assets/dist-D1kGHM6c.js |
477.00 B | — | -477.00 B (-100.0%) |
assets/dist-Dk9IlaWb.js |
— | 477.00 B | +477.00 B |
assets/ChevronDownIcon-BOnMJQ3A.js |
468.00 B | — | -468.00 B (-100.0%) |
assets/ChevronDownIcon-Do5H2e5N.js |
— | 468.00 B | +468.00 B |
assets/renderLabel-CdEZo9LC.js |
447.00 B | — | -447.00 B (-100.0%) |
assets/renderLabel-B4Wm-j6_.js |
— | 447.00 B | +447.00 B |
assets/Blockquote-C7yOM0SI.js |
167.00 B | — | -167.00 B (-100.0%) |
assets/Blockquote-DPf4tr3s.js |
— | 167.00 B | +167.00 B |
assets/useRemoteConfig-DRPTLZY3.js |
151.00 B | — | -151.00 B (-100.0%) |
assets/useRemoteConfig-BD0WscbS.js |
— | 151.00 B | +151.00 B |
assets/withIsland-C7ctRfG5.js |
105.00 B | — | -105.00 B (-100.0%) |
assets/withIsland-o2Rd4XD_.js |
— | 105.00 B | +105.00 B |
Performance estimate (single CI run)
- Generation time: 5.2% faster (24.88 s → 23.59 s)
- Peak memory: 0.8% higher (2.04 GB → 2.06 GB)
bmuenzenmeyer
left a comment
bmuenzenmeyer
left a comment
There was a problem hiding this comment.
I've come around to this after observing a mentee interact with this repository. There is a lot of intimidating work to get all this to work together, and for the unfamiliar, it's a lot.
There was a problem hiding this comment.
IMO our dev command/preview command should still follow/support doc-kit args (Supplying input folder, supplying generators... It shouldn't be locked for Node.js it should be agnostic) since we want to make a generic preview/dev command for doc-kit itself instead of bounding it to Node.js
So our dev/preview command IMO shouldn't be scripts (scripts) but be commands part of doc-kit CLI
(We should avoid using 3rd party NPM packages, http:serve is enough)
|
Makes sense — a generic preview command in the doc-kit CLI beats a Node.js-bound script. Before I rework the PR, two quick questions:
Either way: serving via |
|
my opinions
I like the idea of it attempting to build at the presence of any flag besides
follow up |
btea
changed the title
preview:docs & preview:node scriptspreview command
There was a problem hiding this comment.
nit: make it clear on docs that this is NOT production grade and meant to be used for testing.
| const server = await serve(output, { port: opts.port }); | ||
|
|
||
| logger.info( | ||
| `Serving ${output} at http://localhost:${server.address().port}/ ` + |
There was a problem hiding this comment.
nit: We should be able to also pass the host parameter so you can serve on localhost, 0.0.0.0 or whatever you want IMO
|
|
||
| const { runGenerators } = createGenerator(); | ||
|
|
||
| const DEFAULT_OUTPUT = './out'; |
There was a problem hiding this comment.
Is this already defined somewhere? I feel that this command can't really run without an output flag being passed... Is it correct to assume the default should be "out" and if that's the case, then our generator command also should have a default out, no?
cc @avivkeller ?
|
Will review today! |
Description
Add a unified startup preview script to facilitate quick previewing and verification of changes on the page after modifying the code logic.
Validation
Related Issues
Check List
node --run testand all tests passed.node --run format:check&node --run lint.