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

fix(deps): update dependency mustache to v3 - autoclosed #27

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 24, 2018

This PR contains the following updates:

Package Type Update Change References
mustache dependencies major ^2.3.0 -> ^3.0.0 source

Release Notes

janl/mustache.js

v3.0.1

Compare Source

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

v3.0.0

Compare Source

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.


Renovate configuration

📅 Schedule: "before 3am on Monday" (UTC).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever PR becomes conflicted, or if you modify the PR title to begin with "rebase!".

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot. View repository job log here.

@codecov
Copy link

codecov bot commented Sep 24, 2018

Codecov Report

Merging #27 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #27   +/-   ##
=======================================
  Coverage   97.72%   97.72%           
=======================================
  Files          10       10           
  Lines         132      132           
  Branches       12       12           
=======================================
  Hits          129      129           
  Misses          2        2           
  Partials        1        1

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7118189...84d6e92. Read the comment docs.

@renovate renovate bot changed the title fix(deps): update dependency mustache to v3 fix(deps): update dependency mustache to v3 - autoclosed Dec 16, 2018
@renovate renovate bot closed this Dec 16, 2018
@renovate renovate bot deleted the renovate/mustache-3.x branch December 16, 2018 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant