hmpl-loader/README.md

Loader for files with hpml extension for webpack

# hmpl-loader

[![npm-version](https://img.shields.io/npm/v/hmpl-loader?logo=npm&color=fff)](https://www.npmjs.com/package/hmpl-loader)

This loader was created for files with the `.hmpl` extension, which are converted using the [hmpl-js](https://www.npmjs.com/package/hmpl-js) package. This loader is designed for webpack.

> Loader works with hmpl-js version 1.0.4 or higher

## Installation

```bash
npm i -D hmpl-loader
```

## Usage:

In the `webpack.config.js` file you can specify the following lines of code:

```javascript
module.exports = {
  module: {
    rules: [
      {
        test: /\.hmpl$/i,
        use: ["hmpl-loader"],
      },
    ],
  },
};
```

After `webpack.config.js` has been changed, in js files (for example, in `main.js`), you can import a file with the `.hmpl` extension and receive a [template function](https://spec.hmpl-lang.dev/#template-function) in response.

### main.hmpl

```hmpl
<div>
  {{#request src="/api/test"}}
  {{/request}}
</div>
```

### main.js

```javascript
const templateFn = require("./main.hmpl");

const elementObj = templateFn();
```

## Options

The loader supports the compile function options.

```javascript
module.exports = {
  module: {
    rules: [
      {
        test: /\.hmpl$/i,
        use: {
          loader: "hmpl-loader",
          options: {
            memo: true,
            autoBody: {
              formData: true,
            },
          },
        },
      },
    ],
  },
};
```

The list of options is described in the documentation [here](https://spec.hmpl-lang.dev/#options).

## Changelog

[Changelog](https://github.com/hmpl-language/hmpl-loader/releases)

## License

[Licensed under MIT](https://github.com/hmpl-language/hmpl-loader/blob/master/LICENSE)