Skip to content

doc: deprecate util.toUSVString - #49725

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
anonrig:deprecate-util-tousvstring
Sep 21, 2023
Merged

doc: deprecate util.toUSVString#49725
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
anonrig:deprecate-util-tousvstring

Conversation

@anonrig

@anonriganonrig commented Sep 19, 2023•
edited
Loading

Copy link
Copy Markdown
Member

StringPrototypeToWellFormed can be disabled with a harmony flag. Therefore, we can't use it in core, but this doesn't mean that we can't doc-only deprecate it for developers.

In favor of String.prototype.toWellFormed doc-only deprecate util.toUSVString.

https://chromestatus.com/feature/5200195346759680

Ref: #47342

cc @nodejs/tsc

@anonriganonrig added semver-major PRs that contain breaking changes and should be released in the next major version. notable-change PRs with changes that should be highlighted in changelogs. deprecations Issues and PRs related to deprecations. labels Sep 19, 2023
@github-actions

github-actionsBot commented Sep 19, 2023

Copy link
Copy Markdown
Contributor

The notable-changePRs with changes that should be highlighted in changelogs. label has been added by @anonrig.

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment.

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Sep 19, 2023
@anonrig
anonrigforce-pushed the deprecate-util-tousvstring branch 2 times, most recently from 2f9868e to 3a320a4CompareSeptember 19, 2023 20:33
@targostargos added dont-land-on-v16.x and removed semver-major PRs that contain breaking changes and should be released in the next major version. labels Sep 20, 2023
@targos

targos commented Sep 20, 2023

Copy link
Copy Markdown
Member

doc-only deprecations don't need to be semver-major

targos
targos reviewed Sep 20, 2023
View reviewed changes
Comment threaddoc/api/deprecations.md Outdated
aduh95
aduh95 reviewed Sep 20, 2023
View reviewed changes
Comment threaddoc/api/deprecations.md Outdated
aduh95
aduh95 reviewed Sep 20, 2023
View reviewed changes
Comment threaddoc/api/deprecations.md Outdated
@aduh95

aduh95 commented Sep 20, 2023

Copy link
Copy Markdown
Contributor

You should remove doc-only from the commit is message, it's redundant with the doc: subprocess – and the guidelines say the first word after the subsystem should be a verb

@anonrig@aduh95@targos
doc: deprecate util.toUSVString
2ea4d98
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Michaël Zasso <targos@protonmail.com>
@anonrig
anonrigforce-pushed the deprecate-util-tousvstring branch from b8549d2 to 2ea4d98CompareSeptember 20, 2023 14:28
@anonriganonrig changed the title doc: doc-only deprecate util.toUSVStringdoc: deprecate util.toUSVStringSep 20, 2023
@anonrig
anonrig requested a review from aduh95September 20, 2023 22:00
@anonriganonrig added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 20, 2023
@anonriganonrig added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 20, 2023
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 21, 2023
@nodejs-github-bot
nodejs-github-bot merged commit 3116c37 into nodejs:mainSep 21, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 21, 2023

Copy link
Copy Markdown
Collaborator

Landed in 3116c37

