webpack-war-plugin

KO | EN

gitlite — search

#python #react #ai #golang #machine-learning #rust #deep-learning #docker #awesome-list #pytorch #ios #mcp #openai #open-source

webpack-war-plugin

(★ 14)

Webpack plugin for bundling build outputs into a WAR archive

webpack-war-plugin Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Webpack WAR plugin
[![Build Status](https://travis-ci.org/DevWurm/webpack-war-plugin.svg?branch=master)](https://travis-ci.org/DevWurm/webpack-war-plugin)
[![Coverage Status](https://coveralls.io/repos/github/DevWurm/webpack-war-plugin/badge.svg?branch=master)](https://coveralls.io/github/DevWurm/webpack-war-plugin?branch=master)
[![Gitter](https://badges.gitter.im/DevWurm/webpack-war-plugin.svg)](https://gitter.im/DevWurm/webpack-war-plugin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This is a [Webpack](https://webpack.github.io/) plugin which simplifies and automates the creation of a [Web Application Archive (WAR)](https://en.wikipedia.org/wiki/WAR_(file_format)) from your Webpack build outputs and other project files. This can be useful if you want to deploy your static / Single Page Web App or your applications web frontend to a Java (EE) Application server.

## Installation
You can install the plugin via npm

```bash
npm install --dev webpack-war-plugin
```

## Usage
### Basic Usage
To add the webpack-war-plugin to your build just add an instance of `WebpackWarPlugin` to the `plugins` section of your Webpack configuration
```javascript
const { WebpackWarPlugin } = require('webpack-war-plugin');

module.exports = {
  ...,
  plugins: [
    new WebpackWarPlugin(),
    ...
  ],
  ...
};
```
By default an archive containing all emitted Webpack build outputs is generated in the output directory of your Webpack build. It is named like your project.

### Configuration
You can influence the generated archive by supplying a configuration object of the following structure to the plugins constructor:
```typescript
type WebpackWarPluginOptions = {
    archiveName?: string;
    webInf?: string;
    additionalElements?: {
        path: string;
        destPath?: string;
    }[];
    archiverOptions?: {}
};
```
| Option | Effect |
| --- | --- |
| `archiveName` *[optional]* | Sets the output name of the archive |
| `webInf` *[optional]* | Specifies a path to a directory (or file) which will be included into the archive with the path `WEB-INF` |
| `additionalElements` *[optional]* | Specifies multiple files or directories, which will be included in the archive. Each entry is a object with the following properties: `path` (The path of the source element), `destPath` (*[optional]* The path of the specified file / directory inside of the archive [by default `path` is used])  |
| `archiverOptions` *[optional]* | Specifies the options that should be used by `archiver` (used to create the archive). See https://archiverjs.com/docs/ for more information. |

### Example
The following plugin configuration:
```javascript
const { WebpackWarPlugin } = require('webpack-war-plugin');

module.exports = {
  entry: {
    file1: './src/file1.js'
  },
  ...,
  plugins: [
    new WebpackWarPlugin({
      archiveName: 'archive',
      webInf: './web-inf',
      additionalElements: [
        { path: 'context/context.xml', destPath: 'META-INF/context.xml'},
        { path: 'package.json' },
        { path: 'images', destPath: 'assets/images' }
      ],
      archiverOptions: {
        zlib: {
          level: 9
        }
      }
    }),
    ...
  ],
  ...
};

## Development
### Typescript
The plugin is built with [Typescript](http://www.typescriptlang.org/) and the resulting package contains the corresponding typings.

### Building
After checking out the project you can build transpile the Typescript via
```bash
npm run build
```
The build output is stored in `dist`.

### Testing
#### Unit tests
Unit tests are named `[tested-component].spec.ts`. 
They can be run via [Mocha](https://mochajs.org/) with
```bash
npm run test
```
Test coverage is measured via [nyc](https://github.com/istanbuljs/nyc) and can be triggered with
```bash
npm run test:coverage
```

#### Functional tests
Functional test fixtures are located in `functional_tests`.
To set up all fixtures run
```bash
npm run test:functional:setup
```
To execute the tests via Mocha run
```bash
npm run test:functional
```

### Continuous integration
Continious integration is realized via [Travis-CI](https://travis-ci.org/DevWurm/webpack-war-plugin). Coverage reports are shown on [Coveralls](https://coveralls.io/github/DevWurm/webpack-war-plugin). Deployments to NPM are automatically triggered via Git tags.

## Licensing
The app is distributed under the MIT License (read [`LICENSE`](LICENSE) for more information).
Copyright (c) 2017 Leo Lindhorst

## Collaborating
I really appreciate any kind of collaboration! 
You can use the [GitHub issue tracker](https://github.com/DevWurm/webpack-war-plugin/issues) for bugs and feature requests or [create a pull request](https://github.com/DevWurm/webpack-war-plugin/pulls) to submit
changes.
If you don't want to use these possibilities, you can also write me an email to
<a href='mailto:devwurm@devwurm.net'>devwurm@devwurm.net</a>.

## Contact
If you have any questions, ideas, etc. feel free to contact me: 
DevWurm 
Email: <a href='mailto:devwurm@devwurm.net'>devwurm@devwurm.net</a> 
Jabber: devwurm@conversations.im 
Twitter: [@DevWurm](https://twitter.com/DevWurm)

webpack-war-plugin

webpack-war-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

webpack-war-plugin

webpack-war-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README