Merge pull request #127 from privatenumber/develop

README.md

@@ -6,6 +6,8 @@ Speed up your Webpack build with [esbuild](https://github.com/evanw/esbuild)! 
 
 [esbuild-loader](https://github.com/privatenumber/esbuild-loader) lets you harness the speed of esbuild in your Webpack build by offering faster alternatives for transpilation (eg. babel-loader/ts-loader) and minification (eg. Terser)!
 
+Curious how much faster your build will be? See [what users are saying](https://github.com/privatenumber/esbuild-loader/issues/13).
+
 <sub>If you like this project, please star it & [follow me](https://github.com/privatenumber) to see what other cool projects I'm working on! ❤️</sub>
 
 ## 🚀 Install
@@ -20,8 +22,6 @@ npm i -D esbuild-loader
 In `webpack.config.js`:
 
 ```diff
-+ const { ESBuildPlugin } = require('esbuild-loader')
-
   module.exports = {
     module: {
       rules: [
@@ -41,18 +41,13 @@ In `webpack.config.js`:
         ...
       ],
     },
-    plugins: [
-+     new ESBuildPlugin()
-    ]
   }
 ```
 
 ### TypeScript & TSX
 In `webpack.config.js`:
 
 ```diff
-+ const { ESBuildPlugin } = require('esbuild-loader')
-
   module.exports = {
     module: {
       rules: [
@@ -72,17 +67,13 @@ In `webpack.config.js`:
         ...
       ]
     },
-    plugins: [
-+     new ESBuildPlugin()
-    ]
   }
 ```
 
 #### Configuration
-If you have a `tsconfig.json` file, esbuild-loader will automatically detect it. Alternatively, you can pass it in via the [`tsconfigRaw` option](https://esbuild.github.io/api/#tsconfig-raw).
-
-Note, esbuild only supports a subset of `tsconfig` options [(see `TransformOptions` interface)](https://github.com/evanw/esbuild/blob/b901055/lib/types.ts#L127-L133) and does not do type checks.
+If you have a `tsconfig.json` file, esbuild-loader will automatically detect it.
 
+Alternatively, you can also pass it in directly via the [`tsconfigRaw` option](https://esbuild.github.io/api/#tsconfig-raw):
 ```diff
   {
       test: /\.tsx?$/,
@@ -95,16 +86,16 @@ Note, esbuild only supports a subset of `tsconfig` options [(see `TransformOptio
   }
 ```
 
+⚠️ esbuild only supports a subset of `tsconfig` options [(see `TransformOptions` interface)](https://github.com/evanw/esbuild/blob/b901055/lib/types.ts#L127-L133) and does not do type-checks. It's recommended to use a type-aware IDE or `tsc --noEmit` for type-checking instead. It is also recommend to enable [`isolatedModules`](https://www.typescriptlang.org/tsconfig#isolatedModules) and [`esModuleInterop`](https://www.typescriptlang.org/tsconfig/#esModuleInterop) options in your `tsconfig` by the [esbuild docs](https://esbuild.github.io/content-types/#typescript-caveats).
+
+
 ### Minification (eg. Terser)
-You can replace JS minifiers like Terser or UglifyJs. Checkout the [benchmarks](https://github.com/privatenumber/minification-benchmarks) to see how much faster esbuild is.
+You can replace JS minifiers like Terser or UglifyJs. Checkout the [benchmarks](https://github.com/privatenumber/minification-benchmarks) to see how much faster esbuild is. The `target` option tells esbuild that it can use newer JS syntax to perform better minification.
 
 In `webpack.config.js`:
 
 ```diff
-+ const {
-+   ESBuildPlugin,
-+   ESBuildMinifyPlugin
-+ } = require('esbuild-loader')
++ const { ESBuildMinifyPlugin } = require('esbuild-loader')
 
   module.exports = {
     ...,
@@ -117,16 +108,14 @@ In `webpack.config.js`:
 +       })
 +     ]
 +   },
-
-    plugins: [
-+     new ESBuildPlugin()
-    ]
   }
 ```
 
-> _💁‍♀️ Protip: Use the minify plugin in-place of the loader to transpile your JS_
->
-> The `target` option tells _esbuild_ that it can use newer JS syntax to perform better minification. If you're not using TypeScript or any syntax unsupported by Webpack, you can also leverage this as a transpilation step. It will be faster because there's less files to work on and will produce a smaller output because the polyfills will only be bundled once for the entire build instead of per file.
+#### _💁‍♀️ Protip: Use the minify plugin in-place of the loader to transpile your JS_
+If you're not using TypeScript, JSX, or any syntax unsupported by Webpack, you can also leverage the minifier for transpilation (as an alternative to Babel). It will be faster because there's less files to work on and will produce a smaller output because the polyfills will only be bundled once for the entire build instead of per file. Simply set the `target` option on the minifier to specify which support level you want.
+
+### Examples
+If you'd like to see working Webpack builds that use esbuild-loader for basic JS, React, TypeScript, or Next.js, check out the [examples repo](https://github.com/privatenumber/esbuild-loader-examples).
 
 ## ⚙️ Options
 

jest.config.js

@@ -1,4 +1,6 @@
 module.exports = {
 	testEnvironment: 'node',
-	preset: 'ts-jest',
+	transform: {
+		'\\.ts$': './test/jest.esbuild-transformer.js',
+	},
 };

package.json

@@ -33,16 +33,16 @@
 	},
 	"lint-staged": {
 		"*.ts": [
-			"xo --write",
+			"xo",
 			"jest --bail --findRelatedTests"
 		]
 	},
 	"dependencies": {
-		"esbuild": "^0.8.42",
+		"esbuild": "^0.9.2",
 		"joycon": "^2.2.5",
 		"json5": "^2.2.0",
 		"loader-utils": "^2.0.0",
-		"type-fest": "^0.20.2",
+		"type-fest": "^0.21.3",
 		"webpack-sources": "^2.2.0"
 	},
 	"peerDependencies": {
@@ -56,11 +56,10 @@
 		"jest": "^26.6.3",
 		"lint-staged": "^10.5.4",
 		"memfs": "^3.2.0",
-		"ts-jest": "^26.5.0",
-		"typescript": "^4.1.3",
+		"typescript": "^4.2.3",
 		"unionfs": "^4.4.0",
 		"webpack": "^4.44.2",
 		"webpack5": "npm:webpack@^5.0.0",
-		"xo": "^0.37.1"
+		"xo": "^0.38.2"
 	}
 }