Coly010 / nx-ng-esbuild

MIT License
16 stars 0 forks source link

Nx Plugin Repo for ESBuild of Angular

Note: This uses work from https://github.com/cherryApp/ngc-esbuild Go send them love!

Plugin to help you use ESBuild with Angular in an Nx Workspace

Usage

First install the Nx Plugin

npm install --save-dev nx-ng-esbuild

yarn add -D nx-ng-esbuild

Add Configuration

If you have an existing application that you would like to use esbuild with, you can run the following command

nx g nx-ng-esbuild:add-esbuild-config appName

Or, alternatively, if you want to generate a new Angular app with esbuild support, you can run the following

nx g nx-ng-esbuild:app appName

Building

Run the build

nx run app1:esbuild

You can also pass the --watch=true flag to have it rebuild on changes.

nx run app1:esbuild --watch=true

Serving

It also supports serving locally for rapid development

You can also pass the --serve=true glag to have it serve the app on a basic http server. By default this was also set --watch=true

nx run app1:esbuild --serve=true

You can customise the port to serve on with the --port flag:

nx run app1:esbuild --serve=true --port=4201

Adding Testing Configuration

To add esbuild-based testing to your Angular app, you can use the following command to generate a config to do just that!

nx g nx-ng-esbuild:estest appName

It will create an estest target that you can then run using:

nx estest appName

Notes

Contributing

Feel free to! Should be straightforward. The issues above are likely good ones to address.