Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(nuxt): deprecate scanning directory index plugins #18418

Merged
merged 8 commits into from
Mar 1, 2023
Merged

fix(nuxt): deprecate scanning directory index plugins #18418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fa7a2e0
fix: removing index files from imports
ineshbose Jan 21, 2023
d329e1b
Merge branch 'main' of https://github.com/inesh-forks/nuxt into fix/p…
ineshbose Feb 17, 2023
832bc89
chore: adding deprecation warning
ineshbose Feb 17, 2023
c9f2688
chore: more reliable condition
ineshbose Feb 17, 2023
e5ab781
Update docs/2.guide/2.directory-structure/1.plugins.md
ineshbose Feb 17, 2023
5a3d1a4
Update packages/kit/src/plugin.ts
ineshbose Feb 17, 2023
f3defc0
Update docs/2.guide/2.directory-structure/1.plugins.md
ineshbose Feb 17, 2023
450a858
Update docs/2.guide/2.directory-structure/1.plugins.md
ineshbose Feb 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/2.guide/2.directory-structure/1.plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ For example:

```bash
plugins
| - myPlugin.ts
| - myPlugin.ts // scanned
| - myOtherPlugin
| --- supportingFile.ts
| --- componentToRegister.vue
| --- index.ts
| --- supportingFile.ts // not scanned
| --- componentToRegister.vue // not scanned
| --- index.ts // currently scanned but deprecated
```

Only `myPlugin.ts` and `myOtherPlugin/index.ts` would be registered.
Only `myPlugin.ts` and `myOtherPlugin/index.ts` would be registered. You can configure [`plugins`](/docs/api/configuration/nuxt-config#plugins-1) to include unscanned files.

## Creating Plugins

Expand Down
6 changes: 6 additions & 0 deletions packages/kit/src/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ export function normalizePlugin (plugin: NuxtPlugin | string): NuxtPlugin {
throw new Error('Invalid plugin. src option is required: ' + JSON.stringify(plugin))
}

// TODO: only scan top-level files #18418
const nonTopLevelPlugin = plugin.src.match(/\/plugins\/[^/]+\/index\.[^/]+$/i)
if (nonTopLevelPlugin && nonTopLevelPlugin.length > 0 && !useNuxt().options.plugins.find(i => (typeof i === 'string' ? i : i.src).endsWith(nonTopLevelPlugin[0]))) {
console.warn(`[warn] [nuxt] [deprecation] You are using a plugin that is within a subfolder of your plugins directory without adding it to your config explicitly. You can move it to the top-level plugins directory, or include the file '~${nonTopLevelPlugin[0]}' in your plugins config (https://nuxt.com/docs/api/configuration/nuxt-config#plugins-1) to remove this warning.`)
}

// Normalize full path to plugin
plugin.src = normalize(resolveAlias(plugin.src))

Expand Down
2 changes: 1 addition & 1 deletion packages/nuxt/src/core/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ export async function resolveApp (nuxt: Nuxt, app: NuxtApp) {
...config.srcDir
? await resolveFiles(config.srcDir, [
`${config.dir?.plugins || 'plugins'}/*.{ts,js,mjs,cjs,mts,cts}`,
`${config.dir?.plugins || 'plugins'}/*/index.*{ts,js,mjs,cjs,mts,cts}`
`${config.dir?.plugins || 'plugins'}/*/index.*{ts,js,mjs,cjs,mts,cts}` // TODO: remove, only scan top-level plugins #18418
])
: []
].map(plugin => normalizePlugin(plugin as NuxtPlugin)))
Expand Down