Skip to content

Commit fbcf259

Browse files
gameroman43081jghostdevv
authored
feat: add portfinder to preferred manifest (#494)
* feat: add `portfinder` to preferred manifest * Update docs/modules/portfinder.md Co-authored-by: James Garbutt <43081j@users.noreply.github.com> * Update docs/modules/README.md Co-authored-by: Willow (GHOST) <ghostdevbusiness@gmail.com> --------- Co-authored-by: James Garbutt <43081j@users.noreply.github.com> Co-authored-by: Willow (GHOST) <ghostdevbusiness@gmail.com>
1 parent f89fb68 commit fbcf259

3 files changed

Lines changed: 33 additions & 1 deletion

File tree

docs/modules/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,9 @@ ESLint plugin.
8686
- [`ora`](./ora.md)
8787
- [`path-exists`](./path-exists.md)
8888
- [`pbkdf2`](./pbkdf2.md)
89-
- [`portal-vue`](./portal-vue.md)
9089
- [`pkg-dir`](./pkg-dir.md)
90+
- [`portal-vue`](./portal-vue.md)
91+
- [`portfinder`](./portfinder.md)
9192
- [`qs`](./qs.md)
9293
- [`react-helmet`](./react-helmet.md)
9394
- [`react-feather`](./feather.md)

docs/modules/portfinder.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
description: Modern alternatives to the portfinder package for finding an available port
3+
---
4+
5+
# Replacements for `portfinder`
6+
7+
## `get-port`
8+
9+
[`get-port`](https://github.com/sindresorhus/get-port) is a lighter and more modern package for finding an available port.
10+
11+
Example:
12+
13+
```ts
14+
import portfinder from 'portfinder' // [!code --]
15+
import getPort from 'get-port' // [!code ++]
16+
17+
const port = await portfinder.getPortPromise() // [!code --]
18+
const port = await getPort() // [!code ++]
19+
```

manifests/preferred.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2508,6 +2508,12 @@
25082508
"replacements": ["Teleport"],
25092509
"url": {"type": "e18e", "id": "portal-vue"}
25102510
},
2511+
"portfinder": {
2512+
"type": "module",
2513+
"moduleName": "portfinder",
2514+
"replacements": ["get-port"],
2515+
"url": {"type": "e18e", "id": "portfinder"}
2516+
},
25112517
"preferred-pm": {
25122518
"type": "module",
25132519
"moduleName": "preferred-pm",
@@ -3188,6 +3194,12 @@
31883194
},
31893195
"url": {"type": "node", "id": "api/fs.html#fspromisesrmdirpath-options"}
31903196
},
3197+
"get-port": {
3198+
"id": "get-port",
3199+
"type": "documented",
3200+
"url": {"type": "e18e", "id": "portfinder"},
3201+
"replacementModule": "get-port"
3202+
},
31913203
"grammy": {
31923204
"id": "grammy",
31933205
"type": "documented",

0 commit comments

Comments
 (0)