Skip to content

Commit a746363

Browse files
authored
fix: make esbuild a peer dependency (#62)
BREAKING CHANGE: esbuild is now a peer dependency and needs to be installed separately
1 parent c4bd871 commit a746363

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,20 @@ It has more features, fewer bugs, and no runtime!
165165

166166
</details>
167167

168+
<details>
169+
<summary>
170+
<strong>
171+
"Why is esbuild a peer dependancy?"
172+
</strong>
173+
</summary>
174+
175+
esbuild provides a service written in GO that it interacts with. Only one
176+
instance of this service can run at a time and it must have an identical version
177+
to the npm package. If it was a hard dependency you would only be able to use
178+
the esbuild version mdx-bundler uses.
179+
180+
</details>
181+
168182
## Table of Contents
169183

170184
<!-- START doctoc generated TOC please keep comment here to allow auto update -->

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,29 @@
4343
"@babel/runtime": "^7.14.6",
4444
"@esbuild-plugins/node-resolve": "^0.1.4",
4545
"@fal-works/esbuild-plugin-global-externals": "^2.1.1",
46-
"esbuild": "^0.12.11",
4746
"gray-matter": "^4.0.3",
4847
"remark-frontmatter": "^3.0.0",
4948
"remark-mdx-frontmatter": "^1.0.1",
5049
"xdm": "^1.11.1"
5150
},
51+
"peerDependencies": {
52+
"esbuild": "0.11.x || 0.12.x"
53+
},
5254
"devDependencies": {
5355
"@testing-library/react": "^12.0.0",
5456
"@types/jsdom": "^16.2.12",
55-
"@types/react": "^17.0.11",
57+
"@types/react": "^17.0.13",
5658
"@types/react-dom": "^17.0.8",
5759
"cross-env": "^7.0.3",
60+
"esbuild": "^0.12.15",
5861
"jsdom": "^16.6.0",
5962
"kcd-scripts": "^11.1.0",
6063
"left-pad": "^1.3.0",
6164
"mdx-test-data": "^1.0.1",
6265
"react": "^17.0.2",
6366
"react-dom": "^17.0.2",
6467
"remark-mdx-images": "^1.0.2",
65-
"typescript": "^4.3.4",
68+
"typescript": "^4.3.5",
6669
"uvu": "^0.5.1"
6770
},
6871
"eslintConfig": {

0 commit comments

Comments
 (0)