Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SafeString to context (or use duck-typing) #886

dominicbarnes opened this issue Oct 21, 2014 · 3 comments

Add SafeString to context (or use duck-typing) #886

dominicbarnes opened this issue Oct 21, 2014 · 3 comments


Copy link

@dominicbarnes dominicbarnes commented Oct 21, 2014

Hey there, I'm having trouble with one aspect of using handlebars in a node setting.

When I want to share helpers from various places, and I want to use handlebars.SafeString, I am finding it difficult, since the instanceof check will only pass if the SafeString object came from the local instance. With node, there could be several versions of handlebars installed, but only the local one passes.

Passing around a single instance of handlebars to all of these modules is not ideal, especially for such a trivial thing. I have a few proposals (in order of preference/ease-of-implementation)

  1. add SafeString to the context of the helper, so I don't need any other external reference for it to work:
exports.myHelper = function (options) {
  return new options.SafeString("foo");
  1. use duck-typing within Utils.escapeExpression, rather than (or in addition to) instanceof:
} else if (typeof string === "object" && typeof string.string === "string") {
  // this test may not be accurate, this is just an example
  1. execute helpers using the handlebars instance as this
exports.myHelper = function () {
  return new this.SafeString("foo");

For now, I can just use {{{ to accomplish what I need. So, this is not "urgent", but I would like to start the discussion. :)

Copy link

@dominicbarnes dominicbarnes commented Oct 21, 2014

As another thought on option 1: if SafeString is added to the exports of Utils, perhaps all of Utils could be added to the context?

exports.myHelper = function (string, options) {
  var substring = options.utils.escapeExpression(string);
  return new options.utils.SafeString("<b>" + myString + "</b>");

I actually have a specific helper in mind that would use both of these methods... and this would be awesome to have.

Copy link

@kpdecker kpdecker commented Oct 26, 2014

We can look into the duck typing option. I've never really liked instanceof and it does get really bad in Node. (You can handle some of this in a bit safer manner by using npm dedupe but this does not always work)

Right now I'm considering adding a toHTML method to SafeString so that any object implementing this can control their own flow. I need to decide if this is a breaking change or not as it may cause issues in the event that an object is passed currently that implements a toHTML method.

@kpdecker kpdecker added this to the 2.1 milestone Oct 26, 2014
@kpdecker kpdecker added the feature label Oct 26, 2014
kpdecker added a commit that referenced this issue Oct 26, 2014
Allows for us to play nicely in environments such as Node that could have multiple versions of the library loaded. Also allows for implementors to provide their own behavior, provided they know what they are doing.

Fixes #886
Copy link

@kpdecker kpdecker commented Oct 27, 2014

Closing in favor of #890.

@kpdecker kpdecker closed this Oct 27, 2014
kpdecker added a commit that referenced this issue Nov 8, 2014
Allows for us to play nicely in environments such as Node that could have multiple versions of the library loaded. Also allows for implementors to provide their own behavior, provided they know what they are doing.

Fixes #886
kkirsche pushed a commit to kkirsche/ that referenced this issue Feb 10, 2015
Update handlebars from 1.0.0-rc.4 to 3.0.0

## v3.0.0 - February 10th, 2015
- [#941](handlebars-lang/handlebars.js#941) - Add support for dynamic partial names ([@kpdecker](
- [#940](handlebars-lang/handlebars.js#940) - Add missing reserved words so compiler knows to use array syntax: ([@mattflaschen](
- [#938](handlebars-lang/handlebars.js#938) - Fix example using #with helper ([@diwo](
- [#930](handlebars-lang/handlebars.js#930) - Add parent tracking and mutation to AST visitors ([@kpdecker](
- [#926](handlebars-lang/handlebars.js#926) - Depthed lookups fail when program duplicator runs ([@kpdecker](
- [#918](handlebars-lang/handlebars.js#918) - Add instructions for 'spec/mustache' to, fix a few typos ([@oneeman](
- [#915](handlebars-lang/handlebars.js#915) - Ast update ([@kpdecker](
- [#910](handlebars-lang/handlebars.js#910) - Different behavior of {{@last}} when {{#each}} in {{#each}} ([@zordius](
- [#907](handlebars-lang/handlebars.js#907) - Implement named helper variable references ([@kpdecker](
- [#906](handlebars-lang/handlebars.js#906) - Add parser support for block params ([@mmun](
- [#903](handlebars-lang/handlebars.js#903) - Only provide aliases for multiple use calls ([@kpdecker](
- [#902](handlebars-lang/handlebars.js#902) - Generate Source Maps ([@kpdecker](
- [#901](handlebars-lang/handlebars.js#901) - Still escapes with noEscape enabled on isolated Handlebars environment ([@zedknight](
- [#896](handlebars-lang/handlebars.js#896) - Simplify BlockNode by removing intermediate MustacheNode ([@mmun](
- [#892](handlebars-lang/handlebars.js#892) - Implement parser for else chaining of helpers ([@kpdecker](
- [#889](handlebars-lang/handlebars.js#889) - Consider extensible parser API ([@kpdecker](
- [#887](handlebars-lang/handlebars.js#887) - Handlebars.noConflict() option? ([@bradvogel](
- [#886](handlebars-lang/handlebars.js#886) - Add SafeString to context (or use duck-typing) ([@dominicbarnes](
- [#870](handlebars-lang/handlebars.js#870) - Registering undefined partial throws exception. ([@max-b](
- [#866](handlebars-lang/handlebars.js#866) - comments don't respect whitespace control ([@75lb](
- [#863](handlebars-lang/handlebars.js#863) - + jsDelivr CDN info ([@tomByrer](
- [#858](handlebars-lang/handlebars.js#858) - Disable new default auto-indent at included partials ([@majodev](
- [#856](handlebars-lang/handlebars.js#856) - jspm compatibility ([@MajorBreakfast](
- [#805](handlebars-lang/handlebars.js#805) - Request: "strict" lookups ([@nzakas](

- Export the default object for handlebars/runtime - 5594416
- Lookup partials when undefined - 617dd57

Compatibility notes:
- Runtime breaking changes. Must match 3.x runtime and precompiler.
- The AST has been upgraded to a public API.
  - There are a number of changes to this, but the format is now documented in docs/
  - The Visitor API has been expanded to support mutation and provide a base implementation
- The `JavaScriptCompiler` APIs have been formalized and documented. As part of the sourcemap handling these should be updated to return arrays for concatenation.
- `JavaScriptCompiler.namespace` has been removed as it was unused.
- `SafeString` is now duck typed on `toHTML`

New Features:
- noConflict
- Source Maps
- Block Params
- Strict Mode
- @last and other each changes
- Chained else blocks
- @DaTa methods can now have helper parameters passed to them
- Dynamic partials


## v2.0.0 - September 1st, 2014
- Update jsfiddle to 2.0.0-beta.1 - 0670f65
- Add contrib note regarding docs - 4d17e3c
- Play nice with gemspec version numbers - 64d5481


## v2.0.0-beta.1 - August 26th, 2014
- [#787](handlebars-lang/handlebars.js#787) - Remove whitespace surrounding standalone statements ([@kpdecker](
- [#827](handlebars-lang/handlebars.js#827) - Render false literal as “false” ([@scoot557](
- [#767](handlebars-lang/handlebars.js#767) - Subexpressions bug with hash and context ([@evensoul](
- Changes to 0/undefined handling
  - [#731](handlebars-lang/handlebars.js#731) - Strange behavior for {{#foo}} {{bar}} {{/foo}} when foo is 0 ([@kpdecker](
  - [#820](handlebars-lang/handlebars.js#820) - strange behavior for {{}} when foo is 0 or null or false ([@zordius](
  - [#837](handlebars-lang/handlebars.js#837) - Strange input for custom helper ( == false when foo is undefined ) ([@zordius](
- [#819](handlebars-lang/handlebars.js#819) - Implement recursive field lookup ([@kpdecker](
- [#764](handlebars-lang/handlebars.js#764) - This reference not working for helpers ([@kpdecker](
- [#773](handlebars-lang/handlebars.js#773) - Implicit parameters in {{#each}} introduces a peculiarity in helpers calling convention  ([@Bertrand](
- [#783](handlebars-lang/handlebars.js#783) - helperMissing and consistency for different expression types ([@ErisDS](
- [#795](handlebars-lang/handlebars.js#795) - Turn the precompile script into a wrapper around a module. ([@jwietelmann](
- [#823](handlebars-lang/handlebars.js#823) - Support inverse sections on the with helper ([@dan-manges](
- [#834](handlebars-lang/handlebars.js#834) - Refactor blocks, programs and inverses ([@mmun](
- [#852](handlebars-lang/handlebars.js#852) - {{foo~}} space control behavior is different from older version ([@zordius](
- [#835](handlebars-lang/handlebars.js#835) - Templates overwritten if file is loaded twice

- Expose escapeExpression on the root object - 980c38c
- Remove nested function eval in blockHelperMissing - 6f22ec1
- Fix compiler program de-duping - 9e3f824

Compatibility notes:
- The default build now outputs a generic UMD wrapper. This should be transparent change but may cause issues in some environments.
- Runtime compatibility breaks in both directions. Ensure that both compiler and client are upgraded to 2.0.0-beta.1 or higher at the same time.
  - `programWithDepth` has been removed an instead an array of context values is passed to fields needing depth lookups.
- `false` values are now printed to output rather than silently dropped
- Lines containing only block statements and whitespace are now removed. This matches the Mustache spec but may cause issues with code that expects whitespace to exist but would not otherwise.
- Partials that are standalone will now indent their rendered content
- `AST.ProgramNode`'s signature has changed.
- Numerious methods/features removed from psuedo-API classes
  - `JavaScriptCompiler.register`
  - `JavaScriptCompiler.replaceStack` no longer supports non-inline replace
  - `Compiler.disassemble`
  - `DECLARE` opcode
  - `strip` opcode
  - `lookup` opcode
  - Content nodes may have their `string` values mutated over time. `original` field provides the unmodified value.
- Removed unused `Handlebars.registerHelper` `inverse` parameter
- `each` helper requires iterator parameter


## v2.0.0-alpha.4 - May 19th, 2014
- Expose setup wrappers for compiled templates - 3638874


## v2.0.0-alpha.3 - May 19th, 2014
- [#797](handlebars-lang/handlebars.js#797) - Pass full helper ID to helperMissing when options are provided ([@tomdale](
- [#793](handlebars-lang/handlebars.js#793) - Ensure isHelper is coerced to a boolean ([@mmun](
- Refactor template init logic - 085e5e1


## v2.0.0-alpha.2 - March 6th, 2014
- [#756](handlebars-lang/handlebars.js#756) - fix bug in IE<=8 (no Array::map), closes #751 ([@jenseng](
- [#749](handlebars-lang/handlebars.js#749) - properly handle multiple subexpressions in the same hash, fixes #748 ([@jenseng](
- [#743](handlebars-lang/handlebars.js#743) - subexpression confusion/problem? ([@waynedpj](
- [#746](handlebars-lang/handlebars.js#746) - [CLI] support `handlebars --version` ([@apfelbox](
- [#747](handlebars-lang/handlebars.js#747) - updated grunt-saucelabs, failing tests revealed ([@Jonahss](
- Make JSON a requirement for the compiler. - 058c0fb
- Temporarily kill the AWS publish CI step - 8347ee2

Compatibility notes:
- A JSON polyfill is required to run the compiler under IE8 and below. It's recommended that the precompiler be used in lieu of running the compiler on these legacy environments.


## v2.0.0-alpha.1 - February 10th, 2014
- [#182](handlebars-lang/handlebars.js#182) - Allow passing hash parameters to partials ([@kpdecker](
- [#392](handlebars-lang/handlebars.js#392) - Access to root context in partials and helpers ([@kpdecker](
- [#472](handlebars-lang/handlebars.js#472) - Helpers cannot have decimal parameters ([@kayleg](
- [#569](handlebars-lang/handlebars.js#569) - Unable to lookup array values using @INDEX ([@kpdecker](
- [#491](handlebars-lang/handlebars.js#491) - For nested helpers: get the @ variables of the outer helper from the inner one ([@kpdecker](
- [#669](handlebars-lang/handlebars.js#669) - Ability to unregister a helper ([@dbachrach](
- [#730](handlebars-lang/handlebars.js#730) - Raw block helpers ([@kpdecker](
- [#634](handlebars-lang/handlebars.js#634) - It would be great to have the helper name passed to `blockHelperMissing` ([@kpdecker](
- [#729](handlebars-lang/handlebars.js#729) - Convert template spec to object literal ([@kpdecker](

- [#658](handlebars-lang/handlebars.js#658) - Depthed helpers do not work after an upgrade from 1.0.0 ([@xibxor](
- [#671](handlebars-lang/handlebars.js#671) - Crashes on no-parameter {{#each}} ([@stepancheg](
- [#689](handlebars-lang/handlebars.js#689) - broken template precompilation ([@AAS](
- [#698](handlebars-lang/handlebars.js#698) - Fix parser generation under windows ([@osiris43](
- [#699](handlebars-lang/handlebars.js#699) - @DaTa not compiles to invalid JS in stringParams mode ([@kpdecker](
- [#705](handlebars-lang/handlebars.js#705) - 1.3.0 can not be wrapped in an IIFE ([@craigteegarden](
- [#706](handlebars-lang/handlebars.js#706) - README: Use with helper instead of relying on blockHelperMissing ([@scottgonzalez](

- [#700](handlebars-lang/handlebars.js#700) - Remove redundant conditions ([@blakeembrey](
- [#704](handlebars-lang/handlebars.js#704) - JavaScript Compiler Cleanup ([@blakeembrey](

Compatibility notes:
- `helperMissing` helper no longer has the indexed name argument. Helper name is now available via ``.
- Precompiler output has changed, which breaks compatibility with prior versions of the runtime and precompiled output.
- `JavaScriptCompiler.compilerInfo` now returns generic objects rather than javascript source.
- AST changes
  - Additional PartialNode hash parameter
  - New RawBlockNode type
- Data frames now have a `_parent` field. This is internal but is enumerable for performance/compatability reasons.


## v1.3.0 - January 1st, 2014
- [#690](handlebars-lang/handlebars.js#690) - Added support for subexpressions ([@machty](
- [#696](handlebars-lang/handlebars.js#696) - Fix for reserved keyword "default" ([@nateirwin](
- [#692](handlebars-lang/handlebars.js#692) - add line numbers to nodes when parsing ([@fivetanley](
- [#695](handlebars-lang/handlebars.js#695) - Pull options out from param setup to allow easier extension ([@blakeembrey](
- [#694](handlebars-lang/handlebars.js#694) - Make the environment reusable ([@blakeembrey](
- [#636](handlebars-lang/handlebars.js#636) - Print line and column of errors ([@sgronblo](
- Use literal for data lookup - c1a93d3
- Add stack handling sanity checks - cd885bf
- Fix stack id "leak" on replaceStack - ddfe457
- Fix incorrect stack pop when replacing literals - f4d337d


## v1.2.1 - December 26th, 2013
- [#684](handlebars-lang/handlebars.js#684) - Allow any number of trailing characters for valid JavaScript variable ([@blakeembrey](
- [#686](handlebars-lang/handlebars.js#686) - Falsy AMD module names in version 1.2.0 ([@kpdecker](


## v1.2.0 - December 23rd, 2013
- [#675](handlebars-lang/handlebars.js#675) - Cannot compile empty template for partial ([@erwinw](
- [#677](handlebars-lang/handlebars.js#677) - Triple brace statements fail under IE ([@hamzaCM](
- [#655](handlebars-lang/handlebars.js#655) - Loading Handlebars using bower ([@niki4810](
- [#657](handlebars-lang/handlebars.js#657) - Fixes issue where cli compiles non handlebars templates ([@chrishoage](
- [#681](handlebars-lang/handlebars.js#681) - Adds in-browser testing and Saucelabs CI ([@kpdecker](
- [#661](handlebars-lang/handlebars.js#661) - Add @FIRST and @INDEX to #each object iteration ([@cgp](
- [#650](handlebars-lang/handlebars.js#650) - Handlebars is MIT-licensed ([@thomasboyt](
- [#641](handlebars-lang/handlebars.js#641) - Document ember testing process ([@kpdecker](
- [#662](handlebars-lang/handlebars.js#662) - handlebars-source 1.1.2 is missing from RubyGems.
- [#656](handlebars-lang/handlebars.js#656) - Expose COMPILER_REVISION checks as a hook ([@machty](
- [#668](handlebars-lang/handlebars.js#668) - Consider publishing handlebars-runtime as a separate module on npm ([@dlmanning](
- [#679](handlebars-lang/handlebars.js#679) - Unable to override invokePartial ([@mattbrailsford](
- [#646](handlebars-lang/handlebars.js#646) - Fix "\\{{" immediately following "\{{" ([@dmarcotte](
- Allow extend to work with non-prototyped objects - eb53f2e
- Add JavascriptCompiler public API tests - 1a751b2
- Add AST test coverage for more complex paths - ddea5be
- Fix handling of boolean escape in MustacheNode - b4968bb

Compatibility notes:
- `@index` and `@first` are now supported for `each` iteration on objects
- `Handlebars.VM.checkRevision` and `Handlebars.JavaScriptCompiler.prototype.compilerInfo` now available to modify the version checking behavior.
- Browserify users may link to the runtime library via `require('handlebars/runtime')`


## v1.1.2 - November 5th, 2013

- [#645](handlebars-lang/handlebars.js#645) - 1.1.1 fails under IE8 ([@kpdecker](
- [#644](handlebars-lang/handlebars.js#644) - Using precompiled templates (AMD mode) with handlebars.runtime 1.1.1 ([@fddima](

- Add simple binary utility tests - 96a45a4
- Fix empty string compilation - eea708a


## v1.1.1 - November 4th, 2013

- [#642](handlebars-lang/handlebars.js#642) - handlebars 1.1.0 are broken with nodejs

- Fix release notes link - 17ba258


## v1.1.0 - November 3rd, 2013

- [#628](handlebars-lang/handlebars.js#628) - Convert code to ES6 modules ([@kpdecker](
- [#336](handlebars-lang/handlebars.js#336) - Add whitespace control syntax ([@kpdecker](
- [#535](handlebars-lang/handlebars.js#535) - Fix for probable JIT error under Safari ([@sorentwo](
- [#483](handlebars-lang/handlebars.js#483) - Add first and last @ vars to each helper ([@denniskuczynski](
- [#557](handlebars-lang/handlebars.js#557) - `\\{{foo}}` escaping only works in some situations ([@dmarcotte](
- [#552](handlebars-lang/handlebars.js#552) - Added BOM removal flag. ([@blessenm](
- [#543](handlebars-lang/handlebars.js#543) - publish passing master builds to s3 ([@fivetanley](

- [#608](handlebars-lang/handlebars.js#608) - Add `includeZero` flag to `if` conditional
- [#498](handlebars-lang/handlebars.js#498) - `Handlebars.compile` fails on empty string although a single blank works fine
- [#599](handlebars-lang/handlebars.js#599) - lambda helpers only receive options if used with arguments
- [#592](handlebars-lang/handlebars.js#592) - Optimize array and subprogram performance
- [#571](handlebars-lang/handlebars.js#571) - uglify upgrade breaks compatibility with older versions of node
- [#587](handlebars-lang/handlebars.js#587) - Partial inside partial breaks?

Compatibility notes:
- The project now includes separate artifacts for AMD, CommonJS, and global objects.
  - AMD: Users may load the bundled `handlebars.amd.js` or `handlebars.runtime.amd.js` files or load individual modules directly. AMD users should also note that the handlebars object is exposed via the `default` field on the imported object. This [gist]( provides some discussion of possible compatibility shims.
  - CommonJS/Node: Node loading occurs as normal via `require`
  - Globals: The `handlebars.js` and `handlebars.runtime.js` files should behave in the same manner as the v1.0.12 / 1.0.0 release.
- Build artifacts have been removed from the repository. [npm][npm], [components/handlebars.js][components], [cdnjs][cdnjs], or the [builds page][builds-page] should now be used as the source of built artifacts.
- Context-stored helpers are now always passed the `options` hash. Previously no-argument helpers did not have this argument.


## v1.0.12 / 1.0.0 - May 31 2013

- [#515](handlebars-lang/handlebars.js#515) - Add node require extensions support ([@jjclark1982](
- [#517](handlebars-lang/handlebars.js#517) - Fix amd precompiler output with directories ([@blessenm](
- [#433](handlebars-lang/handlebars.js#433) - Add support for unicode ids
- [#469](handlebars-lang/handlebars.js#469) - Add support for `?` in ids
- [#534](handlebars-lang/handlebars.js#534) - Protect from object prototype modifications
- [#519](handlebars-lang/handlebars.js#519) - Fix partials with . name ([@jamesgorrie](
- [#519](handlebars-lang/handlebars.js#519) - Allow ID or strings in partial names
- [#437](handlebars-lang/handlebars.js#437) - Require matching brace counts in escaped expressions
- Merge passed partials and helpers with global namespace values
- Add support for complex ids in @DaTa references
- Docs updates

Compatibility notes:
- The parser is now stricter on `{{{`, requiring that the end token be `}}}`. Templates that do not
  follow this convention should add the additional brace value.
- Code that relies on global the namespace being muted when custom helpers or partials are passed will need to explicitly pass an `undefined` value for any helpers that should not be available.
- The compiler version has changed. Precompiled templates with 1.0.12 or higher must use the 1.0.0 or higher runtime.


## v1.0.11 / 1.0.0-rc4 - May 13 2013

- [#458](handlebars-lang/handlebars.js#458) - Fix `./foo` syntax ([@jpfiset](
- [#460](handlebars-lang/handlebars.js#460) - Allow `:` in unescaped identifers ([@jpfiset](
- [#471](handlebars-lang/handlebars.js#471) - Create release notes (These!)
- [#456](handlebars-lang/handlebars.js#456) - Allow escaping of `\\`
- [#211](handlebars-lang/handlebars.js#211) - Fix exception in `escapeExpression`
- [#375](handlebars-lang/handlebars.js#375) - Escape unicode newlines
- [#461](handlebars-lang/handlebars.js#461) - Do not fail when compiling `""`
- [#302](handlebars-lang/handlebars.js#302) - Fix sanity check in knownHelpersOnly mode
- [#369](handlebars-lang/handlebars.js#369) - Allow registration of multiple helpers and partial by passing definition object
- Add bower package declaration ([@DevinClark](
- Add NuSpec package declaration ([@MikeMayer](
- Handle empty context in `with` ([@thejohnfreeman](
- Support custom template extensions in CLI ([@matteoagosti](
- Fix Rhino support ([@broady](
- Include contexts in string mode ([@leshill](
- Return precompiled scripts when compiling to AMD ([@JamesMaroney](
- Docs updates ([@iangreenleaf](, [@gilesbowkett](, [@utkarsh2012](
- Fix `toString` handling under IE and browserify ([@tommydudebreaux](
- Add program metadata
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants
You can’t perform that action at this time.