summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-07-21 13:51:11 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-07-21 13:51:11 -0400
commit4b07e1052027947186b6a7d4de489b5dc6a9d4f0 (patch)
tree3a43aaf6ba980224bd1ebe9b3833ff6ce9031b22
parent4590b75bc3d14465b32f2a8fcdb35da82f8c4e09 (diff)
downloadSMAPI-4b07e1052027947186b6a7d4de489b5dc6a9d4f0.tar.gz
SMAPI-4b07e1052027947186b6a7d4de489b5dc6a9d4f0.tar.bz2
SMAPI-4b07e1052027947186b6a7d4de489b5dc6a9d4f0.zip
ignore more content file types when detecting mods
-rw-r--r--docs/release-notes.md1
-rw-r--r--src/SMAPI.Toolkit/Framework/ModScanning/ModScanner.cs49
2 files changed, 41 insertions, 9 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 837f31db..07905180 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -9,6 +9,7 @@
## Upcoming release
* For players:
+ * SMAPI now ignores more content file types when detecting mods (`.doc`, `.docx`, `.rar`, and `.zip`).
* Fixed launcher's fallback logic on Linux when no compatible terminal was found (thanks to jlaw!).
* For the Console Commands mod:
diff --git a/src/SMAPI.Toolkit/Framework/ModScanning/ModScanner.cs b/src/SMAPI.Toolkit/Framework/ModScanning/ModScanner.cs
index f4857c7d..a7c87cbb 100644
--- a/src/SMAPI.Toolkit/Framework/ModScanning/ModScanner.cs
+++ b/src/SMAPI.Toolkit/Framework/ModScanning/ModScanner.cs
@@ -18,18 +18,44 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
private readonly JsonHelper JsonHelper;
/// <summary>A list of filesystem entry names to ignore when checking whether a folder should be treated as a mod.</summary>
- private readonly HashSet<Regex> IgnoreFilesystemEntries = new HashSet<Regex>
+ private readonly HashSet<Regex> IgnoreFilesystemNames = new HashSet<Regex>
{
- // OS metadata files
new Regex(@"^__folder_managed_by_vortex$", RegexOptions.Compiled | RegexOptions.IgnoreCase), // Vortex mod manager
new Regex(@"(?:^\._|^\.DS_Store$|^__MACOSX$|^mcs$)", RegexOptions.Compiled | RegexOptions.IgnoreCase), // MacOS
- new Regex(@"^(?:desktop\.ini|Thumbs\.db)$", RegexOptions.Compiled | RegexOptions.IgnoreCase), // Windows
- new Regex(@"\.(?:url|lnk)$", RegexOptions.Compiled | RegexOptions.IgnoreCase), // Windows shortcut files
+ new Regex(@"^(?:desktop\.ini|Thumbs\.db)$", RegexOptions.Compiled | RegexOptions.IgnoreCase) // Windows
+ };
- // other
- new Regex(@"\.(?:bmp|gif|jpeg|jpg|png|psd|tif)$", RegexOptions.Compiled | RegexOptions.IgnoreCase), // image files
- new Regex(@"\.(?:md|rtf|txt)$", RegexOptions.Compiled | RegexOptions.IgnoreCase), // text files
- new Regex(@"\.(?:backup|bak|old)$", RegexOptions.Compiled | RegexOptions.IgnoreCase) // backup file
+ /// <summary>A list of file extensions to ignore when searching for mod files.</summary>
+ private readonly HashSet<string> IgnoreFileExtensions = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
+ {
+ // text
+ ".doc",
+ ".docx",
+ ".md",
+ ".rtf",
+ ".txt",
+
+ // images
+ ".bmp",
+ ".gif",
+ ".jpeg",
+ ".jpg",
+ ".png",
+ ".psd",
+ ".tif",
+
+ // archives
+ ".rar",
+ ".zip",
+
+ // backup files
+ ".backup",
+ ".bak",
+ ".old",
+
+ // Windows shortcut files
+ ".url",
+ ".lnk"
};
/// <summary>The extensions for files which an XNB mod may contain. If a mod doesn't have a <c>manifest.json</c> and contains *only* these file extensions, it should be considered an XNB mod.</summary>
@@ -258,7 +284,12 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
/// <param name="entry">The file or folder.</param>
private bool IsRelevant(FileSystemInfo entry)
{
- return !this.IgnoreFilesystemEntries.Any(p => p.IsMatch(entry.Name));
+ // ignored file extension
+ if (entry is FileInfo file && this.IgnoreFileExtensions.Contains(file.Extension))
+ return false;
+
+ // ignored entry name
+ return !this.IgnoreFilesystemNames.Any(p => p.IsMatch(entry.Name));
}
/// <summary>Get whether a file is potentially part of an XNB mod.</summary>