Announce version 2.0 #2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: Announcing xterm.js 2.0 | ||
| author: parisk | ||
| categories: xtermjs update | ||
| --- | ||
|
|
||
| We are excited to announce a new major update for xterm.js; **<a href="https://github.com/sourcelair/xterm.js" target="_blank">xterm.js 2.0</a>**! This new release includes the following great updates: | ||
|
|
||
| 1. Launch of official project website with [public API docs](/docs/) and [blog](/blog/) | ||
| 2. Migration of code base to ES2015 modules to make development much easier | ||
| 3. Significant features and improvements | ||
|
|
||
| Let's take a quick look on each one of this updates | ||
|
|
||
| ## Project website | ||
| Xterm.js definitely deserved it's own place in the web, so we gifted [xtermjs.org](http://xtermjs.org) to it! Here you can find the official [docs](/docs/) for the public API of the project, including some more high-level guides and a [blog](/blog/), where we will post articles about xterm.js, like releases, presentations, engineering etc. | ||
|
||
|
|
||
| ## Migration to ES2015 | ||
| Xterm.js used to be a huge monolith and it was a real pain to develop it, especially when dealing with core parts like rendering. We decided to take a big step forward, break the code base into multiple native ES2015 modules and ship xterm.js as a UMD monolith which can be imported using either native modules, CommonJS, RequireJS or no module system at all! | ||
|
||
|
|
||
| This will allow us to develop xterm.js faster, with less hassle and friction and at the end ship a better open source project to the world. | ||
|
|
||
| ### ⚠️ Migrating from xterm.js 1.0 to 2.0 | ||
| Since this is a major xterm.js release, we had to break our public API because of this update, so take a look here before migrating! | ||
|
|
||
| The only thing that you have to take into account when migrating from xterm.js 1.0 to 2.0 is importing the appropriate files. The xterm.js core is not stored as two built files (one JavaScript and one CSS) into the `dist` directory of the code base (instead of `src`, where they used to be). | ||
|
Member
There was a problem hiding this comment. A mention on the fact that the API is not strict would be good, meaning that people may have been relying on what we now consider to be private and could change at any time without notice.
Contributor
Author
There was a problem hiding this comment. |
||
|
|
||
| To learn more about how to import xterm.js properly into your project, take a look at the [Importing](/docs/guides/import/) documentation page. | ||
|
|
||
| **Note**: If you are importing xterm.js using CommonJS, there should be nothing to change there, since we updated the package.json file of the project accordingly. | ||
|
|
||
| ## Features and improvements | ||
|
Member
There was a problem hiding this comment. Not sure the level of detail we want here but:
Contributor
Author
There was a problem hiding this comment. 👍 Added |
||
| Xterm.js 2.0 ships with a few great improvements: | ||
|
|
||
| - New APIs to [get](http://xtermjs.org/docs/api/Terminal/#getoptionkey) and [set](http://xtermjs.org/docs/api/Terminal/#setoptionkey-value) terminal options | ||
| - Better mouse and mouse wheel support | ||
| - Improved scrolling in curses-based applications (e.g. Vim) | ||
|
||
|
|
||
| As always, this release could not be made possible without the contribution of our [**amazing contributors**](https://github.com/sourcelair/xterm.js/blob/2.0.1/AUTHORS), so **THANK YOU** for making this happen! | ||
|
|
||
| Xterm.js 2.0 is available at [npm](http://npmjs.org/package/xterm), [bower](https://bower.io) and [GitHub Releases](https://github.com/sourcelair/xterm.js/releases/tag/2.0.1) as usual, so go get it and create amazing terminal apps now! | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not so important for an update announcement imo and should we mention it if we're moving to TypeScript?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's a good idea to have this here to encourage developers to contribute.
Considering TypeScript, since we are not settled on this yet let's leave it out of this "announcement".