open-index/open-npm huggingface dataset:
npm package: @tadayosi/artemis-plugin-npm
Description: Artemis plugin module for the Hawtio web console
Latest version: 1.0.1

# NPM Package for Artemis Plugin

## Prerequisites

To build and publish the package the following tools need to be installed locally:

- [Node.js](http://nodejs.org/)
- [Yarn](https://yarnpkg.com/)
- [Maven](https://maven.apache.org/)

## Build

Run the following command:

```
yarn build
```

This will download the artifact `org.apache.activemq:artemis-plugin` and unpack the plugin js files into `target/` directory. It will then compile them into `dist/artemis-plugin.<hash>.js`.

## Publish

Once build is successful, make sure to update the `main` field in `package.json` with the output file name under `dist/`, as the content hash changes at each build.

```json
  "main": "dist/artemis-plugin.d0c8c95f.js",
```

To publish the npm package, run the following command:

```
yarn publish
```

Once successfully published, make sure to push the published tag to the repository:

```
git push origin master --tags
```
npm package: @tadayosi/branding-plugin
Description: A branding plugin example for Hawtio
Latest version: 0.1.0

# Hawtio branding plugin example

[branding-plugin](https://github.com/hawtio/hawtio/tree/master/examples/branding-plugin) demonstrates how you can customise the application branding information such as title and logo, as well as login page information, through Hawtio plugin mechanism.

The important bits are:

- **`pom.xml`** -- When building plugins with Maven there is a few nice tricks that can be used to ease the build process. Have a look in this project's `pom.xml` to see how the build filters the `web.xml` and uses the `maven-antrun-plugin` to discover JavaScript files. The project creates a war file that can be deployed in various application services and is also OSGi-ified so it deploys nicely into Apache Karaf.

- **`src/main/webapp/plugin/brandingPlugin.js`** -- This is the main entry point of the plugin, and well, it is the only plugin JavaScript file. It defines a JavaScript module called `Branding` and an AngularJS (1.x) module called `branding-plugin` and pass the AngularJS module name to Hawtio's plugin loader. It doesn't define any component other than running module initialisation where it overwrites `hawtconfig.json`. Besides the `hawtioPluginLoader` call, this is mostly fairly standard AngularJS stuff.

## Installation

### WildFly / Apache Tomcat / Jetty

Copy the branding-plugin war file as the following name:

    branding-plugin.war

to the `standalone/deployments/` directory of WildFly or the `deploy/` directory of Apache Tomcat / Jetty.

### Apache Karaf / Red Hat Fuse (on Karaf)

From the CLI type:

    install -s mvn:io.hawt/branding-plugin/2.8.0/war

(Substitute `2.8.0` with the version of choice.)

### Spring Boot

For Spring Boot, you don't need an extra plugin war like this example to customise `hawtconfig.json`. You can simply put `hawtconfig.json` file into the Spring Boot application to overwrite the information.

See [Spring Boot Authentication example](https://github.com/hawtio/hawtio/tree/master/examples/springboot-authentication) instead for more details.
npm package: @tadayosi/simple-plugin
Description: An example custom plugin for Hawtio
Latest version: 0.1.0

# Hawtio simple plugin example

[simple-plugin](https://github.com/hawtio/hawtio/tree/master/examples/simple-plugin) is an introduction to writing a standalone Hawtio plugin that can be deployed in a server alongside the main `hawtio.war` application.

The important bits are:

- **`pom.xml`** -- When building plugins with Maven there is a few nice tricks that can be used to ease the build process. Have a look in this project's `pom.xml` to see how the build filters the `web.xml` and uses the `maven-antrun-plugin` to discover JavaScript files. The project creates a war file that can be deployed in various application services and is also OSGi-ified so it deploys nicely into Apache Karaf.

- **`src/main/webapp/plugin/simplePlugin.js`** -- This is the main entry point of the plugin, and well, it is the only plugin JavaScript file. It defines a JavaScript module called `Simple` and an AngularJS (1.x) module called `simple-plugin` and pass the AngularJS module name to Hawtio's plugin loader. It also defines the one component (= HTML template + controller) used in the plugin. Besides the `hawtioPluginLoader` call, this is mostly fairly standard AngularJS stuff.

## Installation

### WildFly / Apache Tomcat / Jetty

Copy the simple-plugin war file as the following name:

    simple-plugin.war

to the `standalone/deployments/` directory of WildFly or the `deploy/` directory of Apache Tomcat / Jetty.

### Apache Karaf / Red Hat Fuse (on Karaf)

From the CLI type:

    install -s mvn:io.hawt/simple-plugin/2.8.0/war

(Substitute `2.8.0` with the version of choice.)

### Spring Boot

For Spring Boot, you don't need an extra war like this example to deploy a custom plugin. There is a better way, and you can directly put a JavaScript plugin into the Spring Boot application to extend Hawtio features.

See [Spring Boot example](https://github.com/hawtio/hawtio/tree/master/examples/springboot) instead for more details.