#773: Add package.json exports field, by @manzt.

Added

• #717: Added support .js files as views in command line tool, by @JEStaubach.

Fixed

• #716: Bugfix for indentation of inline partials, by @yotammadem.

Fixed

• #705: Fix indentation of partials, by @kevindew and @yotammadem.

Dev

• #701: Fix test failure for Node 10 and above, by @andersk.
• #704: Lint all test files just like the source files, by @phillipj.
• Start experimenting & comparing GitHub Actions vs Travis CI, by @phillipj.

#679: Fix partials not rendering tokens when using custom tags, by @stackchain.

3.0.0 / 16 September 2018

We are very happy to announce a new major version of mustache.js. We want to be very careful not to break projects out in the wild, and adhering to Semantic Versioning we have therefore cut this new major version.

The changes introduced will likely not require any actions for most using projects. The things to look out
for that might cause unexpected rendering results are described in the migration guide below.

A big shout out and thanks to @raymond-lam for this release! Without his contributions with code and
issue triaging, this release would never have happened.

Major

• #618: Allow rendering properties of primitive types that are not objects, by @raymond-lam.
• #643: Writer.prototype.parse to cache by tags in addition to template string, by @raymond-lam.
• #664: Fix Writer.prototype.parse cache, by @seminaoki.

Minor

• #673: Add tags parameter to Mustache.render(), by @raymond-lam.

Migrating from mustache.js v2.x to v3.x

Rendering properties of primitive types

We have ensured properties of primitive types can be rendered at all times. That means Array.length, String.length and similar. A corner case where this could cause unexpected output follows:

View:

{
  stooges: [
    { name: "Moe" },
    { name: "Larry" },
    { name: "Curly" }
  ]
}

Template:

{{#stooges}}
  {{name}}: {{name.length}} characters
{{/stooges}}

Output with v3.0:

  Moe: 3 characters
  Larry: 5 characters
  Curly: 5 characters

Output with v2.x:

  Moe:  characters
  Larry:  characters
  Curly:  characters

Caching for templates with custom delimiters

We have improved the templates cache to ensure custom delimiters are taken into consideration for the
cache. This improvement might cause unexpected rendering behaviour for using projects actively using the custom delimiters functionality.

Previously it was possible to use Mustache.parse() as a means to set global custom delimiters. If custom
delimiters were provided as an argument, it would affect all following calls to Mustache.render().
Consider the following:

const template = "[[item.title]] [[item.value]]";
mustache.parse(template, ["[[", "]]"]);

console.log(
  mustache.render(template, {
    item: {
      title: "TEST",
      value: 1
    }
  })
);

>> TEST 1

The above illustrates the fact that Mustache.parse() made mustache.js cache the template without
considering the custom delimiters provided. This is no longer true.

We no longer encourage using Mustache.parse() for this purpose, but have rather added a fourth argument to Mustache.render() letting you provide custom delimiters when rendering.

If you still need the pre-parse the template and use custom delimiters at the same time, ensure to provide
the custom delimiters as argument to Mustache.render() as well.

This release is made to revert changes introduced in 2.3.1 that caused unexpected behaviour for several users.

Minor

• #670: Rollback template cache causing unexpected behaviour, by @raymond-lam.

Minor

• #643: Writer.prototype.parse to cache by tags in addition to template string, by @raymond-lam.
• #664: Fix Writer.prototype.parse cache, by @seminaoki.

Dev

• #666: Install release tools with npm rather than pre-commit hook & Rakefile, by @phillipj.
• #667, #668: Stabilize browser test suite, by @phillipj.

Docs

• #644: Document global Mustache.escape overriding capacity, by @paultopia.
• #657: Correct Mustache.parse() return type documentation, by @bbrooks.

Minor

• #540: Add optional output argument to mustache CLI, by @wizawu.
• #597: Add compatibility with amdclean, by @mightyplow.

Dev

• #553: Assert null lookup when rendering an unescaped value, by @dasilvacontin.
• #580, #610: Ignore eslint for greenkeeper updates, by @phillipj.
• #560: Fix CLI tests for Windows, by @kookookchoozeus.
• Run browser tests w/node v4, by @phillipj.

Docs

• #542: Add API documentation to README, by @tomekwi.
• #546: Add missing syntax highlighting to README code blocks, by @pra85.
• #569: Update Ctemplate links in README, by @mortonfox.
• #592: Change "loadUser" to "loadUser()" in README, by @Flaque.
• #593: Adding doctype to HTML code example in README, by @calvinf.

Dependencies

• eslint -> 2.2.0. Breaking changes fix by @phillipj. #548
• eslint -> 2.5.1.
• mocha -> 3.0.2.
• zuul -> 3.11.0.

Thanks to all the people that contributed to this release!
Be it issues, comments, changes.. you are awesome! 🎉 😄

PS: Hope you enjoy the new changelog format! I wanted it to group information in a more useful way, and link to PRs for easy diff viewing.

Fixes

• Improve HTML escaping, by @phillipj.
• Fix inconsistency in defining global mustache object, by @simast.
• Fix switch-case indent error, by @norfish.
• Unpin chai and eslint versions, by @dasilvacontin.
• Update README.md with proper grammar, by @EvanLovely.
• Update mjackson username in README, by @mjackson.
• Remove syntax highlighting in README code sample, by @imagentleman.
• Fix typo in README, by @Xcrucifier.
• Fix link typo in README, by @keirog.

Added

• Add Partials support to CLI, by @palkan.

Changed

• Move install instructions to README's top, by @mateusortiz
• Improved devhook install output, by @ShashankaNataraj.
• Clarifies and improves language in documentation, by @jfmercer.
• Linting CLI tool, by @phillipj.
• npm 2.x and node v4 on Travis, by @phillipj.

Fixes

• Fix README spelling error to "aforementioned", by @djchie.
• Equal error message test in .render() for server and browser, by @phillipj.

Dependencies

• chai -> 3.3.0
• eslint -> 1.6.0