Skip to content

Commit 57e31c3

Browse files
authored
Merge branch 'master' into no-export
2 parents 73525cb + 9fcd3aa commit 57e31c3

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ Just run:
1414
ember install ember-cli-typescript@1
1515
```
1616

17-
All dependencies will be added to your `package.json`, and you're ready to roll! (If you're upgrading from a previous release, you should check to merge any tweaks you've made to `tsconfig.json`.
17+
All dependencies will be added to your `package.json`, and you're ready to roll!
18+
(If you're upgrading from a previous release, you should check to merge any
19+
tweaks you've made to `tsconfig.json`.
1820

1921
In addition to ember-cli-typescript, the following are installed:
2022

@@ -99,9 +101,9 @@ This interface will likely require some changes to match your app.
99101

100102
## :construction: Using ember-cli-typescript with Ember CLI addons
101103

102-
**:warning: Warning: this is *not* currently recommended. This is a WIP part of the
103-
add-on, and it *will* make a dramatic difference in the size of your add-on in
104-
terms of installation. The upcoming 1.1 release will enable a much better
104+
**:warning: Warning: this is *not* currently recommended. This is a WIP part of
105+
the add-on, and it *will* make a dramatic difference in the size of your add-on
106+
in terms of installation. The upcoming 1.1 release will enable a much better
105107
experience for consumers of your addon.**
106108

107109
We're working on making a solution that lets us ship generated typings and
@@ -114,12 +116,6 @@ give users fair warning about the increased size. To enable TypeScript for your
114116
addon, simple move `ember-cli-typescript` from `devDependencies` to
115117
`dependencies` in your `package.json`.
116118

117-
## New modules API
118-
119-
Note: the new modules API is not yet supported by the official typings (which
120-
are distinct from this addon, though we install them). We hope to have support
121-
for them shortly!
122-
123119
## Not (yet) supported
124120

125121
While TS already works nicely for many things in Ember, there are a number of
@@ -129,15 +125,23 @@ landing in TypeScript itself.
129125

130126
[existing typings]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember
131127

132-
We are hard at work (and would welcome your help!) [writing new typings] for
133-
Ember which can give correct types for Ember's custom object model. If you'd
134-
like to try those out, please see instructions in that repo!
128+
We are hard at work (and would welcome your help!) [writing new
129+
typings][ember-typings] for Ember and the surrounding ecosystem, which can give
130+
correct types for Ember's custom object model and things which build on it (e.g.
131+
ember-data). If you'd like to try those out, please see instructions in [that
132+
repo][ember-typings]!
135133

136-
[writing new typings]: https://github.com/typed-ember/ember-typings
134+
[ember-typings]: https://github.com/typed-ember/ember-typings
137135

138136
Here is the short list of things which do *not* work yet in the version of the
139137
typings published on DefinitelyTyped.
140138

139+
### New modules API
140+
141+
Note: the new modules API is not yet supported by the official typings (which
142+
are distinct from this addon, though we install them). We do have experimental
143+
support for them in the [ember-typings] repository, and it works quite well!
144+
141145
### Some `import`s don't resolve
142146

143147
You'll frequently see errors for imports which TypeScript doesn't know how to

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"broccoli-plugin": "^1.2.1",
3636
"broccoli-source": "^1.1.0",
3737
"broccoli-stew": "^1.4.0",
38-
"broccoli-typescript-compiler": "^2.0.0",
38+
"broccoli-typescript-compiler": "^2.1.0",
3939
"debug": "^2.2.0",
4040
"ember-cli-babel": "^6.3.0",
4141
"silent-error": "^1.1.0"

0 commit comments

Comments
 (0)