Skip to content

Commit 268e0d7

Browse files
authored
docs: update core plugin names (fastify#3975)
* docs(ecosystem): update core plugin names * docs: update plugin names * docs: update aws and warning refs
1 parent fd2352d commit 268e0d7

File tree

7 files changed

+33
-33
lines changed

7 files changed

+33
-33
lines changed

docs/Guides/Ecosystem.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,18 @@ section.
1212
[accepts](https://www.npmjs.com/package/accepts) in your request object.
1313
- [`@fastify/accepts-serializer`](https://github.com/fastify/fastify-accepts-serializer)
1414
to serialize to output according to `Accept` header.
15+
- [`@fastify/any-schema`](https://github.com/fastify/any-schema-you-like) Save multiple
16+
schemas and decide which one to use to serialize the payload
1517
- [`@fastify/auth`](https://github.com/fastify/fastify-auth) Run multiple auth
1618
functions in Fastify.
1719
- [`@fastify/autoload`](https://github.com/fastify/fastify-autoload) Require all
1820
plugins in a directory.
21+
- [`@fastify/awilix`](https://github.com/fastify/fastify-awilix) Dependency
22+
injection support for Fastify, based on
23+
[awilix](https://github.com/jeffijoe/awilix).
24+
- [`@fastify/aws-lambda`](https://github.com/fastify/aws-lambda-fastify) allows you to
25+
easily build serverless web applications/services and RESTful APIs using Fastify
26+
on top of AWS Lambda and Amazon API Gateway.
1927
- [`@fastify/basic-auth`](https://github.com/fastify/fastify-basic-auth) Basic
2028
auth plugin for Fastify.
2129
- [`@fastify/bearer-auth`](https://github.com/fastify/fastify-bearer-auth) Bearer
@@ -58,6 +66,7 @@ section.
5866
internally uses [fast-jwt](https://github.com/nearform/fast-jwt).
5967
- [`@fastify/leveldb`](https://github.com/fastify/fastify-leveldb) Plugin to
6068
share a common LevelDB connection across Fastify.
69+
- [`@fastify/middie`](https://github.com/fastify/middie) Middleware engine for Fastify.
6170
- [`@fastify/mongodb`](https://github.com/fastify/fastify-mongodb) Fastify
6271
MongoDB connection plugin, with which you can share the same MongoDB
6372
connection pool across every part of your server.
@@ -87,6 +96,9 @@ section.
8796
to forward the current HTTP request to another server.
8897
- [`@fastify/routes`](https://github.com/fastify/fastify-routes) Plugin that
8998
provides a `Map` of routes.
99+
- [`@fastify/schedule`](https://github.com/fastify/fastify-schedule) Plugin for
100+
scheduling periodic jobs, based on
101+
[toad-scheduler](https://github.com/kibertoad/toad-scheduler).
90102
- [`@fastify/sensible`](https://github.com/fastify/fastify-sensible) Defaults for
91103
Fastify that everyone can agree on. It adds some useful decorators such as
92104
HTTP errors and assertions, but also more request and reply methods.
@@ -97,26 +109,14 @@ section.
97109
- [`@fastify/swagger`](https://github.com/fastify/fastify-swagger) Plugin for
98110
serving Swagger/OpenAPI documentation for Fastify, supporting dynamic
99111
generation.
100-
- [`@fastify/websocket`](https://github.com/fastify/fastify-websocket) WebSocket
101-
support for Fastify. Built upon [ws](https://github.com/websockets/ws).
112+
- [`@fastify/under-pressure`](https://github.com/fastify/under-pressure) Measure process
113+
load with automatic handling of _"Service Unavailable"_ plugin for Fastify.
102114
- [`@fastify/url-data`](https://github.com/fastify/fastify-url-data) Decorate the
103115
`Request` object with a method to access raw URL components.
104-
- [`any-schema-you-like`](https://github.com/fastify/any-schema-you-like) Save multiple
105-
schemas and decide which one to use to serialize the payload
106-
- [`aws-lambda-fastify`](https://github.com/fastify/aws-lambda-fastify) allows you to
107-
easily build serverless web applications/services and RESTful APIs using Fastify
108-
on top of AWS Lambda and Amazon API Gateway.
109-
- [`fastify-awilix`](https://github.com/fastify/fastify-awilix) Dependency
110-
injection support for Fastify, based on
111-
[awilix](https://github.com/jeffijoe/awilix).
112-
- [`fastify-schedule`](https://github.com/fastify/fastify-schedule) Plugin for
113-
scheduling periodic jobs, based on
114-
[toad-scheduler](https://github.com/kibertoad/toad-scheduler).
115-
- [`middie`](https://github.com/fastify/middie) Middleware engine for Fastify.
116-
- [`point-of-view`](https://github.com/fastify/point-of-view) Templates
116+
- [`@fastify/view`](https://github.com/fastify/point-of-view) Templates
117117
rendering (_ejs, pug, handlebars, marko_) plugin support for Fastify.
118-
- [`under-pressure`](https://github.com/fastify/under-pressure) Measure process
119-
load with automatic handling of _"Service Unavailable"_ plugin for Fastify.
118+
- [`@fastify/websocket`](https://github.com/fastify/fastify-websocket) WebSocket
119+
support for Fastify. Built upon [ws](https://github.com/websockets/ws).
120120

121121
#### [Community](#community)
122122

docs/Guides/Migration-Guide-V3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ framework itself.
1515

1616
If you use Express middleware in your application, please install and register
1717
the [`@fastify/express`](https://github.com/fastify/fastify-express) or
18-
[`middie`](https://github.com/fastify/middie) plugin before doing so.
18+
[`@fastify/middie`](https://github.com/fastify/middie) plugin before doing so.
1919

2020
**v2:**
2121

docs/Guides/Plugins-Guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -458,10 +458,10 @@ console.log(new CustomError())
458458

459459
If you want to deprecate an API, or you want to warn the user about a specific
460460
use case, you can use the
461-
[`fastify-warning`](https://github.com/fastify/fastify-warning) module.
461+
[`process-warning`](https://github.com/fastify/process-warning) module.
462462

463463
```js
464-
const warning = require('fastify-warning')()
464+
const warning = require('process-warning')()
465465
warning.create('FastifyDeprecation', 'FST_ERROR_CODE', 'message')
466466
warning.emit('FST_ERROR_CODE')
467467
```
@@ -475,7 +475,7 @@ will add it to the [*ecosystem*](https://github.com/fastify/fastify#ecosystem)
475475
section of our documentation!
476476

477477
If you want to see some real-world examples, check out:
478-
- [`point-of-view`](https://github.com/fastify/point-of-view) Templates
478+
- [`@fastify/view`](https://github.com/fastify/point-of-view) Templates
479479
rendering (*ejs, pug, handlebars, marko*) plugin support for Fastify.
480480
- [`@fastify/mongodb`](https://github.com/fastify/fastify-mongodb) Fastify
481481
MongoDB connection plugin, with this you can share the same MongoDB connection

docs/Guides/Serverless.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The sample provided allows you to easily build serverless web
3636
applications/services and RESTful APIs using Fastify on top of AWS Lambda and
3737
Amazon API Gateway.
3838

39-
*Note: Using [aws-lambda-fastify](https://github.com/fastify/aws-lambda-fastify)
39+
*Note: Using [@fastify/aws-lambda](https://github.com/fastify/aws-lambda-fastify)
4040
is just one possible way.*
4141

4242
### app.js
@@ -74,7 +74,7 @@ to your port, so you can still run your Fastify function locally.
7474
### lambda.js
7575

7676
```js
77-
const awsLambdaFastify = require('aws-lambda-fastify')
77+
const awsLambdaFastify = require('@fastify/aws-lambda')
7878
const init = require('./app');
7979

8080
const proxy = awsLambdaFastify(init())
@@ -91,14 +91,14 @@ exports.handler = proxy;
9191
```
9292

9393
We just require
94-
[aws-lambda-fastify](https://github.com/fastify/aws-lambda-fastify) (make sure
95-
you install the dependency `npm i aws-lambda-fastify`) and our
94+
[@fastify/aws-lambda](https://github.com/fastify/aws-lambda-fastify) (make sure
95+
you install the dependency `npm i @fastify/aws-lambda`) and our
9696
[`app.js`](#appjs) file and call
9797
the exported `awsLambdaFastify` function with the `app` as the only parameter.
9898
The resulting `proxy` function has the correct signature to be used as a lambda
9999
`handler` function. This way all the incoming events (API Gateway requests) are
100100
passed to the `proxy` function of
101-
[aws-lambda-fastify](https://github.com/fastify/aws-lambda-fastify).
101+
[@fastify/aws-lambda](https://github.com/fastify/aws-lambda-fastify).
102102

103103
### Example
104104

docs/Guides/Write-Plugin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ at:
3636
- [`@fastify/caching`](https://github.com/fastify/fastify-caching)
3737
- [`@fastify/compress`](https://github.com/fastify/fastify-compress)
3838
- [`@fastify/cookie`](https://github.com/fastify/fastify-cookie)
39-
- [`point-of-view`](https://github.com/fastify/point-of-view)
40-
- [`under-pressure`](https://github.com/fastify/under-pressure)
39+
- [`@fastify/under-pressure`](https://github.com/fastify/under-pressure)
40+
- [`@fastify/view`](https://github.com/fastify/point-of-view)
4141

4242
## License
4343
You can license your plugin as you prefer, we do not enforce any kind of
@@ -91,7 +91,7 @@ it to the [ecosystem](https://github.com/fastify/fastify#ecosystem) section of
9191
our documentation!
9292

9393
If you want to see some real world examples, check out:
94-
- [`point-of-view`](https://github.com/fastify/point-of-view) Templates
94+
- [`@fastify/view`](https://github.com/fastify/point-of-view) Templates
9595
rendering (*ejs, pug, handlebars, marko*) plugin support for Fastify.
9696
- [`@fastify/mongodb`](https://github.com/fastify/fastify-mongodb) Fastify
9797
MongoDB connection plugin, with this you can share the same MongoDB connection

docs/Migration-Guide-V4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ All v3 deprecations have been removed and they will no longer work after upgradi
99

1010
### Deprecation of `app.use()`
1111

12-
Starting this version of Fastify, we have deprecated the use of `app.use()`. We have decided not to support the use of middlewares. Both [`middie`](https://github.com/fastify/middie) and [`@fastify/express`](https://github.com/fastify/fastify-express) will still be there and maintained. Use Fastify's [hooks](./Reference/Hooks.md) instead.
12+
Starting this version of Fastify, we have deprecated the use of `app.use()`. We have decided not to support the use of middlewares. Both [`@fastify/middie`](https://github.com/fastify/middie) and [`@fastify/express`](https://github.com/fastify/fastify-express) will still be there and maintained. Use Fastify's [hooks](./Reference/Hooks.md) instead.

docs/Reference/Middleware.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Starting with Fastify v3.0.0, middleware is not supported out of the box and
66
requires an external plugin such as
77
[`@fastify/express`](https://github.com/fastify/fastify-express) or
8-
[`middie`](https://github.com/fastify/middie).
8+
[`@fastify/middie`](https://github.com/fastify/middie).
99

1010

1111
An example of registering the
@@ -22,11 +22,11 @@ fastify.use(require('ienoopen')())
2222
fastify.use(require('x-xss-protection')())
2323
```
2424

25-
You can also use [`middie`](https://github.com/fastify/middie), which provides
25+
You can also use [`@fastify/middie`](https://github.com/fastify/middie), which provides
2626
support for simple Express-style middleware but with improved performance:
2727

2828
```js
29-
await fastify.register(require('middie'))
29+
await fastify.register(require('@fastify/middie'))
3030
fastify.use(require('cors')())
3131
```
3232

0 commit comments

Comments
 (0)