Skip to content

docs: additional notes on globs and exclude #773

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

Merged
antfu merged 2 commits into from
Jun 25, 2024
Merged

docs: additional notes on globs and exclude #773

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8864a3c
docs: additional notes on `globs` and `exclude`
Jun 21, 2024
82438e3
chore: update
antfu Jun 25, 2024
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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,7 @@ Components({

// Glob patterns to match file names to be detected as components.
// When specified, the `dirs` and `extensions` options will be ignored.
// If you want to exclude components being registered, use negative globs with leading `!`.
globs: ['src/components/*.{vue}'],

// search for subdirectories
Expand Down Expand Up @@ -396,7 +397,8 @@ Components({
// Allow for components to override other components with the same name
allowOverrides: false,

// filters for transforming targets
// Filters for transforming targets (components to insert the auto import)
// Note these are NOT about including/excluding components registered - use `globs` for that
include: [/\.vue$/, /\.vue\?vue/],
exclude: [/[\\/]node_modules[\\/]/, /[\\/]\.git[\\/]/, /[\\/]\.nuxt[\\/]/],

Expand Down