Skip to content

docs: update discord channel name, fix typos #1506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Thanks for submitting a pull request! 🎉

Please include a link to a GitHub issue if one exists.

If you don't hear from a maintainer within a few days, please feel free to ping us here or in #e-typescript on Discord!
If you don't hear from a maintainer within a few days, please feel free to ping us here or in #topic-typescript on Discord!

-->
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ We now use Babel 7's support for TypeScript to build apps and addons. Most of th

* Addons can no longer use `.ts` in app, because an addon's `app` directory gets merged with and uses the *host's* (i.e. the other addon or app's) preprocessors, and we cannot guarantee the host has TS support. Note that in-repo-addons will continue to work for in-repo addons because of the app build works with the host's (i.e. the app's, not the addon's) preprocessors.

* Apps need to use `.js` for overrides in app, since the different file extension means apps no long consistently "win" over addon versions (a limitation of how Babel + app merging interact) – note that this won’t be a problem with Module Unification apps
* Apps need to use `.js` for overrides in app, since the different file extension means apps no longer consistently "win" over addon versions (a limitation of how Babel + app merging interact) – note that this won’t be a problem with Module Unification apps

### Fixed

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,15 +143,15 @@ Since we now integrate in a more traditional way into Ember CLI's build pipeline

- Addons can no longer use `.ts` in `app`, because an addon's `app` directory gets merged with and uses the *host's* (i.e. the other addon or app's) preprocessors, and we cannot guarantee the host has TS support. Note that `.ts` will continue to work for in-repo addons because the app build works with the host's (i.e. the app's, not the addon's) preprocessors.

- Similarly, apps must use `.js` to override addon defaults in `app`, since the different file extension means apps no long consistently "win" over addon versions (a limitation of how Babel + app merging interact).
- Similarly, apps must use `.js` to override addon defaults in `app`, since the different file extension means apps no longer consistently "win" over addon versions (a limitation of how Babel + app merging interact).

##### Account for TS → Babel issues

ember-cli-typescript v2 uses Babel to compile your code, and the TypeScript compiler only to *check* your code. This makes for much faster builds, and eliminates the differences between Babel and TypeScript in the build output that could cause problems in v1. However, because of those differences, you’ll need to make a few changes in the process of upgrading.

- `const enum` is not supported at all. You will need to replace all uses of `const enum` with simply `enum` or constants.

- Using ES5 getters or settings with `this` type annotations is not supported through at least Babel 7.3. However, they should also be unnecessary with ES6 classes, so you can simply *remove* the `this` type annotation.
- Using ES5 getters or setters with `this` type annotations is not supported through at least Babel 7.3. However, they should also be unnecessary with ES6 classes, so you can simply *remove* the `this` type annotation.

- Trailing commas after rest function parameters (`function foo(...bar[],) {}`) are disallowed by the ECMAScript spec, so Babel also disallows them.

Expand All @@ -178,7 +178,7 @@ When seeking help, you should first consider what you need, and which aspect of

### 💬 Getting Started

We have a channel (**`#e-typescript`**) on the [Ember Community Discord server](https://discordapp.com/invite/zT3asNS) where you can ask about getting started, good resources for self-directed learning and more.
We have a channel (**`#topic-typescript`**) on the [Ember Community Discord server](https://discordapp.com/invite/zT3asNS) where you can ask about getting started, good resources for self-directed learning and more.

### 📚 Issues With Ember Type Definitions

Expand Down
2 changes: 1 addition & 1 deletion docs/ts/current-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ While TS already works nicely for many things in Ember, there are a number of co

You'll frequently see errors for imports which TypeScript doesn't know how to resolve. **These won't stop the build from working;** they just mean TypeScript doesn't know where to find those.

Writing these missing type definitions is a great way to pitch in! Jump in `#e-typescript` on the [Ember Community Discord server](https://discord.gg/zT3asNS) and we'll be happy to help you.
Writing these missing type definitions is a great way to pitch in! Jump in `#topic-typescript` on the [Ember Community Discord server](https://discord.gg/zT3asNS) and we'll be happy to help you.

## Templates

Expand Down
4 changes: 2 additions & 2 deletions docs/upgrade-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ If you choose to make the upgrade manually with yarn or npm, here are the steps
Since we now integrate in a more traditional way into Ember CLI's build pipeline, there are two changes required for addons using TypeScript.

* Addons can no longer use `.ts` in `app`, because an addon's `app` directory gets merged with and uses the _host's_ \(i.e. the other addon or app's\) preprocessors, and we cannot guarantee the host has TS support. Note that `.ts` will continue to work for in-repo addons because the app build works with the host's \(i.e. the app's, not the addon's\) preprocessors.
* Similarly, apps must use `.js` to override addon defaults in `app`, since the different file extension means apps no long consistently "win" over addon versions \(a limitation of how Babel + app merging interact\).
* Similarly, apps must use `.js` to override addon defaults in `app`, since the different file extension means apps no longer consistently "win" over addon versions \(a limitation of how Babel + app merging interact\).

### Account for TS → Babel issues

Expand Down Expand Up @@ -144,7 +144,7 @@ Any place where a type annotation overrides a _getter_
Notably, this is not a problem for Glimmer components, so migrating to Octane will also help!

* `const enum` is not supported at all. You will need to replace all uses of `const enum` with simply `enum` or constants.
* Using ES5 getters or settings with `this` type annotations is not supported through at least Babel 7.3. However, they should also be unnecessary with ES6 classes, so you can simply _remove_ the `this` type annotation.
* Using ES5 getters or setters with `this` type annotations is not supported through at least Babel 7.3. However, they should also be unnecessary with ES6 classes, so you can simply _remove_ the `this` type annotation.
* Trailing commas after rest function parameters \(`function foo(...bar[],) {}`\) are disallowed by the ECMAScript spec, so Babel also disallows them.
* Re-exports of types have to be disambiguated to be _types_, rather than values. Neither of these will work:

Expand Down
2 changes: 1 addition & 1 deletion known-typings.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ course find many other modules with their own typings out there.)

Don't see an addon you use listed here? You might be the one to write them! Check
out [this blog post] or [this quest issue] for tips on how to do it, and feel free
to ask for help in the `#e-typescript` channel on the [Ember Community Discord server].
to ask for help in the `#topic-typescript` channel on the [Ember Community Discord server].

[this blog post]: http://www.chriskrycho.com/2017/typing-your-ember-part-5.html
[this quest issue]: https://github.com/typed-ember/ember-typings/issues/14
Expand Down
2 changes: 1 addition & 1 deletion rfcs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ for inclusion by ember-cli-typescript.
* RFCs that are candidates for inclusion will enter a "final comment period"
lasting 7 days. The beginning of this period will be signaled with a comment
and tag on the RFC's pull request. Furthermore, the Typed Ember team will post
in Discord in `#e-typescript` and `#news-and-announcements`.
in Discord in `#topic-typescript` and `#news-and-announcements`.
* An RFC can be modified based upon feedback from the Typed Ember team and
the community. Significant modifications may trigger a new final comment period.
* An RFC may be rejected by the team after public discussion has settled and
Expand Down