Skip to content

Commit 0e3ec08

Browse files
s-sajid-aliclaude
andcommitted
add comments explaining npm vs pnpm for remark-mdx global install
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 6a0325a commit 0e3ec08

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

.github/workflows/lint.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,14 @@ jobs:
2727
with:
2828
version: latest
2929

30+
# npm (not pnpm) is intentional: remark-cli is installed globally by the
31+
# action at /usr/local/lib/node_modules/. pnpm's global store is not on
32+
# that resolution path, so remark-cli would fall back to resolving
33+
# remark-mdx from the project's node_modules, where @mdx-js/react pulls
34+
# in mdast-util-mdx-jsx@3 — incompatible with remark-cli@10's bundled
35+
# unified v10 stack. npm -g puts remark-mdx@2 next to remark-cli so the
36+
# versions stay compatible. install_deps: false prevents the action from
37+
# running npm install and reintroducing the incompatible project deps.
3038
- name: Install remark-mdx globally
3139
run: npm install -g remark-mdx@2
3240

0 commit comments

Comments
 (0)