From acd22db576fb8f73a6c4c4dfa43d6690931ff4c2 Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Tue, 22 Mar 2022 11:33:30 +0000 Subject: [PATCH] docs: deprecate `buildModules` in schema (#3830) --- docs/content/3.docs/2.directory-structure/4.components.md | 2 +- packages/schema/src/config/_common.ts | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/3.docs/2.directory-structure/4.components.md b/docs/content/3.docs/2.directory-structure/4.components.md index 41d148943..075ed9ba1 100644 --- a/docs/content/3.docs/2.directory-structure/4.components.md +++ b/docs/content/3.docs/2.directory-structure/4.components.md @@ -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'] } ``` diff --git a/packages/schema/src/config/_common.ts b/packages/schema/src/config/_common.ts index 0ab58c95c..57e314247 100644 --- a/packages/schema/src/config/_common.ts +++ b/packages/schema/src/config/_common.ts @@ -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])[]} * @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: [],