search

code-hike / codehike

Build rich content websites with Markdown and React
https://codehike.org
MIT License
4.74k stars 145 forks source link

Use @code-hike/lighter #308

Closed pomber closed 1 year ago

pomber commented 1 year ago
📦 Published PR as canary version: 0.8.0--canary.308.6cc554b.0
:sparkles: Test out this PR locally via: ```bash npm install @code-hike/mdx@0.8.0--canary.308.6cc554b.0 # or yarn add @code-hike/mdx@0.8.0--canary.308.6cc554b.0 ```

Version

Published prerelease version: v0.8.0-next.0

Changelog #### 🚀 Enhancement - `@code-hike/mdx` - Use @code-hike/lighter [#308](https://github.com/code-hike/codehike/pull/308) ([@pomber](https://github.com/pomber)) #### 🐛 Bug Fix - add/astro-example [#282](https://github.com/code-hike/codehike/pull/282) ([@JohnDaly](https://github.com/JohnDaly)) - `@code-hike/mdx` - Fix line number horizontal shift [#278](https://github.com/code-hike/codehike/pull/278) ([@pomber](https://github.com/pomber)) #### Authors: 2 - John Daly ([@JohnDaly](https://github.com/JohnDaly)) - Rodrigo Pombo ([@pomber](https://github.com/pomber))
vercel[bot] commented 1 year ago

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

Name Status Preview Comments Updated
chtest ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Jan 15, 2023 at 7:39PM (UTC)
playground ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Jan 15, 2023 at 7:39PM (UTC)
github-actions[bot] commented 1 year ago

📦 Next.js Bundle Analysis

This analysis was generated by the next.js bundle analysis action 🤖

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 74.2 KB (🟡 +2.39 KB)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

Six Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/_error 181 B 74.38 KB 21.25% (+/- <0.01%)
/js-page 317 B 74.51 KB 21.29% (+/- <0.01%)
/just-code 33.81 KB 108.01 KB 30.86% (🟡 +0.02%)
/no-ch-mdx 1.04 KB 75.25 KB 21.50% (🟡 +0.17%)
/scrollycoding-preview 37.04 KB 111.24 KB 31.78% (🟡 +0.02%)
/spotlight 34.42 KB 108.62 KB 31.03% (🟡 +0.02%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

bkase commented 1 year ago

fyi I'm able to get basic fenced code blocks to work on my React18/Next13/Contentlayer project with this branch. But I am getting errors when I try to use any CodeHike components in my mdx files.

[0] TypeError: Cannot read properties of undefined (reading 'length')
[0]     at InnerCode (webpack-internal:///(sc_client)/./node_modules/@code-hike/mdx/dist/components.esm.mjs:3450:21)
[0]     at renderWithHooks (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7681:16)
[0]     at renderIndeterminateComponent (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7755:15)
[0]     at renderElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7990:7)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8157:11)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderIndeterminateComponent (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7809:7)
[0]     at renderElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7990:7)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8157:11)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderNode (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8313:12)
[0]     at renderChildrenArray (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8265:7)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8194:7)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8016:9)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8157:11)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderIndeterminateComponent (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7809:7)
[0]     at renderElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7990:7)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8157:11)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderIndeterminateComponent (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7809:7)
[0]     at renderElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7990:7)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8157:11)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderNode (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8313:12)
[0]     at renderChildrenArray (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8265:7)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8194:7)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderNode (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8313:12)
[0]     at renderHostElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7665:3)
[0]     at renderElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7996:5)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8157:11)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderNode (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8313:12)
[0]     at renderHostElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7665:3)
[0]     at renderElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7996:5)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8157:11)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderIndeterminateComponent (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7809:7)
[0]     at renderElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7990:7)
[0]     at renderLazyComponent (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7970:3)
[0]     at renderElement (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8080:11)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8157:11)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderNode (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8313:12)
[0]     at renderChildrenArray (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8265:7)
[0]     at renderNodeDestructiveImpl (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8194:7)
[0]     at renderNodeDestructive (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:8129:14)
[0]     at renderContextProvider (/Users/bkase/site3/site3/node_modules/next/dist/compiled/react-dom/cjs/react-dom-server.browser.development.js:7954:3)

Mdx here:

    <CHCode>

    ```ocaml semigroup.ml focus=1[2:5]
    module type Semigroup = sig
      type t

      (* We don't use <> in the ML langs because <> is traditionally "is not equal" *)
      val (+) : t -> t -> t
    end
    ```

    ```haskell semigroup.hs
    -- You can find this in Data.Semigroup
    class Semigroup a where
      (<>) :: a -> a -> a
    ```

    </CHCode>

