Vite 中文文档

frontend-maven-plugin


This plugin downloads/installs Node and NPM locally for your project, runs npm install, and then any combination of Bower, Grunt, Gulp, Jspm, Karma, or Webpack. It's supposed to work on Windows, OS X and Linux.

If you prefer Yarn over NPM 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 2support take a look at the wiki.

Installation


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

  1. ``` xml
  2. <plugins>
  3.     <plugin>
  4.         <groupId>com.github.eirslett</groupId>
  5.         <artifactId>frontend-maven-plugin</artifactId>
  6.         
  7.         <version>LATEST_VERSION</version>
  8.         ...
  9.     </plugin>
  10. ...
  11. ```

Usage


Have a look at the example project, 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

Installing node and npm
Installing node and yarn
Running
npm
yarn
bower
grunt
gulp
jspm
karma
webpack

Configuration
Working Directory
Installation Directory
Proxy Settings
Environment variables
Ignoring Failure
Skipping Execution

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. 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).

  1. ``` xml
  2. <plugin>
  3.     ...
  4.     <executions>
  5.         <execution>
  6.             
  7.             <phase>generate-resources</phase>
  8.         </execution>
  9.     </executions>
  10.     <configuration>
  11.         <nodeVersion>v4.6.0</nodeVersion>

  13.         
  14.         <npmVersion>2.15.9</npmVersion>

  16.         
  17.         <downloadRoot>http://myproxy.example.org/nodejs/
  18.     </configuration>
  19. </plugin>
  20. ```

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:

  1. ``` xml
  2. <plugin>
  3.     ...
  4.     <configuration>
  5.         
  6.         <nodeDownloadRoot>http://myproxy.example.org/nodejs/
  8.         <serverId>server001</serverId>
  9.         
  10.         <npmDownloadRoot>https://myproxy.example.org/npm/
  11.     </configuration>
  12. </plugin>
  13. ```

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

  1. ``` xml
  2. <plugin>
  3.     ...
  4.     <execution>
  5.         
  6.         <phase>generate-resources</phase>
  7.     </execution>
  8.     <configuration>
  9.         <nodeVersion>v6.9.1</nodeVersion>
  10.         <yarnVersion>v0.16.1</yarnVersion>

  12.         
  13.         <nodeDownloadRoot>http://myproxy.example.org/nodejs/
  14.         
  15.         <yarnDownloadRoot>http://myproxy.example.org/yarn/        
  16.     </configuration>
  17. </plugin>
  18. ```

Running npm


All node packaged modules will be installed in the node_modules folder in your working directory. By default, colors will be shown in the log.

  1. ``` xml
  2. <execution>
  3.     <id>npm install</id>
  4.     <goals>
  5.         <goal>npm</goal>
  6.     </goals>

  8.     
  9.     <phase>generate-resources</phase>

  11.     <configuration>
  12.         
  13.         <arguments>install</arguments>
  14.     </configuration>
  15. </execution>
  16. ```

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, enabling you to execute the CLI of installed packages without a run-script, or even packages that aren't installed at all.

  1. ``` xml
  2. <execution>
  3.     <id>say hello</id>
  4.     <goals>
  5.         <goal>npx</goal>
  6.     </goals>

  8.     <phase>generate-resources</phase>

  10.     <configuration>
  11.         <arguments>cowsay hello</arguments>
  12.     </configuration>
  13. </execution>
  14. ```

Running yarn


As with npm above, all node packaged modules will be installed in the node_modules folder in your working directory.

  1. ``` xml
  2. <execution>
  3.     <id>yarn install</id>
  4.     <goals>
  5.         <goal>yarn</goal>
  6.     </goals>
  7.     <configuration>
  8.         
  9.         <arguments>install</arguments>
  10.     </configuration>
  11. </execution>
  12. ```

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:

  1. ``` sh
  2. yarn config set registry <your_registry_url>
  3. yarn install

  5. ```

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:

  1. ``` sh
  2. registry=<your_registry_url>

  4. ```

Also you can set a registry using a tag npmRegistryURL

  1. ``` sh
  2. <execution>
  3.     <id>yarn install</id>
  4.     <goals>
  5.         <goal>yarn</goal>
  6.     </goals>
  7.     <configuration>
  8.         
  9.         <arguments>install</arguments>
  11. <npmRegistryURL>http://myregistry.example.org/
  12.     </configuration>
  13. </execution>

  15. ```

Running bower


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

  1. ``` xml
  2. <execution>
  3.     <id>bower install</id>
  4.     <goals>
  5.         <goal>bower</goal>
  6.     </goals>

  8.     <configuration>
  9.         
  10.         <arguments>install</arguments>
  11.     </configuration>
  12. </execution>
  13. ```

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.

  1. ``` xml
  2. <execution>
  3.     <id>grunt build</id>
  4.     <goals>
  5.         <goal>grunt</goal>
  6.     </goals>

  8.     
  9.     <phase>generate-resources</phase>

  11.     <configuration>
  12.         
  13.         <arguments>build</arguments>
  14.     </configuration>
  15. </execution>
  16. ```

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.

  1. ``` xml
  2. <execution>
  3.     <id>gulp build</id>
  4.     <goals>
  5.         <goal>gulp</goal>
  6.     </goals>

  8.     
  9.     <phase>generate-resources</phase>

  11.     <configuration>
  12.         
  13.         <arguments>build</arguments>
  14.     </configuration>
  15. </execution>
  16. ```

Running jspm


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

  1. ``` xml
  2. <execution>
  3.     <id>jspm install</id>
  4.     <goals>
  5.         <goal>jspm</goal>
  6.     </goals>

  8.     <configuration>
  9.     
  10.         <arguments>install</arguments>
  11.     </configuration>
  12. </execution>
  13. ```

Running Karma


  1. ``` xml
  2. <execution>
  3.     <id>javascript tests</id>
  4.     <goals>
  5.         <goal>karma</goal>
  6.     </goals>

  8.     
  9.     <phase>test</phase>

  11.     <configuration>
  12.         
  13.         <karmaConfPath>src/test/javascript/karma.conf.ci.jskarmaConfPath>
  14.     </configuration>
  15. </execution>
  16. ```

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 or through gulp instead, as part of the grunt or gulp execution. That will help to separate your frontend and backend builds even more.

Running Webpack


  1. ``` xml
  2. <execution>
  3.     <id>webpack build</id>
  4.     <goals>
  5.         <goal>webpack</goal>
  6.     </goals>

  8.     
  9.     <phase>generate-resources</phase>

  11.     <configuration>
  12.         
  13.         <arguments>-p</arguments>
  14.     </configuration>
  15. </execution>
  16. ```

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:

  1. ``` xml
  2. <plugin>
  3.     <groupId>com.github.eirslett</groupId>
  4.     <artifactId>frontend-ma