ruyadorno pushed a commit that referenced this pull request Sep 28, 2023
@anonrig@aduh95
@targos@ruyadorno
doc: deprecate util.toUSVString
a5dd057
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Michaël Zasso <targos@protonmail.com>
PR-URL: #49725
Refs: #47342
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@ruyadornoruyadorno mentioned this pull request Sep 28, 2023
Closed
ruyadorno added a commit that referenced this pull request Sep 28, 2023
@ruyadorno
2023-09-28, Version 20.7.1 (Current)
eee298e
Notable changes:
doc:
* deprecate `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` (Livia Medeiros) #49683
* promote fetch/webstreams from experimental to stable (Steven) #45684
* deprecate `util.toUSVString` (Yagiz Nizipli) #49725
* deprecate calling `promisify` on a function that returns a promise (Antoine du Hamel) #49647
esm:
* set all hooks as release candidate (Geoffrey Booth) #49597
stream:
* use bitmap in writable state (Raz Luvaton) #49834
* use bitmap in readable state (Benjamin Gruenbaum) #49745
* improve webstream readable async iterator performance (Raz Luvaton) #49662
PR-URL: #49917
@ruyadornoruyadorno mentioned this pull request Sep 28, 2023
Merged
ruyadorno added a commit that referenced this pull request Sep 28, 2023
@ruyadorno
2023-09-28, Version 20.8.0 (Current)
a86c2ca
Notable changes:
deps:
* add v8::Object::SetInternalFieldForNodeCore() (Joyee Cheung) #49874
doc:
* deprecate `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` (Livia Medeiros) #49683
* deprecate `util.toUSVString` (Yagiz Nizipli) #49725
* deprecate calling `promisify` on a function that returns a promise (Antoine du Hamel) #49647
esm:
* set all hooks as release candidate (Geoffrey Booth) #49597
module:
* fix the leak in SourceTextModule and ContextifySript (Joyee Cheung) #48510
* fix leak of vm.SyntheticModule (Joyee Cheung) #48510
* use symbol in WeakMap to manage host defined options (Joyee Cheung) #48510
src:
* (SEMVER-MINOR) allow embedders to override NODE_MODULE_VERSION (Cheng Zhao) #49279
stream:
* use bitmap in writable state (Raz Luvaton) #49834
* use bitmap in readable state (Benjamin Gruenbaum) #49745
* improve webstream readable async iterator performance (Raz Luvaton) #49662
test_runner:
* (SEMVER-MINOR) accept `testOnly` in `run` (Moshe Atlow) #49753
* (SEMVER-MINOR) add junit reporter (Moshe Atlow) #49614
PR-URL: #49932
ruyadorno added a commit that referenced this pull request Sep 29, 2023
@ruyadorno
2023-09-28, Version 20.8.0 (Current)
5570c29
Notable changes:
deps:
* add v8::Object::SetInternalFieldForNodeCore() (Joyee Cheung) #49874
doc:
* deprecate `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` (Livia Medeiros) #49683
* deprecate `util.toUSVString` (Yagiz Nizipli) #49725
* deprecate calling `promisify` on a function that returns a promise (Antoine du Hamel) #49647
esm:
* set all hooks as release candidate (Geoffrey Booth) #49597
module:
* fix the leak in SourceTextModule and ContextifySript (Joyee Cheung) #48510
* fix leak of vm.SyntheticModule (Joyee Cheung) #48510
* use symbol in WeakMap to manage host defined options (Joyee Cheung) #48510
src:
* (SEMVER-MINOR) allow embedders to override NODE_MODULE_VERSION (Cheng Zhao) #49279
stream:
* use bitmap in writable state (Raz Luvaton) #49834
* use bitmap in readable state (Benjamin Gruenbaum) #49745
* improve webstream readable async iterator performance (Raz Luvaton) #49662
test_runner:
* (SEMVER-MINOR) accept `testOnly` in `run` (Moshe Atlow) #49753
* (SEMVER-MINOR) add junit reporter (Moshe Atlow) #49614
PR-URL: #49932
@fhanaufhanau mentioned this pull request Mar 20, 2024
Merged
debadree25 pushed a commit to debadree25/node that referenced this pull request Apr 15, 2024
@ruyadorno@debadree25
2023-09-28, Version 20.8.0 (Current)
2eb20e5
Notable changes:
deps:
* add v8::Object::SetInternalFieldForNodeCore() (Joyee Cheung) nodejs#49874
doc:
* deprecate `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` (Livia Medeiros) nodejs#49683
* deprecate `util.toUSVString` (Yagiz Nizipli) nodejs#49725
* deprecate calling `promisify` on a function that returns a promise (Antoine du Hamel) nodejs#49647
esm:
* set all hooks as release candidate (Geoffrey Booth) nodejs#49597
module:
* fix the leak in SourceTextModule and ContextifySript (Joyee Cheung) nodejs#48510
* fix leak of vm.SyntheticModule (Joyee Cheung) nodejs#48510
* use symbol in WeakMap to manage host defined options (Joyee Cheung) nodejs#48510
src:
* (SEMVER-MINOR) allow embedders to override NODE_MODULE_VERSION (Cheng Zhao) nodejs#49279
stream:
* use bitmap in writable state (Raz Luvaton) nodejs#49834
* use bitmap in readable state (Benjamin Gruenbaum) nodejs#49745
* improve webstream readable async iterator performance (Raz Luvaton) nodejs#49662
test_runner:
* (SEMVER-MINOR) accept `testOnly` in `run` (Moshe Atlow) nodejs#49753
* (SEMVER-MINOR) add junit reporter (Moshe Atlow) nodejs#49614
PR-URL: nodejs#49932
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lpincalpincalpinca approved these changes
@ronagronagronag approved these changes
@legendecaslegendecaslegendecas approved these changes
@trivikrtrivikrtrivikr approved these changes
@RafaelGSSRafaelGSSRafaelGSS approved these changes
@targostargosAwaiting requested review from targos
@aduh95aduh95Awaiting requested review from aduh95

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.deprecationsIssues and PRs related to deprecations.docIssues and PRs related to the documentations.notable-changePRs with changes that should be highlighted in changelogs.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@anonrig@targos@aduh95@nodejs-github-bot@lpinca@ronag@legendecas@trivikr@RafaelGSS