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 v4 #70

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 24, 2022

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mustache ~2.3.0 -> ~4.2.0 age adoption passing confidence

Release Notes

janl/mustache.js (mustache)

v4.2.0

Compare Source

Added

v4.1.0

Compare Source

Added
Fixed

v4.0.1

Compare Source

Fixed

v4.0.0

Compare Source

Majority of using projects don't have to worry by this being a new major version.

TLDR; if your project manipulates Writer.prototype.parse | Writer.cache directly or uses .to_html(), you probably have to change that code.

This release allows the internal template cache to be customised, either by disabling it completely
or provide a custom strategy deciding how the cache should behave when mustache.js parses templates.

const mustache = require('mustache');

// disable caching
Mustache.templateCache = undefined;

// or use a built-in Map in modern environments
Mustache.templateCache = new Map();

Projects that wanted to customise the caching behaviour in earlier versions of mustache.js were forced to
override internal method responsible for parsing templates; Writer.prototype.parse. In short, that was unfortunate
because there is more than caching happening in that method.

We've improved that now by introducing a first class API that only affects template caching.

The default template cache behaves as before and is still compatible with older JavaScript environments.
For those who wants to provide a custom more sopisiticated caching strategy, one can do that with an object that adheres to the following requirements:

{
  set(cacheKey: string, value: string): void
  get(cacheKey: string): string | undefined
  clear(): void
}
Added
Removed

v3.2.1

Compare Source

Fixed
  • [#​733]: Allow the CLI to use JavaScript views when the project has ES6 modules enabled, by [@​eobrain].

v3.2.0

Compare Source

Added
Using mustache.js as an ES module

To stay backwards compatible with already using projects, the default exposed module format is still UMD.
That means projects using mustache.js as an CommonJS, AMD or global scope module, from npm or directly from github.com
can keep on doing that for now.

For those projects who would rather want to use mustache.js as an ES module, the mustache/mustache.mjs file has to
be imported directly.

Below are some usage scenarios for different runtimes.

Modern browser with ES module support
<!-- index.html -->
<script type="module">
  import mustache from "https://unpkg.com/mustache@3.2.0/mustache.mjs"

  console.log(mustache.render('Hello {{name}}!', { name: 'Santa' }))
  // Hello Santa!
</script>
Node.js (>= v13.2.0 or using --experimental-modules flag)
// index.mjs
import mustache from 'mustache/mustache.mjs'

console.log(mustache.render('Hello {{name}}!', { name: 'Santa' }))
// Hello Santa!

ES Module support for Node.js will be improved in the future when Conditional Exports
is enabled by default rather than being behind an experimental flag.

More info in Node.js ECMAScript Modules docs.

Deno
// index.ts
import mustache from 'https://unpkg.com/mustache@3.2.0/mustache.mjs'

console.log(mustache.render('Hello {{name}}!', { name: 'Santa' }))
// Hello Santa!

v3.1.0

Compare Source

Added
Fixed

v3.0.3

Compare Source

Added
Fixed

v3.0.2

Compare Source

Fixed
Dev

v3.0.1

Compare Source

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
Minor
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.


Configuration

📅 Schedule: Branch creation - "before 07:00 on Thursday" in timezone Europe/Oslo, Automerge - At any time (no schedule defined).

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

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 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 was generated by Mend Renovate. View the repository job log.

@github-actions
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://red-smoke-01cb41203-70.westeurope.1.azurestaticapps.net

@renovate renovate bot changed the title fix(deps): update dependency mustache to v4 Update dependency mustache to v4 Dec 17, 2022
@renovate renovate bot changed the title Update dependency mustache to v4 fix(deps): update dependency mustache to v4 Dec 17, 2022
@github-actions
Copy link

github-actions bot commented Feb 8, 2023

Azure Static Web Apps: Your stage site is ready! Visit it here: https://red-smoke-01cb41203-70.westeurope.1.azurestaticapps.net

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.

0 participants