slug.tsx:

import { useMDXComponent } from "next-contentlayer/hooks"
import { CH } from "@code-hike/mdx/components"

const Mdx = ({ code } : {code: string}) => {
  const Component = useMDXComponent(code);

  return (
    <Component components={{
      CHCode: CH.Code
    }} />
  )
}

When I inspect props it looks like props.children has components that have the files key (upon which length is called).

bkase commented 1 year ago

If you could update the next+contentlayer example to use the CH components, that would be very helpful I think!

pomber commented 1 year ago

@bkase why are you aliasing CH.Code to CHCode?

I tried adding your mdx but using CH.Code to examples/contentlayer/posts/two.mdx in this branch and it works.

bkase commented 1 year ago

@pomber I'm able to reproduce the bug on this example on posts/two.mdx -- note I had to tweak package.json to use the right versions of things. Does something in my configuration look wrong? Thanks for your help!

https://github.com/bkase/codehike-contentlayer-bug

Including a new bug here that I don't see in my project:

error running remarkCodeHike TypeError: Cannot read properties of undefined (reading 'tokenizeLine2')
    at /Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:65:43
    at Array.map (<anonymous>)
    at tokenize (/Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:64:16)
    at toTokens (/Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:1357:10)
    at highlight (/Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:1367:17)
✘ [ERROR] [plugin @mdx-js/esbuild] TypeError: Cannot read properties of undefined (reading 'tokenizeLine2')
    at /Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:65:43
    at Array.map (<anonymous>)
    at tokenize (/Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:64:16)
    at toTokens (/Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:1357:10)
    at highlight (/Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:1367:17)

    _mdx_bundler_entry_point-6d1f8d8a-98ed-4220-aaf8-636eb145b96a.mdx:0:0:
      0 │ ---
        ╵ ^

Error: Found 1 problems in 2 documents.

 └── Encountered unexpected errors while processing of 1 documents. This is possibly a bug in Contentlayer. Please open an issue.

     • "two.mdx": UnexpectedMDXError: Error: Build failed with 1 error:
     _mdx_bundler_entry_point-6d1f8d8a-98ed-4220-aaf8-636eb145b96a.mdx:0:0: ERROR: [plugin: @mdx-js/esbuild] TypeError: Cannot read properties of undefined (reading 'tokenizeLine2')
         at /Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:65:43
         at Array.map (<anonymous>)
         at tokenize (/Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:64:16)
         at toTokens (/Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:1357:10)
         at highlight (/Users/bkase/contentlayer-example/node_modules/@code-hike/lighter/dist/index.cjs.js:1367:17)

SourceFetchDataError: {
  "_tag": "HandledFetchDataError"
}

and then the same undefined length issue:

error - TypeError: Cannot read properties of undefined (reading 'length')
    at nt (eval at getMDXComponent (file:///Users/bkase/contentlayer-example/node_modules/next-contentlayer/src/hooks/useMDXComponent.ts:24:14), <anonymous>:17:16982)
    at renderWithHooks (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5658:16)
    at renderIndeterminateComponent (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5731:15)
    at renderElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5946:7)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6104:11)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderIndeterminateComponent (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5785:7)
    at renderElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5946:7)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6104:11)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderNode (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6259:12)
    at renderChildrenArray (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6211:7)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6141:7)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5971:9)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6104:11)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderIndeterminateComponent (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5785:7)
    at renderElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5946:7)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6104:11)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderNode (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6259:12)
    at renderChildrenArray (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6211:7)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6141:7)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderNode (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6259:12)
    at renderHostElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5642:3)
    at renderElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5952:5)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6104:11)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderIndeterminateComponent (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5785:7)
    at renderElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5946:7)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6104:11)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderIndeterminateComponent (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5785:7)
    at renderElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5946:7)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6104:11)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderIndeterminateComponent (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5785:7)
    at renderElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5946:7)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6104:11)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderNode (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6259:12)
    at renderChildrenArray (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6211:7)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6141:7)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderElement (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:5971:9)
    at renderNodeDestructiveImpl (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6104:11)
    at renderNodeDestructive (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6076:14)
    at renderNode (/Users/bkase/contentlayer-example/node_modules/react-dom/cjs/react-dom-server.browser.development.js:6259:12) {
  page: '/posts/[slug]'
}
bkase commented 1 year ago

Okay I realized the bug is from trying to add the CH components when the remarkCodeHike plugin does this for you.

It seems to be working for me now!

github-actions[bot] commented 1 year ago

:rocket: PR was released in v0.8.0 :rocket: