Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ym-project/gulp-esbuild
gulp plugin for esbuild bundler
https://github.com/ym-project/gulp-esbuild
esbuild gulp gulp-plugin
Last synced: 3 months ago
JSON representation
gulp plugin for esbuild bundler
- Host: GitHub
- URL: https://github.com/ym-project/gulp-esbuild
- Owner: ym-project
- License: mit
- Created: 2020-07-15T20:25:06.000Z (over 4 years ago)
- Default Branch: v0
- Last Pushed: 2024-06-13T14:54:45.000Z (5 months ago)
- Last Synced: 2024-07-29T12:36:49.041Z (4 months ago)
- Topics: esbuild, gulp, gulp-plugin
- Language: JavaScript
- Homepage:
- Size: 1.12 MB
- Stars: 41
- Watchers: 1
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-esbuild - gulp-esbuild
README
[](https://npmcharts.com/compare/gulp-esbuild?minimal=true)
# gulp-esbuild
A [gulp](https://gulpjs.com) plugin for the [esbuild](https://esbuild.github.io) bundler.
There are two exports available: `gulpEsbuild` and `createGulpEsbuild`. In most cases you should use the `gulpEsbuild` export. Use the `createGuipEsbuild` export if you want to enable the esbuild's incremental build or piping:
* the [esbuild's incremental build](https://esbuild.github.io/api/#incremental) is used with the [gulp's watching files API](https://gulpjs.com/docs/en/getting-started/watching-files/) and allows you to rebuild only changed parts of code ([example](https://github.com/ym-project/gulp-esbuild/tree/master/examples/watch));
* piping allows you to receive data from other plugins via stream piping ([example](https://github.com/ym-project/gulp-esbuild/tree/master/examples/piping)).
```js
const {createGulpEsbuild} = require('gulp-esbuild')
const gulpEsbuild = createGulpEsbuild({
incremental: true, // enables the esbuild's incremental build
piping: true, // enables piping
})
```
**Notice**: `⚠️ piping is disabled by default ⚠️`
## Installation
```bash
npm install gulp-esbuild
```
or
```bash
yarn add gulp-esbuild
```
## Examples
### build example
`gulpfile.js`
```js
const {
src,
dest,
} = require('gulp')
const gulpEsbuild = require('gulp-esbuild')
function build() {
return src('./index.tsx')
.pipe(gulpEsbuild({
outfile: 'bundle.js',
bundle: true,
loader: {
'.tsx': 'tsx',
},
}))
.pipe(dest('./dist'))
}
exports.build = build
```
`package.json`
```json
...
"scripts": {
"build": "gulp build"
}
...
```
`command line`
```bash
npm run build
```
### watch mode example
`gulpfile.js`
```js
const {
src,
dest,
watch,
} = require('gulp')
const {createGulpEsbuild} = require('gulp-esbuild')
const gulpEsbuild = createGulpEsbuild({ incremental: true })
function build() {
return src('./src/index.js')
.pipe(gulpEsbuild({
outfile: 'outfile.js',
bundle: true,
}))
.pipe(dest('./dist'))
}
function watchTask() {
watch('./src/index.js', build)
}
exports.watch = watchTask
```
`package.json`
```json
...
"scripts": {
"watch": "gulp watch"
}
...
```
`command line`
```bash
npm run watch
```
More examples [here](https://github.com/ym-project/gulp-esbuild/tree/master/examples)
## Plugin arguments
| **Name** | **Type** | **Default** |
| :--------------------------------------------------------------------- | :-------------------------------------: | :---------------: |
| [sourcemap](https://esbuild.github.io/api/#sourcemap) | `boolean\|'linked'\|'inline'\|'external'\|'both'` | |
| [sourceRoot](https://esbuild.github.io/api/#source-root) | `string` | |
| [sourcesContent](https://esbuild.github.io/api/#sources-content) | `boolean` | |
| [legalComments](https://esbuild.github.io/api/#legal-comments) | `'none'\|'inline'\|'eof'\|'linked'\|'external'` |
| [format](https://esbuild.github.io/api/#format) | `'iife'\|'cjs'\|'esm'` | |
| [globalName](https://esbuild.github.io/api/#global-name) | `string` | |
| [target](https://esbuild.github.io/api/#target) | `string` | |
| [supported](https://esbuild.github.io/api/#supported) | `object` | |
| [mangleProps](https://esbuild.github.io/api/#mangle-props) | `RegExp` | |
| [reserveProps](https://esbuild.github.io/api/#mangle-props) | `RegExp` | |
| [mangleQuoted](https://esbuild.github.io/api/#mangle-quoted) | `boolean` | |
| [mangleCache](https://esbuild.github.io/api/#mangle-props) | `object` | |
| [drop](https://esbuild.github.io/api/#drop) | `'console'\|'debugger'` | |
| [dropLabels](https://esbuild.github.io/api/#drop-labels) | `array` | |
| [minify](https://esbuild.github.io/api/#minify) | `boolean` | |
| [minifyWhitespace](https://esbuild.github.io/api/#minify) | `boolean` | |
| [minifyIdentifiers](https://esbuild.github.io/api/#minify) | `boolean` | |
| [minifySyntax](https://esbuild.github.io/api/#minify) | `boolean` | |
| [lineLimit](https://esbuild.github.io/api/#line-limit) | `number` | |
| [charset](https://esbuild.github.io/api/#charset) | `'ascii'\|'utf8'` | |
| [treeShaking](https://esbuild.github.io/api/#tree-shaking) | `boolean` | |
| [ignoreAnnotations](https://esbuild.github.io/api/#ignore-annotations) | `boolean` | |
| [jsx](https://esbuild.github.io/api/#jsx) | `'transform'\|'preserve'\|'automatic'` | |
| [jsxFactory](https://esbuild.github.io/api/#jsx-factory) | `string` | |
| [jsxFragment](https://esbuild.github.io/api/#jsx-fragment) | `string` | |
| [jsxImportSource](https://esbuild.github.io/api/#jsx-import-source) | `string` | |
| [jsxDev](https://esbuild.github.io/api/#jsx-dev) | `boolean` | |
| [jsxSideEffects](https://esbuild.github.io/api/#jsx-side-effects) | `boolean` | |
| [define](https://esbuild.github.io/api/#define) | `object` | |
| [pure](https://esbuild.github.io/api/#pure) | `array` | |
| [keepNames](https://esbuild.github.io/api/#keep-names) | `boolean` | |
| [banner](https://esbuild.github.io/api/#banner) | `object` | |
| [footer](https://esbuild.github.io/api/#footer) | `object` | |
| [color](https://esbuild.github.io/api/#color) | `boolean` | |
| [logLevel](https://esbuild.github.io/api/#log-level) | `'verbose'\|'debug'\|'info'\|'warning'\|'error'\|'silent'` | `'silent'` |
| [logLimit](https://esbuild.github.io/api/#log-limit) | `number` | |
| [logOverride](https://esbuild.github.io/api/#log-override) | `object` | |
| [tsconfigRaw](https://esbuild.github.io/api/#tsconfig-raw) | `string`\|`object` | |
| [bundle](https://esbuild.github.io/api/#bundle) | `boolean` | |
| [splitting](https://esbuild.github.io/api/#splitting) | `boolean` | |
| [preserveSymlinks](https://esbuild.github.io/api/#preserve-symlinks) | `boolean` | |
| [outfile](https://esbuild.github.io/api/#outfile) | `string` | |
| [metafile](https://esbuild.github.io/api/#metafile) | `boolean` | |
| metafileName | `string` | `'metafile.json'` |
| [outdir](https://esbuild.github.io/api/#outdir) | `string` | |
| [outbase](https://esbuild.github.io/api/#outbase) | `string` | |
| [platform](https://esbuild.github.io/api/#platform) | `'browser'\|'node'\|'neutral'` | |
| [external](https://esbuild.github.io/api/#external) | `array` | |
| [packages](https://esbuild.github.io/api/#packages) | `'external'` | |
| [alias](https://esbuild.github.io/api/#alias) | `object` | |
| [loader](https://esbuild.github.io/api/#loader) | `object` | |
| [resolveExtensions](https://esbuild.github.io/api/#resolve-extensions) | `array` | |
| [mainFields](https://esbuild.github.io/api/#main-fields) | `array` | |
| [conditions](https://esbuild.github.io/api/#conditions) | `array` | |
| [tsconfig](https://esbuild.github.io/api/#tsconfig) | `string` | |
| [outExtension](https://esbuild.github.io/api/#out-extension) | `object` | |
| [publicPath](https://esbuild.github.io/api/#public-path) | `string` | |
| [entryNames](https://esbuild.github.io/api/#entry-names) | `string` | |
| [chunkNames](https://esbuild.github.io/api/#chunk-names) | `string` | |
| [assetNames](https://esbuild.github.io/api/#asset-names) | `string` | |
| [inject](https://esbuild.github.io/api/#inject) | `array` | |
| [plugins](https://esbuild.github.io/plugins/) | `array` | |