I'm a partial
\n```\n\n## Inline Partials\n\nIf you are using Common JS partial resolution (setting the `--traverse` flag) and you are using Handlebars 4.0.0 or later, you can still use inline partials. Make sure to not use inline partial names that conflict with `node_module` dependencies. The inline partial will be used over a dependency reference.\n\n\n## package.json\n\nTransform can be configured from the package.json too.\n\n```json\n{\n \"browserify\": {\n \"transform\": [\n [\n \"hbsfy\",\n {\n \"extensions\": [\n \"html\"\n ],\n \"precompilerOptions\": {\n \"knownHelpersOnly\": true,\n \"knownHelpers\": {\n \"myUltimateHelper\": true\n }\n }\n }\n ]\n ]\n }\n}\n```\n\nThe `precompiler` and `compiler` keys are naturally available too.\n\nSee [module-deps\ndocumentation](https://github.com/substack/module-deps#packagejson-transformkey)\nfor more information as this feature is implemented there (it's a part of\nBrowserify itself).\n\n## Programmatic usage\n\nThe `configure` method of the transform can be used to create new transforms\nwith different defaults.\n\n```javascript\nvar hbsfy = require(\"hbsfy\").configure({\n extensions: [\"html\"]\n});\n\nvar browserify = require(\"browserify\");\nvar b = browserify(\"./index.js\");\nb.transform(hbsfy);\nb.bundle().pipe(fs.createWriteStream(\"./bundle.js\"));\n```\n\n### Helpers\n\nTo register custom helpers, require the runtime and run `registerHelper` to\ncreate helper:\n\n```javascript\nvar Handlebars = require(\"hbsfy/runtime\");\nHandlebars.registerHelper(\"upcase\", function(s) {\n return s.toUpperCase();\n});\n```\n\n### Partials\n\nPartials can be created by giving precompiled template to the `registerPartial`\nfunction.\n\n```javascript\nHandlebars.registerPartial('link', require(\"./partial.hbs\"));\n```\n\nCheckout the example folder for details.\n\nNote: if using the `--traverse` option, partial registration is automatic.\n\n### .compile\n\nThis synchronous method can be used to enable all hsbfy functionality in another environment, such as node or a test runner (such as mocha).\n\n```js\n// mocha-hbs.js\nvar fs = require(\"fs\");\nvar hbsfy = require(\"hbsfy\");\n\nrequire.extensions['.hbs'] = function (module, filename) {\n var file = fs.readFileSync(filename, \"utf8\");\n var opts = { traverse: true };\n return module._compile(hbsfy.compile(file, opts), filename);\n}\n```\n\n```sh\n$ mocha -r hbs:./mocha-hbs.js tests/\n```\n\nRemember to register your custom helpers as well! Ideally your templates themselves `require` your helpers and runtime, and call `registerHelper`. But if they don't, all helpers can be loaded at once as part of the require hook above:\n\n```js\n// mocha-hbs.js\nvar fs = require(\"fs\");\nvar hbsfy = require(\"hbsfy\");\nvar runtime = require(\"hbsfy/runtime\");\nvar helpers = require(\"./path/to/my/exported/helpers\");\n\nObject.keys(helpers).forEach(function (key) {\n runtime.registerHelper(key, helpers[key]);\n});\n\nrequire.extensions['.hbs'] = function (module, filename) {\n var file = fs.readFileSync(filename, \"utf8\");\n var opts = { traverse: true };\n return module._compile(hbsfy.compile(file, opts), filename);\n}\n```\n\n### Process output HTML string\n\nThis option accepts a function which takes one argument (the template file content) and returns a string which will be used as the source for the precompiled template object. The example below removes leading and trailing spaces to shorten templates.\n\n```\nhbsfy.configure({\n processContent: function(content) {\n content = content.replace(/^[\\x20\\t]+/mg, '').replace(/[\\x20\\t]+$/mg, '');\n content = content.replace(/^[\\r\\n]+/, '').replace(/[\\r\\n]*$/, '\\n');\n return content;\n }\n});\n```\n\n## Changelog\n\n### 2.8.0\n\n - Support block partials, ignoring templates with `@` prefix. [#60](https://github.com/epeli/node-hbsfy/pull/60)\n\n### 2.7.0\n\n - Allow inline partials when using `--traverse`. [#54](https://github.com/epeli/node-hbsfy/pull/54)\n\n### 2.6.0\n\n - Add `processContent` option. [#50](https://github.com/epeli/node-hbsfy/pull/50)\n\n### 2.5.0\n\n - Export `findPartials` and `compile` for use in utilities / test frameworks [#49](https://github.com/epeli/node-hbsfy/pull/49).\n\n### 2.4.1\n\n - Always strip BOM [#18](https://github.com/epeli/node-hbsfy/pull/18), [#46](https://github.com/epeli/node-hbsfy/pull/46)\n\n### 2.4.0\n\n - support handlebars 2, 3, 4\n\n### 2.3.1\n\n - Handle `null` nodes when traversing Handlebars AST.\n\n### 2.3.0\n\n - Allow resolving / requiring partials using node's module resolution algorithm (`--traverse`). [#47](https://github.com/epeli/node-hbsfy/pull/47)\n\n### 2.2.1\n\n - Emit compile errors instead of crashing. [#38](https://github.com/epeli/node-hbsfy/pull/38)\n\n### 2.2.0\n\n - Support for compiler options [#29](https://github.com/epeli/node-hbsfy/pull/29)\n\n### 2.1.0\n\n - Subargs options for alternate precompilers and compilers [#31](https://github.com/epeli/node-hbsfy/pull/31)\n\n### 2.0.0\n\n - Support Browserify [subargs](https://github.com/substack/node-browserify/blob/5cbf55a4397f300df69be574b59f3f30ac01b9c2/bin/advanced.txt#L81-L90)\n - The `configure` method does not mutate the inner state of the module\n anymore\n - Instead it returns a new transform function.\n - Handlebars is not a peerDependency anymore\n - It must be manually installed\n - This relaxes completely the version binding of Handlebars - it is now possible to try Handlebars 2.0 alpha\n\n### 1.3.0\n\n - Support Handlebars 1.3\n - Now uses the official runtime api\n\n### 1.0.0\n\n - Remove `handlebars-runtime` dependency and depend directly on\n the `handlebars` module as a [peer dependency][].\n - Runtime must be now required with `require(\"hbsfy/runtime\")` instead of\n `require(\"handlebars-runtime\")`.\n - Thanks to @kamicane for teaching me how to do this.\n - Option to configure template extensions\n\n\n[Handlebars]: http://handlebarsjs.com/\n[Browserify]: https://github.com/substack/node-browserify\n[peer dependency]: http://blog.nodejs.org/2013/02/07/peer-dependencies/\n","maintainers":[{"email":"esa-matti@suuronen.org","name":"esamatti"},{"email":"kirbysayshi@gmail.com","name":"kirbysayshi"}],"time":{"modified":"2023-10-19T09:14:07.891Z","created":"2013-03-20T19:03:59.516Z","0.1.0":"2013-03-20T19:04:02.760Z","0.1.1":"2013-03-21T23:20:51.132Z","0.1.2":"2013-03-25T19:47:36.302Z","0.1.3":"2013-06-07T06:34:00.809Z","0.1.4":"2013-06-07T06:36:56.594Z","0.1.5":"2013-06-17T07:28:11.170Z","1.0.0":"2013-11-03T12:22:06.754Z","1.3.0":"2014-01-15T08:44:23.946Z","1.3.1":"2014-01-15T08:59:53.447Z","1.3.2":"2014-02-12T22:10:20.490Z","2.0.0":"2014-07-21T21:31:54.238Z","2.1.0":"2014-08-25T13:49:26.277Z","2.2.0":"2014-09-23T09:48:18.454Z","2.2.1":"2014-12-04T07:10:32.832Z","2.3.0":"2015-09-09T21:36:07.131Z","2.3.1":"2015-09-10T16:10:16.158Z","2.4.0":"2015-10-11T07:51:13.120Z","2.4.1":"2015-10-12T23:55:14.844Z","2.5.0":"2016-02-09T21:36:59.397Z","2.5.1":"2016-02-29T23:46:32.259Z","2.6.0":"2016-04-07T03:51:02.312Z","2.7.0":"2016-04-18T15:11:50.382Z","2.8.0":"2017-10-09T01:25:00.439Z","2.8.1":"2017-10-09T04:24:23.833Z"},"author":{"name":"Esa-Matti Suuronen"},"repository":{"type":"git","url":"git+https://github.com/epeli/node-hbsfy.git"},"readmeFilename":"README.md","users":{"raffiminassian":true,"knownasilya":true,"egauci":true,"ysk8":true,"cypark":true,"gregbabula":true,"jclo":true,"bense4ger":true,"nomemires":true,"evanj0hnson":true,"maxwang":true,"highlanderkev":true,"monjer":true,"ruzzll":true,"cueedee":true},"homepage":"https://github.com/epeli/node-hbsfy#readme","keywords":["handlebars","browserify","js","plugin","transform","browserify-transform"],"bugs":{"url":"https://github.com/epeli/node-hbsfy/issues"},"license":"MIT"}