clarify excluding folders

BrettMayson · Oct 30, 2023 · 8d8fb22 · 8d8fb22
1 parent 0e0f527
commit 8d8fb22
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/bin/tests/alpha/addons/main/.vscode/setting.json b/bin/tests/alpha/addons/main/.vscode/setting.json
diff --git a/bin/tests/alpha/addons/main/addon.toml b/bin/tests/alpha/addons/main/addon.toml
@@ -0,0 +1,4 @@
+[files]
+exclude = [
+    ".vscode/*"
+]
diff --git a/book/configuration/addon.md b/book/configuration/addon.md
@@ -20,6 +20,7 @@ exclude = [
 
 [files]
 exclude = [
+    ".vscode/**/*", # Exclude all files in the .vscode folder
     "data/*.psd",
 ]
 
@@ -61,12 +62,14 @@ exclude = [
 ## files
 
 `files.exclude` is an array of glob patterns that will be excluded and not packed into the PBO.
+It is important to note that this matches against files, not folders. To exclude a folder, you must use a glob pattern that matches all files in that folder.
 
 **_/addons/banana/addon.toml_**
 
 ```toml
 [files]
 exclude = [
+    ".vscode/**/*", # Exclude all files in the .vscode folder
     "data/*.psd",
 ]
 ```