Skip to content

Ember: backport Owner improvements from Ember's own types#63589

Merged
typescript-bot merged 1 commit intoDefinitelyTyped:masterfrom
chriskrycho:ember-owner-backports
Dec 20, 2022
Merged

Ember: backport Owner improvements from Ember's own types#63589
typescript-bot merged 1 commit intoDefinitelyTyped:masterfrom
chriskrycho:ember-owner-backports

Conversation

@chriskrycho
Copy link
Copy Markdown
Contributor

This should let apps and libraries which are not yet ready to switch over to Ember's preview/stable types nonetheless be able to rely on the improvements we landed in these APIs, and aligns them to minimize the breaking changes from the DT types to Ember's table types on these particular fronts. Basically, this unlocks letting libraries use DT or Ember's own types for these during the transition, with them provided as appropriate by the host environment. Painful, but useful.

Please fill in this template.

Select one of these and delete the others:

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: These are scattered across a bunch of PRs; call it RFC 0821, I guess?

@typescript-bot
Copy link
Copy Markdown
Contributor

typescript-bot commented Dec 12, 2022

@chriskrycho Thank you for submitting this PR!

This is a live comment which I will keep updated.

2 packages in this PR

Code Reviews

Because this PR edits multiple packages, it can be merged once it's reviewed by a DT maintainer.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ A DT maintainer needs to approve changes which affect more than one package

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 63589,
  "author": "chriskrycho",
  "headCommitOid": "1926181e2071b4b7410cda0835bf1285044cc75a",
  "mergeBaseOid": "1861ec852f4daf8c81a747a05e8f21c667232cde",
  "lastPushDate": "2022-12-20T00:15:11.000Z",
  "lastActivityDate": "2022-12-20T00:27:27.000Z",
  "mergeOfferDate": "2022-12-20T00:22:07.000Z",
  "mergeRequestDate": "2022-12-20T00:27:27.000Z",
  "mergeRequestUser": "chriskrycho",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": "ember__owner",
      "kind": "edit",
      "files": [
        {
          "path": "types/ember__owner/ember__owner-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/ember__owner/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "chriskrycho",
        "dfreeman",
        "jamescdavis",
        "wagenet"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "ember__service",
      "kind": "edit",
      "files": [
        {
          "path": "types/ember__service/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "chriskrycho",
        "dfreeman",
        "jamescdavis",
        "wagenet"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "sandersn",
      "date": "2022-12-20T00:20:49.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "wagenet",
      "date": "2022-12-19T19:52:09.000Z",
      "abbrOid": "b66e695"
    },
    {
      "type": "stale",
      "reviewer": "gitKrystan",
      "date": "2022-12-12T21:57:08.000Z",
      "abbrOid": "38e6e88"
    }
  ],
  "mainBotCommentID": 1346905099,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added Popular package This PR affects a popular package (as counted by NPM download counts). Edits multiple packages Author is Owner The author of this PR is a listed owner of the package. labels Dec 12, 2022
@typescript-bot
Copy link
Copy Markdown
Contributor

🔔 @dfreeman @jamescdavis @wagenet — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Dec 12, 2022
@typescript-bot
Copy link
Copy Markdown
Contributor

@chriskrycho The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

chriskrycho added a commit to chriskrycho/ember-resolver that referenced this pull request Dec 12, 2022
Ultimately we'd like to convert the package to TS, but this unblocks
wider ecosystem adoption of the stable/preview Ember types. This PR can
also serve as a model for other packages which want to publish types in
a similar way.

This will also work just fine with the `@types` packages from
DefinitelyTyped once [a key PR][pr] lands there, but that is not the
path we will recommend, so this only includes the `ember-source` peer
dependency.

[pr]: DefinitelyTyped/DefinitelyTyped#63589
chriskrycho added a commit to chriskrycho/ember-resolver that referenced this pull request Dec 12, 2022
Ultimately we'd like to convert the package to TS, but this unblocks
wider ecosystem adoption of the stable/preview Ember types. This PR can
also serve as a model for other packages which want to publish types in
a similar way.

This will also work just fine with the `@types` packages from
DefinitelyTyped once [a key PR][pr] lands there, but that is not the
path we will recommend, so this only includes the `ember-source` peer
dependency.

[pr]: DefinitelyTyped/DefinitelyTyped#63589
@typescript-bot typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label Dec 12, 2022
@typescript-bot typescript-bot added the Other Approved This PR was reviewed and signed-off by a community member. label Dec 12, 2022
@chriskrycho chriskrycho force-pushed the ember-owner-backports branch from 38e6e88 to 27ea556 Compare December 12, 2022 22:01
@typescript-bot typescript-bot added The CI failed When GH Actions fails and removed Other Approved This PR was reviewed and signed-off by a community member. Owner Approved A listed owner of this package signed off on the pull request. The CI failed When GH Actions fails labels Dec 12, 2022
@typescript-bot
Copy link
Copy Markdown
Contributor

@chriskrycho The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

@chriskrycho chriskrycho force-pushed the ember-owner-backports branch from 27ea556 to 691b154 Compare December 19, 2022 16:43
@typescript-bot typescript-bot added The CI failed When GH Actions fails and removed The CI failed When GH Actions fails labels Dec 19, 2022
@typescript-bot
Copy link
Copy Markdown
Contributor

@chriskrycho The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

@chriskrycho chriskrycho force-pushed the ember-owner-backports branch from 691b154 to b66e695 Compare December 19, 2022 18:03
@chriskrycho chriskrycho changed the title Ember: backport Owner improvemenets from Ember's own types Ember: backport Owner improvements from Ember's own types Dec 19, 2022
@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Dec 19, 2022
@typescript-bot
Copy link
Copy Markdown
Contributor

@gitKrystan, @wagenet Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@typescript-bot
Copy link
Copy Markdown
Contributor

@gitKrystan Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@typescript-bot typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label Dec 19, 2022
@typescript-bot typescript-bot added Has Merge Conflict This PR can't be merged because it has a merge conflict. The author needs to update it. Maintainer Approved labels Dec 19, 2022
@typescript-bot
Copy link
Copy Markdown
Contributor

@chriskrycho Unfortunately, this pull request currently has a merge conflict 😥. Please update your PR branch to be up-to-date with respect to master. Have a nice day!

This should let apps and libraries which are not yet ready to switch
over to Ember's preview/stable types nonetheless be able to rely on the
improvements we landed in these APIs, and aligns them to minimize the
breaking changes from the DT types to Ember's table types on these
particular fronts. Basically, this unlocks letting libraries use DT
*or* Ember's own types for these during the transition, with them
provided as appropriate by the host environment. Painful, but useful.
@chriskrycho chriskrycho force-pushed the ember-owner-backports branch from b66e695 to 1926181 Compare December 20, 2022 00:15
@typescript-bot typescript-bot removed Has Merge Conflict This PR can't be merged because it has a merge conflict. The author needs to update it. Owner Approved A listed owner of this package signed off on the pull request. Maintainer Approved labels Dec 20, 2022
@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Dec 20, 2022
@typescript-bot
Copy link
Copy Markdown
Contributor

@chriskrycho: Everything looks good here. I am ready to merge this PR (at 1926181) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

@typescript-bot
Copy link
Copy Markdown
Contributor

@wagenet, @gitKrystan Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@chriskrycho
Copy link
Copy Markdown
Contributor Author

Ready to merge

@typescript-bot typescript-bot merged commit 8663ac1 into DefinitelyTyped:master Dec 20, 2022
@chriskrycho chriskrycho deleted the ember-owner-backports branch December 20, 2022 00:59
chriskrycho added a commit to ember-cli/ember-resolver that referenced this pull request Dec 20, 2022
Ultimately we'd like to convert the package to TS, but this unblocks
wider ecosystem adoption of the stable/preview Ember types. This PR can
also serve as a model for other packages which want to publish types in
a similar way.

This will also work just fine with the `@types` packages from
DefinitelyTyped once [a key PR][pr] lands there, but that is not the
path we will recommend, so this only includes the `ember-source` peer
dependency.

[pr]: DefinitelyTyped/DefinitelyTyped#63589

(cherry picked from commit 3907d48)

# Conflicts:
#	addon/package.json
#	package-lock.json
#	test-app/package.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Author is Owner The author of this PR is a listed owner of the package. Edits multiple packages Maintainer Approved Popular package This PR affects a popular package (as counted by NPM download counts). Self Merge This PR can now be self-merged by the PR author or an owner

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants