es-toolkit icon indicating copy to clipboard operation
es-toolkit copied to clipboard

docs: implement Sandpack component in documentation

Open kangju2000 opened this issue 1 year ago • 2 comments

Related With https://github.com/toss/es-toolkit/pull/338, https://github.com/toss/es-toolkit/pull/358

I'm submitting this PR again with modifications due to a Vercel deployment error that occurred when I submitted the previous PR.

I suspect the deployment error was caused by dependency conflicts between the vitepress version and the vue version. When I attempted to deploy directly to Vercel in the same environment, the following error appeared:

build error:
vitepress data not properly injected in app
Error: vitepress data not properly injected in app
    at useData$1 (file:///vercel/path0/docs/.vitepress/.temp/app.js?t=1723187817409:187:11)
    at normalizeLink$1 (file:///vercel/path0/docs/.vitepress/.temp/app.js?t=1723187817409:501:20)
    at file:///vercel/path0/docs/.vitepress/.temp/app.js?t=1723187817409:3214:113
    at renderComponentSubTree (/vercel/path0/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:442:9)
    at renderComponentVNode (/vercel/path0/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:386:12)
    at ssrRenderComponent (/vercel/path0/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:84:10)
    at file:///vercel/path0/docs/.vitepress/.temp/app.js?t=1723187817409:3315:13
    at renderComponentSubTree (/vercel/path0/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:442:9)
    at renderComponentVNode (/vercel/path0/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:386:12)
    at ssrRenderComponent (/vercel/path0/node_modules/@vue/server-renderer/dist/server-renderer.cjs.prod.js:84:10)
Error: Command "yarn workspace docs docs:build" exited with 1

The build error issue was resolved by removing vitepress and then reinstalling it with version ^1.3.2. (If we reinstall with ^1.2.2, due to semantic versioning, it will point to the latest version 1.3.2, so we explicitly specify ^1.3.2 in the package.json)

However, since I'm concerned about bumping to a minor version, I'm attaching the CHANGELOG.md for vitepress.

@raon0211 I would appreciate it if you could check the Vercel deployment log for this PR.

kangju2000 avatar Aug 09 '24 08:08 kangju2000

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
es-toolkit ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 9, 2024 8:07am

vercel[bot] avatar Aug 09 '24 08:08 vercel[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (7ca9ffc) to head (fc25de0).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #363   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          137       137           
  Lines         1054      1054           
  Branches       279       279           
=========================================
  Hits          1054      1054           

codecov-commenter avatar Aug 09 '24 08:08 codecov-commenter

Seems that it is working here: https://es-toolkit-git-fork-kangju2000-docs-add-sandpack-toss-05a749d6.vercel.app.

Thanks for your great work!

raon0211 avatar Aug 10 '24 01:08 raon0211