https://github.com/eirslett/frontend-maven-plugin

"Maven-node-grunt-gulp-npm-node-plugin to end all maven-node-grunt-gulp-npm-plugins." A Maven plugin that downloads/installs Node and NPM locally, runs NPM install, Grunt, Gulp and/or Karma.
https://github.com/eirslett/frontend-maven-plugin

Last synced: 6 months ago
JSON representation

"Maven-node-grunt-gulp-npm-node-plugin to end all maven-node-grunt-gulp-npm-plugins." A Maven plugin that downloads/installs Node and NPM locally, runs NPM install, Grunt, Gulp and/or Karma.

Host: GitHub
URL: https://github.com/eirslett/frontend-maven-plugin
Owner: eirslett
License: apache-2.0
Created: 2013-08-30T14:44:38.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2025-01-17T12:54:44.000Z (10 months ago)
Last Synced: 2025-05-09T03:55:50.000Z (6 months ago)
Language: Java
Homepage:
Size: 2.1 MB
Stars: 4,292
Watchers: 121
Forks: 877
Open Issues: 350
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

useful-java-links - Frontend maven plugin - node-grunt-gulp-npm-node-plugin to end all maven-node-grunt-gulp-npm-plugins." A Maven plugin that downloads/installs Node and NPM locally, runs NPM install, Grunt, Gulp and/or Karma. License: [Apache 2](http://www.apache.org/licenses/LICENSE-2.0) , [![GitHub stars](https://img.shields.io/github/stars/eirslett/frontend-maven-plugin.svg?style=social&label=Star&maxAge=2592000)](https://github.com/eirslett/frontend-maven-plugin). ![business friendly license](https://github.com/Vedenin/useful-java-links/blob/master/img/business-friendly.png?raw=true) (VI. Program languages and applications that were written with Java / 3. Javascript)
awesome-articles - eirslett/frontend-maven-plugin: "Maven-node-grunt-gulp-npm-node-plugin to e
awesome-list - frontend-maven-plugin - node-grunt-gulp-npm-node-plugin to end all maven-node-grunt-gulp-npm-plugins." A Maven plugin that downloads/installs Node and NPM locally, runs NPM install, Grunt, Gulp and/or Karma. | eirslett | 3615 | (Java)

README

# frontend-maven-plugin

