content icon indicating copy to clipboard operation
content copied to clipboard
verified publisher icon nuxt

chore(deps): update dependency xterm to v5

Open renovate[bot] opened this issue 3 years ago • 1 comments

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
xterm ^4.19.0 -> ^5.0.0 age adoption passing confidence

Release Notes

xtermjs/xterm.js

v5.0.0

Compare Source

v5 is here! This is our largest release in a long time, maybe ever 👀

Since this was a major version bump, we used the opportunity to clean up the API and make other breaking changes. Many of these changes enabled a significant reduction in the xterm module bundle size which went from 379kb to 265kb for a 30% reduction!

🚀 Features

Underline style and color support (#​3921, #​3976, #​3980, #​4053, #​4068, #​4074, #​4077, #​4109) via @​Tyriar

Underline style and color sequences such as CSI 4:2m ST for double underlines are now supported:

image

Some work was also done to improve underline rendering overall, characters with long descenders don't overlap with the underline:

image

Hyperlink escape sequence support (#​4005, #​4087, #​4088) via @​Tyriar, @​jerch

Building upon the improved underline rendering, hyperlink escapes outlined in this gist are now supported. They will be rendered using a dashed underline (like CSI 4:5m ST):

image

Along with this is a new linkHandler option which allows controling hover, leave and activate events, for example to show a custom tooltip. VS Code's implementation looks like this:

image

Smooth scroll support (#​3940) via @​Tyriar

The new smoothScrollDuration allows setting a duration in milliseconds to animate scroll between the origin and target positions. This is most useful when using a physical mouse (not a trackpad) to help not disorient the user when scrolling with the mouse wheel.

Canvas renderer addon (#​3949, #​3950, #​3954, #​3959, #​3961, #​3981) via @​Tyriar

The canvas renderer has moved into an addon, significantly reducing the bundle size of the xterm module. This used to be the default renderer and is now recommended only as a fallback to the webgl addon if that does not work for some reason (eg. no webgl2 support).

New VT feature support (#​4093, #​4095, #​4098)via @​jerch

xterm.js handles several new VT sequences:

Other features

🐞 Bug fixes

📝 Documentation and internal improvements

🛑 Breaking changes

  • bellSound and bellStyle options as well as the previously builtin sound have been removed (#​3941) via @​Tyriar. This reduces the bundle size while still allowing the embedder to support the terminal bell via the Terminal.onBell API

    // before 5.0.0
term = new Terminal({
  bellStyle: 'sound'
});

// after 5.0.0
term = new Terminal();
term.onBell(() => {
  // Play a sound
});

  • The link matcher API registerLinkMatcher and deregisterLinkMatcher have been removed in favor of the link provider API (#​3944) via @​Tyriar.

  • The allowProposedApi option now defaults to false, set this to true to opt-in to proposed API usage if you understand the implications (#​3945) via @​Tyriar

    // before 5.0.0
term = new Terminal({});
term.someProposedApi();

// after 5.0.0
term = new Terminal({
  allowProposedApi: true
});
term.someProposedApi();

  • The deprecated addMarker API has been removed in favor of registerMarker (#​3946) via @​Tyriar. They are functionally equivalent.

  • The deprecated getOption and setOption APIs have been removed in favor of options (#​3947) via @​Tyriar

    // before 5.0.0
term.setOption('scrollback', 1000);
console.log(term.getOption('scrollback'));

// after 5.0.0
term.options.scrollback = 1000;
console.log(term.options.scrollback);

  • The deprecated writeUtf8 API has been removed in favor of write (#​3947) via @​Tyriar.

    const arr = new Uint8Array(10);

// before 5.0.0
term.writeUtf8(arr);

// after 5.0.0
term.write(arr);

  • ISelectionPosition have been removed from the API in favor of IBufferRange (#​3952) via @​Tyriar

  • cols and rows options can now only be set in the constructor (#​3960, #​3972, #​4078) via @​Tyriar, @​silamon

    // before 5.0.0
term.setOption('cols', 10);

// after 5.0.0
term.resize(10, term.rows);

  • ITheme.selection has been renamed to selectionBackground for consistency (#​3964) via @​Tyriar

    // before 5.0.0
term.options.theme = { selection: '#​000000' };

// after 5.0.0
term.options.theme = { selectionBackground: '#​000000' };

  • The Terminal.options getter now returns a Required<ITerminalOptions> instead of just ITerminalOptions for better correctness. Along with this change fastScrollModifier now accepts 'none' instead of undefined

    // before 5.0.0
new Terminal({ fastScrollModifier: undefined });

// after 5.0.0
new Terminal({ fastScrollModifier: 'none' });

🎉 New real-world use cases

📥 Addons

xterm-addon-canvas
xterm-addon-fit
xterm-addon-ligatures
xterm-addon-web-links
  • The link matcher-based implementation has been removed in favor of the link provider implementation (#​3944) via @​Tyriar
xterm-addon-webgl

More efficient GPU memory usage using new texture atlas packing strategy (#​3979) via @​Tyriar

The previous naive texture packing strategy which only allowed adding to the "active row" or below has been replaced with a new strategy that uses multiple active rows and adds glyphs to the most suitable row based on its pixel height. This leads to more effective usage of the texture xterm.js uploads to the GPU, meaning it's harder to reset the texture when it becomes filled (which is more likely to happen when screen scale is high).

Before:

image

After:

image

Other changes

🤝 Compatible addon versions

🌐 Website

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), 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, click this checkbox.

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

renovate[bot] avatar Sep 15 '22 21:09 renovate[bot]

Deploy Preview for nuxt-content ready!

Name Link
Latest commit a4fa161e97ac8a115a22e2d0490628214ac12aa6
Latest deploy log https://app.netlify.com/sites/nuxt-content/deploys/633ec0952e7f5e0009645e93
Deploy Preview https://deploy-preview-1528--nuxt-content.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Sep 15 '22 21:09 netlify[bot]

Renovate Ignore Notification

As this PR has been closed unmerged, Renovate will ignore this upgrade and you will not receive PRs for any future 5.x releases. However, if you upgrade to 5.x manually then Renovate will reenable minor and patch updates automatically.

If this PR was closed by mistake or you changed your mind, you can simply rename this PR and you will soon get a fresh replacement PR opened.

renovate[bot] avatar Oct 06 '22 12:10 renovate[bot]