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
[@types/selenium-webdriver]: split Chromium into a new file #69487
base: master
Are you sure you want to change the base?
Conversation
- add tests for chromium - remove some obsolete functions and add more functions
@sangcnguyen Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through. This is a live comment which I will keep updated. 1 package in this PRCode ReviewsBecause this is a widely-used package, a DT maintainer will need to review it before it can be merged. You can test the changes of this PR in the Playground. Status
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": 69487,
"author": "sangcnguyen",
"headCommitOid": "815f0f0700b3a1d217a826b34a7d04719bba7f57",
"mergeBaseOid": "64828b61751341bfdb2bd5ba88ef61c1f1f77cb8",
"lastPushDate": "2024-05-01T17:45:11.000Z",
"lastActivityDate": "2024-05-17T20:13:53.000Z",
"mergeOfferDate": "2024-05-17T20:14:30.000Z",
"hasMergeConflict": false,
"isFirstContribution": true,
"tooManyFiles": false,
"hugeChange": false,
"popularityLevel": "Critical",
"pkgInfo": [
{
"name": "selenium-webdriver",
"kind": "edit",
"files": [
{
"path": "types/selenium-webdriver/chrome.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/chromium.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/edge.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/firefox.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/ie.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/index.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/lib/command.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/lib/input.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/lib/webdriver.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/package.json",
"kind": "package-meta-ok"
},
{
"path": "types/selenium-webdriver/safari.d.ts",
"kind": "definition"
},
{
"path": "types/selenium-webdriver/test/chrome.ts",
"kind": "test"
},
{
"path": "types/selenium-webdriver/test/chromium.ts",
"kind": "test"
},
{
"path": "types/selenium-webdriver/test/edge.ts",
"kind": "test"
},
{
"path": "types/selenium-webdriver/test/firefox.ts",
"kind": "test"
},
{
"path": "types/selenium-webdriver/test/index.ts",
"kind": "test"
},
{
"path": "types/selenium-webdriver/tsconfig.json",
"kind": "package-meta-ok"
}
],
"owners": [
"BillArmstrong",
"Kuniwak",
"cnishina",
"SupernaviX",
"bendxn",
"oddui",
"beta-vulgaris",
"Dzenly",
"AutomatedTester",
"1pete",
"SinghHrmn",
"shubhsheth"
],
"addedOwners": [],
"deletedOwners": [],
"popularityLevel": "Critical"
}
],
"reviews": [
{
"type": "approved",
"reviewer": "sandersn",
"date": "2024-05-17T20:13:53.000Z",
"isMaintainer": true
},
{
"type": "stale",
"reviewer": "jakebailey",
"date": "2024-05-10T21:49:36.000Z",
"abbrOid": "b393e5a"
},
{
"type": "stale",
"reviewer": "SupernaviX",
"date": "2024-05-05T00:53:35.000Z",
"abbrOid": "29837a4"
}
],
"mainBotCommentID": 2088829993,
"ciResult": "pass"
} |
🔔 @BillArmstrong @Kuniwak @cnishina @SupernaviX @bendxn @oddui @beta-vulgaris @Dzenly @AutomatedTester @1pete @SinghHrmn @shubhsheth — please review this PR in the next few days. Be sure to explicitly select |
FormattingThe following files are not formatted:
as well as these 4 other files...types/selenium-webdriver/lib/webdriver.d.ts, types/selenium-webdriver/test/chromium.ts, types/selenium-webdriver/test/firefox.ts, types/selenium-webdriver/test/chrome.ts Consider running |
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.
Mostly looks good! but there's some incorrect types in chromium.d.ts
* @param {...(string|!Buffer|!Array<(string|!Buffer)>)} args The | ||
* extensions to add. | ||
*/ | ||
add(...args: string[] | Buffer[]): any; |
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.
add(...args: string[] | Buffer[]): any; | |
add(...args: (string | Buffer)[]); |
I think these types are more accurate. This lets you pass strings and buffers in the same call, and also doesn't return anything (just like the real impl)
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.
All set! Could you do me a favor by reviewing it again?
* @see <https://w3c.github.io/permissions/#permission-registry> for valid | ||
* names | ||
*/ | ||
setPermission(name: string, state: "granted" | "denied" | "prompt"): Promise<Object>; |
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.
setPermission(name: string, state: "granted" | "denied" | "prompt"): Promise<Object>; | |
setPermission(name: string, state: "granted" | "denied" | "prompt"): Promise<object>; |
typescript docs say that lowercase object
is more appropriate than uppercase Object
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.
Many thanks! I didn’t notice this, I overlooked it while typing.
@sangcnguyen 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. Thank you! |
@SupernaviX 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? |
Co-authored-by: Simon Gellis <[email protected]>
@sangcnguyen 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. |
@sangcnguyen 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. |
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.
Looks good!
@jakebailey 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? |
@jakebailey, @SupernaviX 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? |
Re-ping @BillArmstrong, @Kuniwak, @cnishina, @SupernaviX, @bendxn, @oddui, @beta-vulgaris, @Dzenly, @AutomatedTester, @1pete, @SinghHrmn, @shubhsheth: This PR has been out for over a week, yet I haven't seen any reviews. Could someone please give it some attention? Thanks! |
@sangcnguyen is this ready to go? I think the bot is being too careful here since little has changed since @SupernaviX 's review, and you sound confident that |
Hi @sandersn just a minor change. I reverted to the old name for compatibility. |
@sangcnguyen: Everything looks good here. I am ready to merge this PR (at 815f0f0) on your behalf whenever you think it's ready. If you'd like that to happen, please post a comment saying:
and I'll merge this PR almost instantly. Thanks for helping out! ❤️ (@BillArmstrong, @Kuniwak, @cnishina, @SupernaviX, @bendxn, @oddui, @beta-vulgaris, @Dzenly, @AutomatedTester, @1pete, @SinghHrmn, @shubhsheth: you can do this too.) |
Please fill in this template.
pnpm test <package to test>
.Select one of these and delete the others:
If adding a new definition:
.d.ts
files generated via--declaration
dts-gen --dt
, not by basing it on an existing project.tsconfig.json
should havenoImplicitAny
,noImplicitThis
,strictNullChecks
, andstrictFunctionTypes
set totrue
.If changing an existing definition:
package.json
.If removing a declaration:
notNeededPackages.json
.