[![Build Status OSX and Linux](https://travis-ci.org/eirslett/frontend-maven-plugin.png?branch=master)](https://travis-ci.org/eirslett/frontend-maven-plugin)
[![Build status Windows](https://ci.appveyor.com/api/projects/status/vxbccc1t9ceadhi9?svg=true)](https://ci.appveyor.com/project/eirslett/frontend-maven-plugin)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.eirslett/frontend-maven-plugin/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/com.github.eirslett/frontend-maven-plugin/)

This plugin downloads/installs Node and NPM locally for your project, runs `npm install`, and then any combination of
[Bower](http://bower.io/), [Grunt](http://gruntjs.com/), [Gulp](http://gulpjs.com/), [Jspm](http://jspm.io),
[Karma](http://karma-runner.github.io/), or [Webpack](http://webpack.github.io/).
It's supposed to work on Windows, OS X and Linux.

If you prefer [Yarn](https://yarnpkg.com/) over [NPM](https://www.npmjs.com/) for your node package fetching,
this plugin can also download Node and Yarn and then run `yarn install` for your project.

#### What is this plugin meant to do?
- Let you keep your frontend and backend builds as separate as possible, by
reducing the amount of interaction between them to the bare minimum; using only 1 plugin.
- Let you use Node.js and its libraries in your build process without installing Node/NPM
globally for your build system
- Let you ensure that the version of Node and NPM being run is the same in every build environment

#### What is this plugin not meant to do?
- Not meant to replace the developer version of Node - frontend developers will still install Node on their
laptops, but backend developers can run a clean build without even installing Node on their computer.
- Not meant to install Node for production uses. The Node usage is intended as part of a frontend build,
running common javascript tasks such as minification, obfuscation, compression, packaging, testing etc.

**Notice:** _This plugin does not support already installed Node or npm versions. Use the `exec-maven-plugin` instead._

## Requirements

* _Maven 3.6_ and _Java 1.8_
* For _Maven 2_ support take a look at the [wiki](https://github.com/eirslett/frontend-maven-plugin/wiki#maven-2).

## Installation

Include the plugin as a dependency in your Maven project. Change `LATEST_VERSION` to the latest tagged version.

```xml

com.github.eirslett
frontend-maven-plugin

LATEST_VERSION
...

...
```

## Usage

Have a look at the [example project](frontend-maven-plugin/src/it/example%20project),
to see how it should be set up: https://github.com/eirslett/frontend-maven-plugin/blob/master/frontend-maven-plugin/src/it/example%20project/pom.xml

- [frontend-maven-plugin](#frontend-maven-plugin)
- [What is this plugin meant to do?](#what-is-this-plugin-meant-to-do)
- [What is this plugin not meant to do?](#what-is-this-plugin-not-meant-to-do)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Installing node and npm](#installing-node-and-npm)
- [Installing node and yarn](#installing-node-and-yarn)
- [Installing node and corepack](#installing-node-and-corepack)
- [Installing bun](#installing-bun)
- [Running npm](#running-npm)
- [npx](#npx)
- [Running yarn](#running-yarn)
- [Yarn with Private Registry](#yarn-with-private-registry)
- [Running corepack](#running-corepack)
- [Running bower](#running-bower)
- [Running Grunt](#running-grunt)
- [Running gulp](#running-gulp)
- [Running jspm](#running-jspm)
- [Running Karma](#running-karma)
- [Running Webpack](#running-webpack)
- [Running bun](#running-bun)
- [Optional Configuration](#optional-configuration)
- [Working directory](#working-directory)
- [Installation Directory](#installation-directory)
- [Proxy settings](#proxy-settings)
- [Environment variables](#environment-variables)
- [Ignoring Failure](#ignoring-failure)
- [Skipping Execution](#skipping-execution)
- [Eclipse M2E support](#eclipse-m2e-support)
- [Helper scripts](#helper-scripts)
- [To build this project:](#to-build-this-project)
- [Issues, Contributing](#issues-contributing)
- [License](#license)

**Recommendation:** _Try to run all your tasks via npm scripts instead of running bower, grunt, gulp etc. directly._

### Installing node and npm

The versions of Node and npm are downloaded from https://nodejs.org/dist, extracted and put into a `node` folder created
in your [installation directory](#installation-directory) . Node/npm will only be "installed" locally to your project.
It will not be installed globally on the whole system (and it will not interfere with any Node/npm installations already
present).

```xml

...

install node and npm

install-node-and-npm

generate-resources

v4.6.0

2.15.9

http://myproxy.example.org/nodejs/

```

You can also specify separate download roots for npm and node as they are stored in separate repos. In case the root configured requires authentication, you can specify a server ID from your maven settings file:

```xml

...

http://myproxy.example.org/nodejs/

server001

https://myproxy.example.org/npm/

```

You can use Nexus repository Manager to proxy npm registries. See https://help.sonatype.com/display/NXRM3/Npm+Registry

**Notice:** _Remember to gitignore the `node` folder, unless you actually want to commit it._

### Installing node and yarn

Instead of using Node with npm you can alternatively choose to install Node with Yarn as the package manager.

The versions of Node and Yarn are downloaded from `https://nodejs.org/dist` for Node
and from the Github releases for Yarn,
extracted and put into a `node` folder created in your installation directory.
Node/Yarn will only be "installed" locally to your project.
It will not be installed globally on the whole system (and it will not interfere with any Node/Yarn installations already
present).

If your project is using Yarn Berry (2.x or above), the Yarn version is handled per project but a Yarn 1.x install is still needed as a "bootstrap".
The plugin will try to detect `.yarnrc.yml` file in the current Maven project/module folder, at the root of the multi-module project if relevant, and in the folder from which the `mvn` command was run.
If detected, the plugin will assume your project is using Yarn Berry. It will install the 1.x Yarn version you specify with `yarnVersion` as bootstrap, then hand over to your project-specific version.

Have a look at the example `POM` to see how it should be set up with Yarn:
https://github.com/eirslett/frontend-maven-plugin/blob/master/frontend-maven-plugin/src/it/yarn-integration/pom.xml

```xml

...

install node and yarn

install-node-and-yarn

generate-resources

v6.9.1
v0.16.1

http://myproxy.example.org/nodejs/

http://myproxy.example.org/yarn/

```

### Installing node and corepack

You can choose to let corepack manage the package manager version in use. Node is
downloaded from `https://nodejs.org/dist`, and corepack either comes provided with
Node, or will currently be downloaded from `https://repository.npmjs.org`, extracted
and put into a `node` folder created in your installation directory.

Node/corepack and any package managers will only be "installed" locally to your project.
It will not be installed globally on the whole system (and it will not interfere with any
Node/corepack installations already present).

Have a look at the example `POM` to see how it should be set up with corepack:
https://github.com/eirslett/frontend-maven-plugin/blob/master/frontend-maven-plugin/src/it/corepack-provided-integration/pom.xml
or
https://github.com/eirslett/frontend-maven-plugin/blob/master/frontend-maven-plugin/src/it/corepack-integration/pom.xml
if you need to override the version of corepack in use.

```xml

...

install-node-and-corepack

install-node-and-corepack

generate-resources

v20.12.2

v0.25.2

http://myproxy.example.org/nodejs/

http://myproxy.example.org/corepack/

```

### Installing bun

The version Bun is downloaded from https://github.com/oven-sh/bun/releases/download/, extracted and put into a `bun` folder created
in your [installation directory](#installation-directory) . Bun will only be "installed" locally to your project.
It will not be installed globally on the whole system (and it will not interfere with any Bun installations already
present).

```xml

...

install bun

install-bun

generate-resources

v1.1.34

```

### Running npm

All node packaged modules will be installed in the `node_modules` folder in your [working directory](#working-directory).
By default, colors will be shown in the log.

```xml

npm install

npm

generate-resources

install

```

**Notice:** _Remember to gitignore the `node_modules` folder, unless you actually want to commit it. Npm packages will
always be installed in `node_modules` next to your `package.json`, which is default npm behavior._

#### npx

You can also use [`npx` command](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner), enabling you to execute the CLI of installed packages without a run-script, or even packages that aren't installed at all.

```xml

say hello

npx

generate-resources

cowsay hello

```

### Running yarn

As with npm above, all node packaged modules will be installed in the `node_modules` folder in your [working directory](#working-directory).

```xml

yarn install

yarn

install

```

#### Yarn with Private Registry

NOTE: if you have a private npm registry that mirrors the npm registry, be aware that yarn.lock
includes URLs to the npmjs.org module registry and yarn install will use these paths when installing modules.

If you want yarn.lock to use your private npm registry, be sure to run these commands on your local machine before you generate yarn.lock:
```
yarn config set registry
yarn install
```
This will create URLs in your yarn.lock file that reference your private npm registry.

Another way to set a registry is to add a .npmrc file in your project's root directory that contains:
```
registry=
```

Also you can set a registry using a tag `npmRegistryURL`
```

yarn install

yarn

install

http://myregistry.example.org/

```

### Running corepack

If your `packageManager` specifies `yarn`, then you'll want to have something like:

```xml

install

corepack

yarn install

build

corepack

yarn build

```

and if you're using `pnpm` instead, you'll want something like

```xml

install

corepack

pnpm install

build

corepack

pnpm build

```

### Running bower

All bower dependencies will be installed in the `bower_components` folder in your working directory.

```xml

bower install

bower

install

```

**Notice:** _Remember to gitignore the `bower_components` folder, unless you actually want to commit it._

### Running Grunt

It will run Grunt according to the `Gruntfile.js` in your working directory.
By default, colors will be shown in the log.

```xml

grunt build

grunt

generate-resources

build

```

### Running gulp

Very similar to the Grunt execution. It will run gulp according to the `gulpfile.js` in your working directory.
By default, colors will be shown in the log.

```xml

gulp build

gulp

generate-resources

build

```

### Running jspm

All jspm dependencies will be installed in the `jspm_packages` folder in your working directory.

```xml

jspm install

jspm

install

```

### Running Karma

```xml

javascript tests

karma

test

src/test/javascript/karma.conf.ci.js

```

**Skipping tests:** If you run maven with the `-DskipTests` flag, karma tests will be skipped.

**Ignoring failed tests:** If you want to ignore test failures run maven with the `-Dmaven.test.failure.ignore` flag,
karma test results will not stop the build but test results will remain
in test output files. Suitable for continuous integration tool builds.

**Why karma.conf.ci.js?** When using Karma, you should have two separate
configurations: `karma.conf.js` and `karma.conf.ci.js`. (The second one should inherit configuration
from the first one, and override some options. The example project shows you how to set it up.)
The idea is that you use `karma.conf.js` while developing (using watch/livereload etc.), and
`karma.conf.ci.js` when building - for example, when building, it should only run karma once,
it should generate xml reports, it should run only in PhantomJS, and/or it should generate
code coverage reports.

**Running Karma through Grunt or gulp:** You may choose to run Karma [directly through Grunt](https://github.com/karma-runner/grunt-karma)
or [through gulp](https://github.com/karma-runner/gulp-karma) instead, as part of the `grunt` or `gulp` execution. That
will help to separate your frontend and backend builds even more.

### Running Webpack

```xml

webpack build

webpack

generate-resources

-p

```

### Running bun

```xml

bun install

bun

generate-resources

install

```

### Optional Configuration

#### Working directory

The working directory is where you've put `package.json` and your frontend configuration files (`Gruntfile.js` or
`gulpfile.js` etc). The default working directory is your project's base directory (the same directory as your `pom.xml`).
You can change the working directory if you want:

```xml

com.github.eirslett
frontend-maven-plugin

src/main/frontend

```

**Notice:** _Npm packages will always be installed in `node_modules` next to your `package.json`, which is default npm behavior._

#### Installation Directory

The installation directory is the folder where your node and npm are installed.
You can set this property on the different goals. Or choose to set it for all the goals, in the maven configuration.

```xml

com.github.eirslett
frontend-maven-plugin

target

```

#### Proxy settings

If you have [configured proxy settings for Maven](http://maven.apache.org/guides/mini/guide-proxies.html)
in your settings.xml file, the plugin will automatically use the proxy for downloading node and npm, as well
as [passing the proxy to npm commands](https://docs.npmjs.com/misc/config#proxy).

**Non Proxy Hosts:** npm does not currently support non proxy hosts - if you are using a proxy and npm install
is not downloading from your repository, it may be because it cannot be accessed through your proxy.
If that is the case, you can stop the npm execution from inheriting the Maven proxy settings like this:

```xml

false

```

If you have [configured proxy settings for Maven](http://maven.apache.org/guides/mini/guide-proxies.html)
in your settings.xml file, the plugin will automatically [pass the proxy to bower commands](https://docs.npmjs.com/misc/config#proxy).
If that is the case, you can stop the bower execution from inheriting the Maven proxy settings like this:

```xml

false

```

If you want to disable proxy for Yarn you can use `yarnInheritsProxyConfigFromMaven`. When you have proxy settings in your settings.xml file if you don't use this param it will run code below with proxy settings, in some cases you don't want that. Adding this param into the configuration section will solve this issue

```xml

tests

yarn

compile

false
run test

```

#### Environment variables

If you need to pass some variable to Node, you can set that using the property `environmentVariables` in configuration
tag of an execution like this:

```xml

Snow
Lannister

${NODE_ENV}

```

#### Ignoring Failure

**Ignoring failed tests:** If you want to ignore test failures in specific execution you can set that using the property `maven.test.failure.ignore` in configuration tag of an execution like this:

```xml

true

```

#### Skipping Execution

Each frontend build tool and package manager allows skipping execution.
This is useful for projects that contain multiple builds (such as a module containing Java and frontend code).

**Note** that if the package manager (npm or yarn) is skipped, other build tools will also need to be skipped because they
would not have been downloaded.
For example, in a project using npm and gulp, if npm is skipped, gulp must also be skipped or the build will fail.

Tools and property to enable skipping

* npm `-Dskip.npm`
* yarn `-Dskip.yarn`
* bower `-Dskip.bower`
* bun `-Dskip.bun`
* grunt `-Dskip.grunt`
* gulp `-Dskip.gulp`
* jspm `-Dskip.jspm`
* karma `-Dskip.karma`
* webpack `-Dskip.webpack`

## Eclipse M2E support

This plugin contains support for M2E, including lifecycle mappings and support for incremental builds in Eclipse.
The `install-node-and-npm` goal will only run on a full project build. The other goals support incremental builds
to avoid doing unnecessary work. During an incremental build the `npm` goal will only run if the `package.json` file
has been changed. The `grunt` and `gulp` goals have new `srcdir` and `triggerfiles` optional configuration options; if
these are set they check for changes in your source files before being run. See the wiki for more information.

## Helper scripts

During development, it's convenient to have the "npm", "bower", "grunt", "gulp" and "karma" commands
available on the command line. If you want that, use [those helper scripts](frontend-maven-plugin/src/it/example%20project/helper-scripts)!

## To build this project:

Run `$ mvn clean install`

## Issues, Contributing

Please post any issues on the [Github's Issue tracker](https://github.com/eirslett/frontend-maven-plugin/issues).
[Pull requests](https://github.com/eirslett/frontend-maven-plugin/pulls) are welcome!
You can find a full list of [contributors here](https://github.com/eirslett/frontend-maven-plugin/graphs/contributors).

## License

[Apache 2.0](LICENSE)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/eirslett/frontend-maven-plugin

Awesome Lists containing this project

README