diff --git a/docs/modules/README.md b/docs/modules/README.md index a09649d9..d0eeae8d 100644 --- a/docs/modules/README.md +++ b/docs/modules/README.md @@ -81,6 +81,7 @@ ESLint plugin. - [`ora`](./ora.md) - [`path-exists`](./path-exists.md) - [`portal-vue`](./portal-vue.md) +- [`portfinder`](./portfinder.md) - [`pkg-dir`](./pkg-dir.md) - [`qs`](./qs.md) - [`react-helmet`](./react-helmet.md) diff --git a/docs/modules/portfinder.md b/docs/modules/portfinder.md new file mode 100644 index 00000000..6c8faece --- /dev/null +++ b/docs/modules/portfinder.md @@ -0,0 +1,19 @@ +--- +description: Modern alternatives to the portfinder package for finding an available port +--- + +# Replacements for `portfinder` + +## `get-port` + +[`get-port`](https://github.com/lukeed/get-port) provides a more generic way to find files and directories upwards. + +Example: + +```ts +import portfinder from 'portfinder' // [!code --] +import getPort from 'get-port' // [!code ++] + +const port = await portfinder.getPortPromise() // [!code --] +const port = await getPort() // [!code ++] +``` diff --git a/manifests/preferred.json b/manifests/preferred.json index f78b0c18..bd13a156 100644 --- a/manifests/preferred.json +++ b/manifests/preferred.json @@ -2448,6 +2448,12 @@ "replacements": ["Teleport"], "url": {"type": "e18e", "id": "portal-vue"} }, + "portfinder": { + "type": "module", + "moduleName": "portfinder", + "replacements": ["get-port"], + "url": {"type": "e18e", "id": "portfinder"} + }, "preferred-pm": { "type": "module", "moduleName": "preferred-pm", @@ -3068,6 +3074,12 @@ }, "url": {"type": "node", "id": "api/fs.html#fspromisesrmdirpath-options"} }, + "get-port": { + "id": "get-port", + "type": "documented", + "url": {"type": "e18e", "id": "portfinder"}, + "replacementModule": "get-port" + }, "grammy": { "id": "grammy", "type": "documented",