-
Notifications
You must be signed in to change notification settings - Fork 30.3k
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
[zen-observable] Add 'zen-observable/esm' entry point #44468
[zen-observable] Add 'zen-observable/esm' entry point #44468
Conversation
@BenoitZugmeyer Thank you for submitting this PR! This is a live comment which I will keep updated. Code ReviewsBecause this is a widely-used package, a DT maintainer will need to review it before it can be merged. Status
Once every item on this list is checked, I'll ask you for permission to merge and publish the changes. InactiveThis PR has been inactive for 31 days — it is considered abandoned! Diagnostic Information: What the bot saw about this PR{
"type": "info",
"now": "-",
"pr_number": 44468,
"author": "BenoitZugmeyer",
"owners": [
"aicest",
"JounQin",
"itomtom"
],
"dangerLevel": "ScopedAndTested",
"headCommitAbbrOid": "69ef3d9",
"headCommitOid": "69ef3d9b14470cbc8bc25288531c2d12d9b3eea9",
"mergeIsRequested": false,
"stalenessInDays": 31,
"lastPushDate": "2020-05-04T11:52:04.000Z",
"lastCommentDate": "2020-07-07T07:01:50.000Z",
"maintainerBlessed": false,
"reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/44468/files",
"hasMergeConflict": false,
"authorIsOwner": false,
"isFirstContribution": false,
"popularityLevel": "Critical",
"anyPackageIsNew": false,
"packages": [
"zen-observable"
],
"files": [
{
"path": "types/zen-observable/esm.d.ts",
"kind": "definition",
"package": "zen-observable"
},
{
"path": "types/zen-observable/index.d.ts",
"kind": "definition",
"package": "zen-observable"
},
{
"path": "types/zen-observable/test/esm.ts",
"kind": "test",
"package": "zen-observable"
},
{
"path": "types/zen-observable/test/index.ts",
"kind": "test",
"package": "zen-observable"
},
{
"path": "types/zen-observable/tsconfig.json",
"kind": "package-meta-ok",
"package": "zen-observable"
}
],
"hasDismissedReview": false,
"ciResult": "missing",
"lastReviewDate": "2020-05-18T23:02:47.000Z",
"reviewersWithStaleReviews": [],
"approvalFlags": 0,
"isChangesRequested": true
} |
🔔 @aicest @JounQin @itomtom - please review this PR in the next few days. Be sure to explicitly select |
👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings. Let’s review the numbers, shall we? Comparison details 📊
It looks like nothing changed too much. I won’t post performance data again unless it gets worse. |
This commit add support for importing "zen-observable/esm". Contrary to importing "zen-observable" directly, it doesn't expose the global namespace ZenObservable. Instead, it exports types directly.
0e9f8e2
to
69ef3d9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs experts sign off
@BenoitZugmeyer One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits or comments. If you disagree with the reviewer's comments, you can "dismiss" the review using GitHub's review UI. Thank you! |
What can I do to help this PR moving forward? |
@BenoitZugmeyer I haven't seen any activity on this PR in more than 3 weeks, and this PR currently has problems that prevent it from being merged. The PR will be closed in a week if the issues aren't addressed. |
Personally I'm not a fan of this, I think that a There are a lot of packages which contains commonjs/esm entry at the same time, I don't think we should add two types files in favor of |
A PR is open to add the "module" field zenparsing/zen-observable#74 In the meantime, I don't think that's a discussion we should have here. I just adjusted types to follow the current upstream package API because I wanted to use it. |
@BenoitZugmeyer To keep things tidy, we have to close PRs that aren't mergeable and don't have activity in the last month. No worries, though — please open a new PR if you'd like to continue with this change. Thank you! |
zen-observable added a
'zen-observable/esm'
entry point, exporting all code (index and extra) as an ES module. This PR add support for it.Contrary to importing
'zen-observable'
, it doesn't expose the global namespaceZenObservable
. Instead, I find it nicer to exports types directly.npm test
.)npm run lint package-name
(ortsc
if notslint.json
is present).Changing an existing definition:
tslint.json
containing{ "extends": "dtslint/dt.json" }
. If for reason the any rule need to be disabled, disable it for that line using// tslint:disable-next-line [ruleName]
and not for whole package so that the need for disabling can be reviewed.