Skip to content

Commit

Permalink
Add 1.0.0-beta.1 release notes and README
Browse files Browse the repository at this point in the history
  • Loading branch information
sentience committed Aug 22, 2018
1 parent 2517710 commit b15105b
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 45 deletions.
55 changes: 11 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,17 @@
![Elm Language Support logo](images/logo.png)
# The Sublime Elm Language Package

> ### Note: Elm 0.19 and Elm Language Support
> This prerelease version provides experimental support for the just-released
> [Elm 0.19][], and **breaks compatibility** with Elm 0.18 and earlier.
>
> Elm 0.19 was [recently released][elm-0.19]. It makes major, breaking changes
> to the compiler's interface with packages like this one. It is likely the
> next release of Elm Language Support will break compatibility with Elm 0.18.
>
> If you plan to remain on Elm 0.18 for now, you should configure Package
> Control to ignore updates to this package until you are ready to upgrade.
> In Sublime Text, choose **Preferences > Package Settings > Package Control >
> Settings – User**, then add this setting to your
> **Package Control.sublime-settings** file:
>
> ```json
> {
> "auto_upgrade_ignore": [
> "Elm Language Support"
> ],
> }
> ```
>
> #### Upgrading to Elm 0.19
>
> A pre-release version of this package with experimental support for Elm 0.19
> is available. If you're using Elm 0.19 already, we'd value your feedback!
>
> **Warning:** This new version does not support Elm 0.18!
>
> To upgrade, configure Package Control to install pre-release versions of this
> package. In Sublime Text, choose **Preferences > Package Settings > Package
> Control > Settings – User**, then add this setting to your
> **Package Control.sublime-settings** file:
>
> ```json
> {
> "install_prereleases":
> [
> "Elm Language support"
> ],
> }
> ```
>
> Then use the **Package Control: Upgrade Package** command in the Command
> Palette to upgrade. Make sure to read the release notes that are displayed
> following the upgrade!
> Please report issues on GitHub:
> <https://github.com/elm-community/SublimeElmLanguageSupport/issues>
>
> Help Welcome
> ------------
>
> Are you interested in contributing to the Elm Language Support package for
Sublime Text? Get in touch!

## Installation

Expand Down Expand Up @@ -133,4 +100,4 @@ Don't know Elm? Great first step!
[Sublime Text 2]: http://www.sublimetext.com/2
[Sublime Text 3]: http://www.sublimetext.com/3
[tweet]: https://twitter.com/rtfeldman/status/624026168652660740
[elm-0.19]: https://elm-lang.org/blog/small-assets-without-the-headache
[Elm 0.19]: https://elm-lang.org/blog/small-assets-without-the-headache
3 changes: 2 additions & 1 deletion messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@
"0.22.1": "messages/0.22.1.txt",
"0.22.2": "messages/0.22.2.txt",
"0.22.3": "messages/0.22.3.txt",
"0.22.4": "messages/0.22.4.txt"
"0.22.4": "messages/0.22.4.txt",
"1.0.0-beta.1": "messages/1.0.0-beta.1.txt"
}
49 changes: 49 additions & 0 deletions messages/1.0.0-beta.1.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
New in Elm Language Support 1.0.0-beta.1 (August 22, 2018)
==========================================================

This prerelease version provides experimental support for the just-released
Elm 0.19, and BREAKS COMPATIBILITY with Elm 0.18 and earlier.

Read about Elm 0.19 here:
<https://github.com/elm/compiler/blob/master/upgrade-docs/0.19.md>

Please report issues on GitHub:
<https://github.com/elm-community/SublimeElmLanguageSupport/issues>


What's New
----------

The following features have been removed, as they depend on elm-oracle, which
has not yet been updated to support Elm 0.19:

- Removed: Display type signatures for symbols under the cursor in the status
bar.
- Removed: Elm type info panel (alt/option-up/down keyboard shortcuts).
- Removed: Autocompletion of Elm symbols available in the current module.

The build system was rewritten to support the new output format of the Elm 0.19
compiler. The following features have yet to be reimplemented:

- Removed: Support for enabling/disabling build warnings (Elm 0.19 has removed
compiler warnings for now).
- Removed: Ability to build your whole project to an output file from within
Sublime Text. For now, the build system builds only the current module (and
everything it imports), which is sufficient for getting quick compiler
feedback on the code you're working on. But to actually run your all, you'll
need some other way of running a build of your whole project for now.

And there is one new feature that will come in handy for those of you juggling
multiple Elm versions on your machine:

- New: `elm_binary` setting that lets you override the path and filename to the
Elm binary file (`elm`) that Sublime Text uses to build your code.


Help Welcome
------------

Are you interested in contributing to the Elm Language Support package for
Sublime Text? Get in touch!

Reach me at @sentience or <thatguy@kevinyank.com>.

0 comments on commit b15105b

Please sign in to comment.