Skip to content
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

Add TypeScript guides #1960

Merged
merged 63 commits into from
Oct 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
a959a47
Add TypeScript guides under construction page
gitKrystan Aug 27, 2023
9ca1517
WIP: Copy-pasta guides from ember-cli-typescript
gitKrystan Aug 31, 2023
acacabd
Apply suggestions from code review
gitKrystan Sep 1, 2023
a02e4e5
Finish initial copy-pasta from ember-cli-typescript docs
gitKrystan Sep 2, 2023
2ccf729
Add under-construction notes
gitKrystan Sep 2, 2023
4ff4476
Adjust h# for pages that were combined from ember-cli-ts docs
gitKrystan Sep 2, 2023
71baee2
Clean up code-block formatting
gitKrystan Sep 2, 2023
21db39c
Another pass on Getting Started
gitKrystan Sep 2, 2023
5697ca3
Move configuration section later
gitKrystan Sep 2, 2023
f8a08ef
Pull stuff out of ts-and-ember section
gitKrystan Sep 2, 2023
124c845
Rename ts-for-ember to gotchas
gitKrystan Sep 2, 2023
384738a
Reorg to put core concepts as early as possible
gitKrystan Sep 2, 2023
9759f75
Add basic guide to Signatures to 'Using TypeScript'
chriskrycho Sep 12, 2023
ae04b3d
Improve signatures guide write-up for advanced types
chriskrycho Sep 12, 2023
ee500b1
Add concluding note about advanced types in 'signatures'
chriskrycho Sep 12, 2023
2fb8ee0
Add Legacy section
gitKrystan Sep 16, 2023
96b9959
A little cleanup on getting-started and index
gitKrystan Sep 16, 2023
ddf3415
Edit pass on Signatures section
gitKrystan Sep 16, 2023
c2d76dc
First pass cleanup of TypeScript and Ember chapter
gitKrystan Sep 24, 2023
b9fd491
Rename signatures to invokables
gitKrystan Sep 24, 2023
48083cd
Merge invokable content from TS and Ember section into invokables sec…
gitKrystan Sep 24, 2023
33bff6a
Move modifiers after helpers
gitKrystan Sep 24, 2023
fa22cc3
Split out remaining core concepts chapters
gitKrystan Sep 24, 2023
9c8bdaf
Nest core-concepts
gitKrystan Sep 24, 2023
fd91537
Nest more chapters
gitKrystan Sep 24, 2023
c390598
Move Ember classic components section to legacy section
gitKrystan Sep 24, 2023
e90591c
Move ember debug discussion to FAQ
gitKrystan Sep 24, 2023
6b31c10
Re-org faq/gotchas sections
gitKrystan Sep 24, 2023
4ae0fc7
Move configuration section
gitKrystan Sep 24, 2023
b478630
Rename getting started
gitKrystan Sep 28, 2023
6c62376
Rename TypeScript and Ember
gitKrystan Oct 1, 2023
680fb43
Clean up routing chapter
gitKrystan Oct 1, 2023
728c078
Clean up services chapter
gitKrystan Oct 1, 2023
3d8ccd9
Clean up EmberData section
gitKrystan Oct 1, 2023
38422ce
Clean up configuration chapter
gitKrystan Oct 1, 2023
16c50b7
Start editing testing section
gitKrystan Oct 2, 2023
d9ddafc
Incorporate more comments from @chriskrycho
gitKrystan Oct 8, 2023
bf45d0f
Clean up testing language
gitKrystan Oct 8, 2023
bfe7e07
Re-org testing section
gitKrystan Oct 8, 2023
d0e94cc
Start converting an app chapter
gitKrystan Oct 8, 2023
f062bab
More changes to converting-an-app
gitKrystan Oct 8, 2023
d579115
Clean up addon chapter text
gitKrystan Oct 9, 2023
e6d7859
Edit legacy chapter
gitKrystan Oct 9, 2023
eaa112e
First pass edit on Gotchas section
gitKrystan Oct 10, 2023
7ba44ae
Move service/controller injection documentation to respective sections
gitKrystan Oct 10, 2023
87546f2
Finish Gotchas cleanup
gitKrystan Oct 13, 2023
ec81714
Clean up FAQ and Tips section
gitKrystan Oct 13, 2023
45d2c89
Tidy up
gitKrystan Oct 13, 2023
1753ba8
Fix pages.yml diff
gitKrystan Oct 13, 2023
2070660
Add filenames to legacy chapter
gitKrystan Oct 13, 2023
11335f1
Update guidemaker deps to support TS
gitKrystan Oct 13, 2023
a304180
Remove TS chapter from TOC
gitKrystan Oct 13, 2023
ab953bd
Address PR feedback
gitKrystan Oct 16, 2023
8b82c71
Fix typo in link
gitKrystan Oct 16, 2023
91572b7
Add intro pages in lieu of redirects
gitKrystan Oct 16, 2023
ee796d1
Simplify URL for TypeScript chapter
gitKrystan Oct 16, 2023
8c6929f
Link to this-type in legacy chapter
gitKrystan Oct 16, 2023
0f0dd2a
Update guides/release/typescript/core-concepts/ember-data.md
gitKrystan Oct 20, 2023
831e131
Apply suggestions from code review
gitKrystan Oct 20, 2023
d0bbe4e
Fix references to "Ember Guides"
gitKrystan Oct 22, 2023
3fefd39
Fix lint
gitKrystan Oct 22, 2023
20108ff
fixing expect call in tests
mansona Oct 23, 2023
98880da
add missing trailing slashes in links
mansona Oct 23, 2023
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
98 changes: 58 additions & 40 deletions .local.dic
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
*google
*NPM
2FA
30KB
activations
acyclic
ActiveSupport
acyclic
Algolia
asynchronicity
Americentric
asynchronicity
asynchrony
autocomplete
autotrack
auto-rollup
autocomplete
autocompletion
autoruns
autotrack
autotracking
aXe
backticks
Expand All @@ -24,8 +27,8 @@ camelize
Chai
chainable
cheatsheet
Checkboxes
checkboxes
Checkboxes
coc-ember
CoffeeScript
ColorSafe
Expand All @@ -44,31 +47,37 @@ datepicker
de
debounce
declaratively
DefinitelyTyped
deps
draggable
dropdown
durations
dynamicness
EditorConfig
els-addon-docs
els-addon-typed-templates
enumerables
ember-a11y
ember-a11y-refocus
ember-a11y-testing
ember-cli-deprecation-workflow
ember-cli-cjs-transform
ember-cli-deprecation-workflow
ember-cli-document-title
ember-cli-head
ember-cli-htmlbars
ember-cli-netlify
ember-cli-mirage.
ember-cli-netlify
ember-cli-tutorial-style
ember-cli-typescript
ember-debug-handlers-polyfill
ember-fast-cli
ember-intl
EmberData
EmberObject
enumerables
erroring
Evented
facto
fallbacks
FastPass
favicon
Favicon
Expand All @@ -82,11 +91,10 @@ geocoding
getter
getters
Getters
GitLab
GIFs
globbing
GitLab
GlimmerX
*google
globbing
hackable
HammerJS
hardcode
Expand All @@ -95,25 +103,30 @@ Hm
Hoc
htmlbars
IE11
interop
interoperable
invocable
invoker
IndexedDB
Inflector
instantiation
Intellisense
IntelliSense
interop
interoperable
invokable
invokables
invoker
invoker
invokers
JetBrains
jquery-integration
JSDoc
keyCode
KVO
lang
linters
LSP
lookups
LSP
Mapbox
MDN
metaprogramming
misspelt
mixin
mixins
Expand All @@ -123,103 +136,108 @@ natively
nav
nav-bar
Neovim
*NPM
NVDA
onboarding
Orca
page-crafter
parallelize
Param
param
params
Param
parameterizing
params
PascalCased
pipelining
PR
PRs
preload
prepend
prepended
pre-determined
pre-octane
pre-populating
pre-transition
pre-transition
preload
prepend
prepended
presentational
Presentational
pre-transition
pre-octane
PRs
readme
readonly
recognizers
recursing
Redux
relayout
renderer
repo
repos
rerender
rerenders
rerendering
rerenders
routable
RunDOC
Runnable
runnable
Runnable
runtime
sandboxed
scp
screencasting
selectable
self-referentiality
serverless
singularize
source-readibility
Splattributes
SSR
stateful
subclassed
subclasses
subclassing
subdomain
subexpression
substring
subfolders
suboptimal
subroutes
substate
substates
substring
SuperForm
superset
swappable
synergistically
syntaxes
swappable
tagless
TalkBack
teardown
template-lifecycle-dom-and-modifiers
templating
todo
todos
treesitter
triple-backtick
tooltip
trackable
Trackable
Treeshaking
treesitter
triple-backtick
typeahead
typechecker
typings
UIs
URL-escaped
un-representable
unordered
unsilence
unstyled
untracked
untrusted
URL-escaped
usecase
v1
v2
viewport
vim-ember-hbs
vim-javascript
vim-js-pretty-template
VM
Voilà
voilà
VoiceOver
voilà
Voilà
websocket
Websockets
ZEIT
yay
template-lifecycle-dom-and-modifiers
working-with-html-css-and-javascript
dropdown
yay
ZEIT
12 changes: 4 additions & 8 deletions guides/release/code-editors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Stable Ember Language Server is a stable, full-featured language server. Its nam

