docs: deprecate buildModules in schema (#3830)

This commit is contained in:
Daniel Roe 2022-03-22 11:33:30 +00:00 committed by GitHub
parent 70f067a14b
commit acd22db576
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions

View File

@ -160,7 +160,7 @@ That's it! Now in your project, you can import your ui library as a Nuxt module
```js
export default {
buildModules: ['awesome-ui/nuxt']
modules: ['awesome-ui/nuxt']
}
```

View File

@ -271,13 +271,13 @@ export default {
* ]
* ```
*
* @note Using `buildModules` helps to make production startup faster and also significantly
* @note In Nuxt 2, using `buildModules` helps to make production startup faster and also significantly
* decreases the size of `node_modules` in production deployments. Please refer to each
* module's documentation to see if it is recommended to use `modules` or `buildModules`.
*
* @type {(typeof import('../src/types/module').NuxtModule | string | [typeof import('../src/types/module').NuxtModule | string, Record<string, any>])[]}
* @version 2
* @version 3
* @deprecated This is no longer needed in Nuxt 3 and Nuxt Bridge; all modules should be added to `modules` instead.
*/
buildModules: [],