https://github.com/camunda/camunda-modeler-webpack-plugin

Webpack plugins to easily configure Camunda Modeler extensions.
https://github.com/camunda/camunda-modeler-webpack-plugin

camunda-modeler camunda-modeler-plugin webpack webpack-plugin

Last synced: about 2 months ago
JSON representation

Webpack plugins to easily configure Camunda Modeler extensions.

• Host: GitHub
• URL: https://github.com/camunda/camunda-modeler-webpack-plugin
• Owner: camunda
• License: mit
• Created: 2022-04-11T12:57:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-24T14:29:00.000Z (12 months ago)
• Last Synced: 2024-10-31T07:35:18.455Z (2 months ago)
• Topics: camunda-modeler, camunda-modeler-plugin, webpack, webpack-plugin
• Language: JavaScript
• Homepage:
• Size: 146 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# camunda-modeler-webpack-plugin

[![Build Status](https://github.com/pinussilvestrus/camunda-modeler-webpack-plugin/workflows/CI/badge.svg)](https://github.com/pinussilvestrus/camunda-modeler-webpack-plugin/actions?query=workflow%3ACI)

Webpack plugin to easily configure Camunda Modeler extensions.

## Installation

```sh

npm i --save-dev camunda-modeler-webpack-plugin

```

## Usage

Add the plugin to your webpack config.

```js

const CamundaModelerWebpackPlugin = require('camunda-modeler-webpack-plugin');

module.exports = {

  plugins: [

    new CamundaModelerWebpackPlugin()

  ]

};

```

## Configuration

You can pass options to customize the resulting webpack configuration. 

For example, in case you build a plugin to only extend the Properties Panel without using JSX syntax:

```js

plugins: [

  new CamundaModelerWebpackPlugin({

    type: 'propertiesPanel',

    propertiesPanelLoader: false

  })

]

```

Following options are available:

| Name | Default | Description |

| ----------- | ----------- | ----------- |

| `propertiesPanelAlias` | true | Append Properties Panel `alias` configuration |

| `propertiesPanelLoader` | true | Append Properties Panel `babel-loader` configuration (requires `@babel/core` dependency) |

| `reactAlias` | true | Append React `alias` configuration |

| `reactLoader` | true | Append React `babel-loader` configuration (requires `@babel/core` dependency) |

| `type` |  | Specific type of the Camunda Modeler Plugin. Only [the configuration](./src/config/) of the given type will be appended. Allowed values: `react`, `propertiesPanel` |

## Resources

* [Camunda Modeler plugins documentation](https://docs.camunda.io/docs/components/modeler/desktop-modeler/plugins)

* [Camunda Modeler plugin helpers](https://github.com/camunda/camunda-modeler-plugin-helpers)

## License

MIT