### Workflow

[ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Integrates ESLint into VS Code.
[ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Integrates ESLint into VS Code.

[EditorConfig for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) -
Attempts to override user/workspace settings with settings found in `.editorconfig` files.
Expand All @@ -49,8 +49,7 @@ Prettier is an opinionated code formatting tool. It enforces a consistent style
</div>
</div>


[Glint](https://marketplace.visualstudio.com/items?itemName=typed-ember.glint-vscode) is a set of tools to aid in developing code that uses the Glimmer VM for rendering, such as Ember.js v3.24+ and GlimmerX projects.
[Glint](https://marketplace.visualstudio.com/items?itemName=typed-ember.glint-vscode) is a set of tools to aid in developing code that uses the Glimmer VM for rendering, such as Ember.js v3.24+ and GlimmerX projects.

## Vim and Neovim

Expand All @@ -76,10 +75,10 @@ or
[vim-ember-hbs](https://github.com/joukevandermaas/vim-ember-hbs) -
Add Ember template syntax highlighting and indentation to Vim.
To get embedded highlighting will involve these additional plugins:

- [vim-javascript](https://github.com/pangloss/vim-javascript)
- [vim-js-pretty-template](https://github.com/Quramy/vim-js-pretty-template)


### Language Server

Only one of these solutions should be used at a time.
Expand All @@ -91,21 +90,18 @@ Example mason+LSP config [can be found here](https://github.com/NullVoxPopuli/do
or

[Conquer for Completion (COC) for Neovim](https://github.com/neoclide/coc.nvim) -
An Intellisense engine which takes control over all linting, hinting, and language-server integration.
An IntelliSense engine which takes control over all linting, hinting, and language-server integration.
With the ember plugin [coc-ember](https://github.com/NullVoxPopuli/coc-ember) -
Ember.js language server extension including useful configuration instructions.

### Snippets / Workflow


[ember.vim](https://github.com/dsawardekar/ember.vim) -
Shortcuts to navigate related files with Ember.js projects.


[Ember Tools](https://github.com/AndrewRadev/ember_tools.vim) -
Various tools for working with Ember.js projects.


## Atom

Atom is hackable text editor for the 21st Century.
Expand Down
44 changes: 44 additions & 0 deletions guides/release/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,50 @@
pages:
- title: "Managing Dependencies"
url: "index"
- title: "Using TypeScript"
url: "typescript"
pages:
- title: "Using TypeScript with Ember"
url: "index"
- title: "TypeScript: Getting Started"
url: "getting-started"
- title: "TypeScript: Core Concepts"
url: "core-concepts"
pages:
- title: "TypeScript and Ember"
url: "index"
- title: "TypeScript: Invokables"
url: "invokables"
- title: "TypeScript: Routing"
url: "routing"
- title: "TypeScript: Services"
url: "services"
- title: "TypeScript and EmberData"
url: "ember-data"
- title: "TypeScript: Application Development"
url: "application-development"
pages:
- title: "Introduction"
url: "index"
- title: "TypeScript: Configuration"
url: "configuration"
- title: "TypeScript: Testing"
url: "testing"
- title: "TypeScript: Converting an Existing Ember App"
url: "converting-an-app"
- title: "TypeScript: Addons"
url: "addons"
- title: "TypeScript: Additional Resources"
url: "additional-resources"
pages:
- title: "Introduction"
url: "index"
- title: "TypeScript: Gotchas and Troubleshooting"
url: "gotchas"
- title: "TypeScript: FAQ and Tips"
url: "faq"
- title: "TypeScript: Working with Ember Classic"
url: "legacy"
- title: "Developer Tools"
url: "toc-heading_developer-tools"
is_heading: true
Expand Down
Loading
Loading