Skip to content

Commit b15105b

Browse files
committed
Add 1.0.0-beta.1 release notes and README
1 parent 2517710 commit b15105b

File tree

3 files changed

+62
-45
lines changed

3 files changed

+62
-45
lines changed

README.md

Lines changed: 11 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,17 @@
11
![Elm Language Support logo](images/logo.png)
22
# The Sublime Elm Language Package
33

4-
> ### Note: Elm 0.19 and Elm Language Support
4+
> This prerelease version provides experimental support for the just-released
5+
> [Elm 0.19][], and **breaks compatibility** with Elm 0.18 and earlier.
56
>
6-
> Elm 0.19 was [recently released][elm-0.19]. It makes major, breaking changes
7-
> to the compiler's interface with packages like this one. It is likely the
8-
> next release of Elm Language Support will break compatibility with Elm 0.18.
9-
>
10-
> If you plan to remain on Elm 0.18 for now, you should configure Package
11-
> Control to ignore updates to this package until you are ready to upgrade.
12-
> In Sublime Text, choose **Preferences > Package Settings > Package Control >
13-
> Settings – User**, then add this setting to your
14-
> **Package Control.sublime-settings** file:
15-
>
16-
> ```json
17-
> {
18-
> "auto_upgrade_ignore": [
19-
> "Elm Language Support"
20-
> ],
21-
> }
22-
> ```
23-
>
24-
> #### Upgrading to Elm 0.19
25-
>
26-
> A pre-release version of this package with experimental support for Elm 0.19
27-
> is available. If you're using Elm 0.19 already, we'd value your feedback!
28-
>
29-
> **Warning:** This new version does not support Elm 0.18!
30-
>
31-
> To upgrade, configure Package Control to install pre-release versions of this
32-
> package. In Sublime Text, choose **Preferences > Package Settings > Package
33-
> Control > Settings – User**, then add this setting to your
34-
> **Package Control.sublime-settings** file:
35-
>
36-
> ```json
37-
> {
38-
> "install_prereleases":
39-
> [
40-
> "Elm Language support"
41-
> ],
42-
> }
43-
> ```
44-
>
45-
> Then use the **Package Control: Upgrade Package** command in the Command
46-
> Palette to upgrade. Make sure to read the release notes that are displayed
47-
> following the upgrade!
7+
> Please report issues on GitHub:
8+
> <https://github.com/elm-community/SublimeElmLanguageSupport/issues>
9+
>
10+
> Help Welcome
11+
> ------------
12+
>
13+
> Are you interested in contributing to the Elm Language Support package for
14+
Sublime Text? Get in touch!
4815

4916
## Installation
5017

@@ -133,4 +100,4 @@ Don't know Elm? Great first step!
133100
[Sublime Text 2]: http://www.sublimetext.com/2
134101
[Sublime Text 3]: http://www.sublimetext.com/3
135102
[tweet]: https://twitter.com/rtfeldman/status/624026168652660740
136-
[elm-0.19]: https://elm-lang.org/blog/small-assets-without-the-headache
103+
[Elm 0.19]: https://elm-lang.org/blog/small-assets-without-the-headache

messages.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@
1515
"0.22.1": "messages/0.22.1.txt",
1616
"0.22.2": "messages/0.22.2.txt",
1717
"0.22.3": "messages/0.22.3.txt",
18-
"0.22.4": "messages/0.22.4.txt"
18+
"0.22.4": "messages/0.22.4.txt",
19+
"1.0.0-beta.1": "messages/1.0.0-beta.1.txt"
1920
}

messages/1.0.0-beta.1.txt

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
New in Elm Language Support 1.0.0-beta.1 (August 22, 2018)
2+
==========================================================
3+
4+
This prerelease version provides experimental support for the just-released
5+
Elm 0.19, and BREAKS COMPATIBILITY with Elm 0.18 and earlier.
6+
7+
Read about Elm 0.19 here:
8+
<https://github.com/elm/compiler/blob/master/upgrade-docs/0.19.md>
9+
10+
Please report issues on GitHub:
11+
<https://github.com/elm-community/SublimeElmLanguageSupport/issues>
12+
13+
14+
What's New
15+
----------
16+
17+
The following features have been removed, as they depend on elm-oracle, which
18+
has not yet been updated to support Elm 0.19:
19+
20+
- Removed: Display type signatures for symbols under the cursor in the status
21+
bar.
22+
- Removed: Elm type info panel (alt/option-up/down keyboard shortcuts).
23+
- Removed: Autocompletion of Elm symbols available in the current module.
24+
25+
The build system was rewritten to support the new output format of the Elm 0.19
26+
compiler. The following features have yet to be reimplemented:
27+
28+
- Removed: Support for enabling/disabling build warnings (Elm 0.19 has removed
29+
compiler warnings for now).
30+
- Removed: Ability to build your whole project to an output file from within
31+
Sublime Text. For now, the build system builds only the current module (and
32+
everything it imports), which is sufficient for getting quick compiler
33+
feedback on the code you're working on. But to actually run your all, you'll
34+
need some other way of running a build of your whole project for now.
35+
36+
And there is one new feature that will come in handy for those of you juggling
37+
multiple Elm versions on your machine:
38+
39+
- New: `elm_binary` setting that lets you override the path and filename to the
40+
Elm binary file (`elm`) that Sublime Text uses to build your code.
41+
42+
43+
Help Welcome
44+
------------
45+
46+
Are you interested in contributing to the Elm Language Support package for
47+
Sublime Text? Get in touch!
48+
49+
Reach me at @sentience or <thatguy@kevinyank.com>.

0 commit comments

Comments
 (0)