From 399671c19574385c9c55080d16865648b4fa0c2b Mon Sep 17 00:00:00 2001 From: Peter Wagenet Date: Fri, 29 Sep 2023 10:34:00 -0700 Subject: [PATCH 1/3] Add glint-as-default placeholder RFC --- text/0976-glint-as-default.md | 72 +++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 text/0976-glint-as-default.md diff --git a/text/0976-glint-as-default.md b/text/0976-glint-as-default.md new file mode 100644 index 0000000000..608d57d9d9 --- /dev/null +++ b/text/0976-glint-as-default.md @@ -0,0 +1,72 @@ +--- +stage: accepted +start-date: 2023-09-29T00:00:00.000Z +release-date: # In format YYYY-MM-DDT00:00:00.000Z +release-versions: +teams: # delete teams that aren't relevant + - cli + - framework + - learning + - typescript +prs: + accepted: https://github.com/emberjs/rfcs/pull/976 +project-link: +suite: +--- + +# Enable Glint by Default + +## Summary + +> Glint should be enabled as a default for Ember projects. + + From bb4bc19acdbf269d869685401e22e454353b498d Mon Sep 17 00:00:00 2001 From: Peter Wagenet Date: Thu, 26 Oct 2023 09:55:54 -0700 Subject: [PATCH 2/3] Fill out body --- text/0976-glint-as-default.md | 97 +++++++++++++++++++++++++++++++++-- 1 file changed, 93 insertions(+), 4 deletions(-) diff --git a/text/0976-glint-as-default.md b/text/0976-glint-as-default.md index 608d57d9d9..53d6c7205b 100644 --- a/text/0976-glint-as-default.md +++ b/text/0976-glint-as-default.md @@ -18,55 +18,144 @@ suite: ## Summary -> Glint should be enabled as a default for Ember projects. +[Glint](https://typed-ember.gitbook.io/glint) should be enabled as a default for Ember projects. - +With JSDoc component signatures, JS users can also get many of Glint’s benefits. From c38de4f1cca4970ec96a0c58e50c96980a0a5958 Mon Sep 17 00:00:00 2001 From: Peter Wagenet Date: Thu, 9 Nov 2023 09:50:05 -0800 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: MrChocolatine <47531779+MrChocolatine@users.noreply.github.com> --- text/0976-glint-as-default.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/text/0976-glint-as-default.md b/text/0976-glint-as-default.md index 53d6c7205b..c180d09cb2 100644 --- a/text/0976-glint-as-default.md +++ b/text/0976-glint-as-default.md @@ -78,9 +78,9 @@ users? ### Terminology -********************registry:******************** In traditional templates with .hbs files (i.e. not template tag), all lookups are done via strings. Since we can’t rely on import statements to discover types, we instead use a type-registry. The type-registry serves to map strings to their corresponding type definitions. +********************registry:******************** In traditional templates with `.hbs` files (i.e. not template tag), all lookups are done via strings. Since we can’t rely on import statements to discover types, we instead use a type-registry which serves to map strings to their corresponding type definitions. -```tsx +```ts declare module '@glint/environment-ember-loose/registry' { export default interface Registry { 'MyComponent': typeof MyComponent; @@ -92,9 +92,9 @@ declare module '@glint/environment-ember-loose/registry' { **Initial Announcement:** Make an official announcement on the Ember.js blog and mailing list to inform the community about the plan to adopt Glint as a default/recommended tool. -**Documentation Updates:** Update the Ember.js Gudies to include information about Glint, its benefits, and how to use it effectively. +**Documentation Updates:** Update the Ember.js Guides to include information about Glint, its benefits, and how to use it effectively. -Provide examples and best practices for leveraging Glint effectively. The current [TypeScript Guides](https://github.com/ember-learn/guides-source/pull/1960) have many places where we can reference Glint (e.g. in areas where we currently say that templates are *not* type-checked). We can also reference the [existing Glint documentation](https://typed-ember.gitbook.io/glint/) and merge its relevant content with the TypeScript guides. Additionally we should document the existence of any plugins/extensions as mentioned above in “Plugin Ecosystem.” +Provide examples and best practices for leveraging Glint effectively. The current [TypeScript Guides](https://github.com/ember-learn/guides-source/pull/1960) have many places where we can reference Glint (e.g. in areas where we currently say that templates are *not* type-checked). We can also reference the [existing Glint documentation](https://typed-ember.gitbook.io/glint/) and merge its relevant content with the TypeScript Guides. Additionally we should document the existence of any plugins/extensions as mentioned above in “Plugin Ecosystem.” **Integration Work:** Collaborate with the Glint project (which is maintained by Ember’s TypeScript and Tooling Core Teams) to ensure smooth integration into Ember.js, addressing any compatibility issues that may arise.