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

Ember Data JavaScript Modules API #238

Closed
wants to merge 6 commits into from
Closed
Changes from 1 commit
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
Next Next commit
Create 0000-ember-data-javascript-module-api.md
  • Loading branch information
locks authored Jul 25, 2017
commit 2083413c8514efb3201224bf533f7922a5b80fc1
52 changes: 52 additions & 0 deletions text/0000-ember-data-javascript-module-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
- Start Date: 2017-07-25
- RFC PR: (leave this empty)
- Ember Issue: (leave this empty)

# Summary

Align Ember Data module API with [RFC #176](https://github.com/emberjs/rfcs/blob/master/text/0176-javascript-module-api.md).

# Motivation

This document proposes changes to the modules exported by Ember Data to make it consistent with the changes to the Ember module API proposed in [RFC #176](https://github.com/emberjs/rfcs/blob/master/text/0176-javascript-module-api.md).

# Detailed design

The

Ember Data will stick with 1 top level namespace of `ember-data`.
Under it there are 6 nested module namespaces where exposed components could live.
Someday these namespaces could be moved into their own top level scoped package (for example `ember-data/serializer` could become `@ember-data/serializer`) however,
that is not being proposed at this time.

# How We Teach This

What names and terminology work best for these concepts and why? How is this
idea best presented? As a continuation of existing Ember patterns, or as a
wholly new one?

Would the acceptance of this proposal mean the Ember guides must be
re-organized or altered? Does it change how Ember is taught to new users
at any level?

How should this feature be introduced and taught to existing Ember
users?

# Drawbacks

Why should we *not* do this? Please consider the impact on teaching Ember,
on the integration of this feature with other existing and planned features,
on the impact of the API churn on existing apps, etc.

There are tradeoffs to choosing any path, please attempt to identify them here.

# Alternatives

What other designs have been considered? What is the impact of not doing this?

This section could also include prior art, that is, how other frameworks in the same domain have solved this problem.

# Unresolved questions

Optional, but suggested for first drafts. What parts of the design are still
TBD?