Skip to content

Commit 6797c6e

Browse files
doc: add automated migration info to deprecations
PR-URL: #60022 Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Jacob Smith <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent d9b8a35 commit 6797c6e

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

doc/api/deprecations.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -551,6 +551,12 @@ Type: End-of-Life
551551
The `os.tmpDir()` API was deprecated in Node.js 7.0.0 and has since been
552552
removed. Please use [`os.tmpdir()`][] instead.
553553

554+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/tmpDir-to-tmpdir)):
555+
556+
```bash
557+
npx codemod@latest @nodejs/tmpDir-to-tmpdir
558+
```
559+
554560
### DEP0023: `os.getNetworkInterfaces()`
555561

556562
<!-- YAML
@@ -628,6 +634,12 @@ Type: End-of-Life
628634

629635
`util.print()` has been removed. Please use [`console.log()`][] instead.
630636

637+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/util-print-to-console-log)):
638+
639+
```bash
640+
npx codemod@latest @nodejs/util-print-to-console-log
641+
```
642+
631643
### DEP0027: `util.puts()`
632644

633645
<!-- YAML
@@ -649,6 +661,12 @@ Type: End-of-Life
649661

650662
`util.puts()` has been removed. Please use [`console.log()`][] instead.
651663

664+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/util-print-to-console-log)):
665+
666+
```bash
667+
npx codemod@latest @nodejs/util-print-to-console-log
668+
```
669+
652670
### DEP0028: `util.debug()`
653671

654672
<!-- YAML
@@ -670,6 +688,12 @@ Type: End-of-Life
670688

671689
`util.debug()` has been removed. Please use [`console.error()`][] instead.
672690

691+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/util-debug-to-console-error)):
692+
693+
```bash
694+
npx codemod@latest @nodejs/util-debug-to-console-error
695+
```
696+
673697
### DEP0029: `util.error()`
674698

675699
<!-- YAML
@@ -691,6 +715,12 @@ Type: End-of-Life
691715

692716
`util.error()` has been removed. Please use [`console.error()`][] instead.
693717

718+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/util-print-to-console-log)):
719+
720+
```bash
721+
npx codemod@latest @nodejs/util-print-to-console-log
722+
```
723+
694724
### DEP0030: `SlowBuffer`
695725

696726
<!-- YAML
@@ -1416,6 +1446,12 @@ By adopting one of these alternatives, you can transition away from `util.log()`
14161446
and choose a logging strategy that aligns with the specific
14171447
requirements and complexity of your application.
14181448

1449+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/util-log-to-console-log)):
1450+
1451+
```bash
1452+
npx codemod@latest @nodejs/util-log-to-console-log
1453+
```
1454+
14191455
### DEP0060: `util._extend()`
14201456

14211457
<!-- YAML
@@ -2754,6 +2790,12 @@ Type: End-of-Life
27542790

27552791
Use [`module.createRequire()`][] instead.
27562792

2793+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/create-require-from-path)):
2794+
2795+
```bash
2796+
npx codemod@latest @nodejs/create-require-from-path
2797+
```
2798+
27572799
### DEP0131: Legacy HTTP parser
27582800

27592801
<!-- YAML
@@ -2915,6 +2957,12 @@ modules is unsupported.
29152957
It is deprecated in favor of [`require.main`][], because it serves the same
29162958
purpose and is only available on CommonJS environment.
29172959

2960+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/process-main-module)):
2961+
2962+
```bash
2963+
npx codemod@latest @nodejs/process-main-module
2964+
```
2965+
29182966
### DEP0139: `process.umask()` with no arguments
29192967

29202968
<!-- YAML
@@ -3085,6 +3133,12 @@ Use `fs.rm(path, { recursive: true, force: true })`,
30853133
`fs.rmSync(path, { recursive: true, force: true })` or
30863134
`fs.promises.rm(path, { recursive: true, force: true })` instead.
30873135

3136+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/rmdir)):
3137+
3138+
```bash
3139+
npx codemod@latest @nodejs/rmdir
3140+
```
3141+
30883142
### DEP0148: Folder mappings in `"exports"` (trailing `"/"`)
30893143

30903144
<!-- YAML
@@ -3686,6 +3740,12 @@ Type: End-of-Life
36863740
`F_OK`, `R_OK`, `W_OK` and `X_OK` getters exposed directly on `node:fs` were
36873741
removed. Get them from `fs.constants` or `fs.promises.constants` instead.
36883742

3743+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/fs-access-mode-constants)):
3744+
3745+
```bash
3746+
npx codemod@latest @nodejs/fs-access-mode-constants
3747+
```
3748+
36893749
### DEP0177: `util.types.isWebAssemblyCompiledModule`
36903750

36913751
<!-- YAML
@@ -4031,6 +4091,12 @@ Instantiating classes without the `new` qualifier exported by the `node:http` mo
40314091
It is recommended to use the `new` qualifier instead. This applies to all http classes, such as
40324092
`OutgoingMessage`, `IncomingMessage`, `ServerResponse` and `ClientRequest`.
40334093

4094+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/http-classes-with-new)):
4095+
4096+
```bash
4097+
npx codemod@latest @nodejs/http-classes-with-new
4098+
```
4099+
40344100
### DEP0196: Calling `node:child_process` functions with `options.shell` as an empty string
40354101

40364102
<!-- YAML
@@ -4070,6 +4136,12 @@ Type: Documentation-only
40704136

40714137
The [`util.types.isNativeError`][] API is deprecated. Please use [`Error.isError`][] instead.
40724138

4139+
An automated migration is available ([source](https://github.com/nodejs/userland-migrations/tree/main/recipes/types-is-native-error)):
4140+
4141+
```bash
4142+
npx codemod@latest @nodejs/types-is-native-error
4143+
```
4144+
40734145
### DEP0198: Creating SHAKE-128 and SHAKE-256 digests without an explicit `options.outputLength`
40744146

40754147
<!-- YAML

0 commit comments

Comments
 (0)