{{ message }}
\n{{ message }}
\n {{> footer}}\n{{ upper-case message }}
\n {{> footer}}\n\n\n```\n\nAlso, suppose you have the following partial file (`partials/footer.hbs`):\n\n```html\n\n```\n\nNext, create the following `vite.config.js` file:\n\n```javascript\nimport { defineConfig } from 'vite';\nimport handlebarsPlugin from '@cpulvermacher/vite-plugin-handlebars';\nimport path from 'path';\n\nexport default defineConfig({\n plugins: [\n handlebarsPlugin({\n partialsDirectoryPath: path.resolve(__dirname, 'partials'),\n transformIndexHtmlOptions: {\n context: () => ({\n message: 'Hello, world!'\n }),\n helpers: {\n 'upper-case': (str) => str.toUpperCase(),\n },\n },\n })\n ]\n});\n```\n\nAs a result, the `index.html` file generated by running `vite build` will be as follows:\n\n```html\n\n\n...\n\nHELLO, WORLD!
\n \n\n\n```\n\n# Installation\n\n```shell\nnpm install @cpulvermacher/vite-plugin-handlebars --save-dev\n```\n\n# Usage\n\nTo use this plugin in your Vite project, modify your `vite.config.js` or `vite.config.ts` file as follows:\n\n```javascript\n// vite.config.js\nimport { defineConfig } from 'vite';\nimport handlebarsPlugin from '@cpulvermacher/vite-plugin-handlebars';\n\nexport default defineConfig({\n plugins: [\n handlebarsPlugin()\n ]\n});\n```\n\n## Options\n\nThis plugin can be configured with the following options:\n\n* `templateFileExtension` (string) - Specifies the extension of Handlebars template files. Defaults to `hbs` if omitted.\n* `partialsDirectoryPath` (string) - Specifies the path to the directory containing partial template files to be included in Handlebars template files. If omitted, partial template files are not registered.\n* `optimizePartialRegistration` (boolean) - Set to true to optimize the partial registration. This option is effective only when `partialsDirectoryPath` is set. If omitted, the plugin does not optimize the partial registration. If true, the plugin does not register the partials that are already registered.\n* `compileOptions` (object) - Specifies the options to be passed to the Handlebars compiler. If omitted, the default options are used.\n* `transformIndexHtmlOptions` (object) - This is an option to specify when treating the index file as a Handlebars template file during the Vite build process. If this option is not specified, the index file will not be transformed.\n\nThese options can be specified as arguments to the `handlebarsPlugin` function. Below is an example that specifies `handlebars` as the template file extension and `templates/partials` as the directory containing partial template files.\n\n```javascript\n// vite.config.js\nimport { defineConfig } from 'vite';\nimport handlebarsPlugin from '@cpulvermacher/vite-plugin-handlebars';\nimport path from 'path';\n\nexport default defineConfig({\n plugins: [\n handlebarsPlugin({\n templateFileExtension: 'handlebars',\n partialsDirectoryPath: path.resolve(__dirname, 'templates', 'partials'),\n optimizePartialRegistration: true,\n })\n ]\n});\n```\n\nThe `compileOptions` are the various options applied when compiling template files in Handlebars. For details on each option, please refer to the [Handlebars documentation](https://handlebarsjs.com/api-reference/compilation.html#handlebars-compile-template-options).\n\nWhen building with the Vite build or preview command, if you want to treat the index file (typically the `index.html` file) as a Handlebars template file and perform a transformation, specify the `transformIndexHtmlOptions` option. This option is an object that can contain the following properties:\n\n* `context` (object or function) - Specifies the context object to be passed to the Handlebars template file. If a function is specified, the function is called and the return value is used as the context object.\n* `helpers` (object) - Specifies the helper functions to be passed to the Handlebars template file.\n\nIf you want to transform the index file as a Handlebars template file without registering any context or helpers, specify an empty object as shown below.\n\n```javascript\n// vite.config.js\nimport { defineConfig } from 'vite';\nimport handlebarsPlugin from '@cpulvermacher/vite-plugin-handlebars';\nimport path from 'path';\n\nexport default defineConfig({\n plugins: [\n handlebarsPlugin({\n templateFileExtension: 'handlebars',\n partialsDirectoryPath: path.resolve(__dirname, 'templates', 'partials'),\n transformIndexHtmlOptions: {},\n })\n ]\n});\n```\n\nPlease note that the `context` option and `helpers` option specified in the `transformIndexHtmlOptions` are only applied during Vite's build process. They are not applied when importing Handlebars template files using import in `.ts` or `.js` files.\n\nAdditionally, when there are multiple index files in an MPA, use `rollupOptions` as shown below.\n\n```javascript\nexport default defineConfig({\n ...\n build: {\n rollupOptions: {\n input: {\n index: resolve(__dirname, 'index.html'),\n alternative: resolve(__dirname, 'alternative.html'),\n },\n },\n },\n});\n```\n\n# Samples\n\nThe `integration` directory contains a sample Vite project using this plugin. You can start this sample project by following these steps:\n\n```sh\n$ git clone https://github.com/cpulvermacher/vite-plugin-handlebars.git\n$ cd vite-plugin-handlebars\n$ npm install\n$ npm run integration-preview\n```\n\nAfter the preview server starts, please access `http://localhost:4173` in your web browser.\n\n# Contributing\n\nIf you would like to contribute to this plugin, please follow these steps:\n\n1. Register an issue and describe what you would like to contribute.\n2. When you want to contribute by sending code, fork this repository, create a new branch, make your code changes, and submit a pull request.\n\n# License\n\nFor the license of this plugin, please refer to the [LICENSE](https://github.com/cpulvermacher/vite-plugin-handlebars/blob/main/LICENSE) file.\n","readmeFilename":"README.md"}