From f4d33774f6798e9d939de6ff68b4fc949c0f6769 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Wed, 17 Mar 2021 12:31:43 -0700 Subject: [PATCH 1/3] doc: add legacy status to stability index Signed-off-by: James M Snell --- doc/api/documentation.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/api/documentation.md b/doc/api/documentation.md index a7a591d3733853..019040bdb61099 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -37,6 +37,12 @@ The stability indices are as follows: > Stability: 2 - Stable. Compatibility with the npm ecosystem is a high > priority. + + +> Stability: 3 - Legacy. The feature is no longer recommended for use. While it +likely will not be removed, and is still covered by semantic-versioning +guarantees, use of the feature should be avoided. + Use caution when making use of Experimental features, particularly within modules. Users may not be aware that experimental features are being used. Bugs or behavior changes may surprise users when Experimental API From c22762c66c58bb6112b11c13a2041ef4098bced1 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Wed, 17 Mar 2021 12:40:58 -0700 Subject: [PATCH 2/3] doc: revoke deprecation of legacy url, change status to legacy Signed-off-by: James M Snell Fixes: https://github.com/nodejs/node/issues/25099 --- doc/api/deprecations.md | 5 ++++- doc/api/url.md | 30 +++++++++++++++++++++++++----- 2 files changed, 29 insertions(+), 6 deletions(-) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 9ec966c52635f0..bd92a3b32e17b6 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2172,12 +2172,15 @@ future release. ### DEP0116: Legacy URL API -Type: Documentation-only +Type: Deprecation revoked The [Legacy URL API][] is deprecated. This includes [`url.format()`][], [`url.parse()`][], [`url.resolve()`][], and the [legacy `urlObject`][]. Please diff --git a/doc/api/url.md b/doc/api/url.md index e78b15d09d28d1..f93cf741473794 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -1075,18 +1075,29 @@ console.log(urlToHttpOptions(myUrl)); ## Legacy URL API +> Stability: 3 - Legacy: Use the WHATWG URL API instead. + ### Legacy `urlObject` -> Stability: 0 - Deprecated: Use the WHATWG URL API instead. +> Stability: 3 - Legacy: Use the WHATWG URL API instead. The legacy `urlObject` (`require('url').Url`) is created and returned by the `url.parse()` function. @@ -1192,6 +1203,9 @@ forward-slash characters (`/`) are required following the colon in the -> Stability: 0 - Deprecated: Use the WHATWG URL API instead. +> Stability: 3 - Legacy: Use the WHATWG URL API instead. * `urlObject` {Object|string} A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing @@ -1285,6 +1299,9 @@ The formatting process operates as follows: -> Stability: 0 - Deprecated: Use the WHATWG URL API instead. +> Stability: 3 - Legacy: Use the WHATWG URL API instead. * `urlString` {string} The URL string to parse. * `parseQueryString` {boolean} If `true`, the `query` property will always @@ -1329,6 +1346,9 @@ incorrect handling of usernames and passwords have been identified. -> Stability: 0 - Deprecated: Use the WHATWG URL API instead. +> Stability: 3 - Legacy: Use the WHATWG URL API instead. * `from` {string} The Base URL being resolved against. * `to` {string} The HREF URL being resolved. From dcc2345a1961f9b4ec4d4797620c0279f449de78 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 19 Mar 2021 10:54:53 -0700 Subject: [PATCH 3/3] doc: apply style for legacy status Signed-off-by: James M Snell --- doc/api_assets/style.css | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/api_assets/style.css b/doc/api_assets/style.css index fb34bcf12a2195..189015268bcb72 100644 --- a/doc/api_assets/style.css +++ b/doc/api_assets/style.css @@ -4,6 +4,7 @@ --black1: #090c15; --black2: #2c3437; --black3: #0d111d; + --blue1: #00f; --white: #ffffff; --white-smoke: #f2f2f2; --grey-smoke: #e9edf0; @@ -263,6 +264,10 @@ ol.version-picker li:last-child a { background-color: var(--green2); } +.api_stability_3 { + background-color: var(--blue1); +} + .module_stability { vertical-align: middle; } @@ -372,7 +377,7 @@ dd + dt.pre { #apicontent { padding-top: 1rem; } - + #apicontent section { content-visibility: auto; contain-intrinsic-size: 1px 5000px;