Feat(sidebar_enhance): Add setting HIDDEN_FOLDER_PATTERNS to allow customization of hiding folders (#1121)

Author: obgnail

plugin/global/locales/en.json

@@ -1073,6 +1073,7 @@
     "$label.CTRL_WHEEL_TO_SCROLL_SIDEBAR": "Ctrl+Wheel: Scroll Sidebar Horizontally",
     "$label.KEEP_OUTLINE_FOLD_STATE": "Keep Outline Fold State",
     "$label.SORTABLE_OUTLINE": "Sortable Outline",
+    "$label.HIDDEN_FOLDER_PATTERNS": "Hide Specific Folders (Regex)",
     "$label.CUSTOMIZE_SIDEBAR_ICONS": "Customize Sidebar File Icons",
     "$label.SIDEBAR_ICONS.enable": "Enable",
     "$label.SIDEBAR_ICONS.extensions": "Extensions",

plugin/global/locales/zh-CN.json

@@ -1073,6 +1073,7 @@
     "$label.CTRL_WHEEL_TO_SCROLL_SIDEBAR": "Ctrl+Wheel：横向滚动侧边栏",
     "$label.KEEP_OUTLINE_FOLD_STATE": "记忆大纲折叠状态",
     "$label.SORTABLE_OUTLINE": "大纲拖拽排序",
+    "$label.HIDDEN_FOLDER_PATTERNS": "文件树隐藏指定文件夹（正则）",
     "$label.CUSTOMIZE_SIDEBAR_ICONS": "定制侧边栏文件图标",
     "$label.SIDEBAR_ICONS.enable": "启用",
     "$label.SIDEBAR_ICONS.extensions": "扩展名",

plugin/global/locales/zh-TW.json

@@ -1073,6 +1073,7 @@
     "$label.CTRL_WHEEL_TO_SCROLL_SIDEBAR": "Ctrl+Wheel：橫向滾動側邊欄",
     "$label.KEEP_OUTLINE_FOLD_STATE": "记忆大綱折疊狀態",
     "$label.SORTABLE_OUTLINE": "大綱拖拽排序",
+    "$label.HIDDEN_FOLDER_PATTERNS": "檔案樹隱藏指定文件夾（正規）",
     "$label.CUSTOMIZE_SIDEBAR_ICONS": "定制側邊欄檔案圖示",
     "$label.SIDEBAR_ICONS.enable": "啟用",
     "$label.SIDEBAR_ICONS.extensions": "副檔名",

plugin/global/settings/settings.default.toml

@@ -1728,6 +1728,10 @@ KEEP_OUTLINE_FOLD_STATE = true
 #   false: 不保持
 SORTABLE_OUTLINE = true
 
+# ------------------- 隐藏指定文件夹 -------------------
+# 在侧边栏列表隐藏指定文件夹（正则）
+HIDDEN_FOLDER_PATTERNS = []
+
 # ------------------- 显示其他扩展名文件 -------------------
 # 支持在侧边栏显示侧边栏列表显示其他扩展名文件
 #   true:  支持

plugin/preferences/rules.js

@@ -69,6 +69,9 @@ module.exports = {
         HIGHLIGHT_PATTERN: [required, regex],
         HIGHLIGHT_LINE_COLOR: required,
     },
+    sidebar_enhance: {
+        HIDDEN_FOLDER_PATTERNS: [required, regex],
+    },
     text_stylize: {
         "DEFAULT_COLORS.FOREGROUND": [required, hexColor],
         "DEFAULT_COLORS.BACKGROUND": [required, hexColor],

plugin/preferences/schemas.js

@@ -1179,6 +1179,9 @@ const conf_sidebar_enhance = [
         Switch("KEEP_OUTLINE_FOLD_STATE", { tooltip: "canCollapseOutlinePanel" }),
         Switch("SORTABLE_OUTLINE"),
     ),
+    UntitledBox(
+        Array_Inline("HIDDEN_FOLDER_PATTERNS"),
+    ),
     UntitledBox(
         Switch("DISPLAY_NON_MARKDOWN_FILES"),
         Array_Inline("OPEN_BY_TYPORA_EXT", { dependencies: { DISPLAY_NON_MARKDOWN_FILES: true } }),

plugin/sidebar_enhance.js

@@ -1,10 +1,11 @@
 class SidebarEnhancePlugin extends BasePlugin {
     process = () => {
-        if (this.config.DISPLAY_NON_MARKDOWN_FILES && File.SupportedFiles) {
+        const displayNonMarkdownFiles = File.SupportedFiles && this.config.DISPLAY_NON_MARKDOWN_FILES
+        if (displayNonMarkdownFiles) {
             this._displayNonMarkdownFiles()
-            if (this.config.CUSTOMIZE_SIDEBAR_ICONS) {
-                this._customizeSidebarIcons()
-            }
+        }
+        if (this.config.HIDDEN_FOLDER_PATTERNS.length || (displayNonMarkdownFiles && this.config.CUSTOMIZE_SIDEBAR_ICONS)) {
+            this._rerenderOutlineNode()
         }
         if (this.config.KEEP_OUTLINE_FOLD_STATE && File.option.canCollapseOutlinePanel) {
             this._keepOutlineFoldState()
@@ -41,20 +42,45 @@ class SidebarEnhancePlugin extends BasePlugin {
         })
     }
 
-    _customizeSidebarIcons = () => {
-        const ICONS = new Map(
-            this.config.SIDEBAR_ICONS
-                .filter(item => item.enable && item.extensions.length && item.extensions.every(ext => !!ext))
-                .flatMap(item => item.extensions.map(ext => [`.${ext.trim()}`, item.icon.trim()]))
-        )
-        this.utils.decorate(() => File?.editor?.library?.fileTree, "renderNode", null, ($node, info) => {
-            if (!info.isFile) return
-            const ext = this.utils.Package.Path.extname(info.name)
-            const icon = ICONS.get(ext)
-            if (icon) {
-                $node.find(".file-node-icon").removeClass("fa fa-file-text-o").addClass(icon)
+    _rerenderOutlineNode = () => {
+        const getCustomFileIcons = () => {
+            const ICONS = new Map(
+                this.config.SIDEBAR_ICONS
+                    .filter(item => item.enable && item.extensions.length && item.extensions.every(ext => !!ext))
+                    .flatMap(item => item.extensions.map(ext => [`.${ext.trim()}`, item.icon.trim()]))
+            )
+            const fn = ($node, info) => {
+                if (!info.isFile) return
+                const ext = this.utils.Package.Path.extname(info.name)
+                const icon = ICONS.get(ext)
+                if (icon) $node.find(".file-node-icon").removeClass("fa fa-file-text-o").addClass(icon)
+            }
+            return this.config.CUSTOMIZE_SIDEBAR_ICONS && ICONS.size ? fn : this.utils.identity
+        }
+
+        const getHideFolders = () => {
+            const newRegexp = p => {
+                try {
+                    return new RegExp(p)
+                } catch (e) {
+                }
+            }
+            const REGEXPS = this.config.HIDDEN_FOLDER_PATTERNS.map(newRegexp).filter(Boolean)
+            const fn = ($node, info) => {
+                if (info.isDirectory && REGEXPS.some(reg => reg.test(info.name))) {
+                    $node.addClass("plugin-common-hidden")
+                }
             }
+            return REGEXPS.length ? fn : this.utils.identity
+        }
+
+        const customizeFileIcons = getCustomFileIcons()
+        const hideFolders = getHideFolders()
+        this.utils.decorate(() => File?.editor?.library?.fileTree, "renderNode", null, ($node, info) => {
+            customizeFileIcons($node, info)
+            hideFolders($node, info)
         })
+
         this.utils.eventHub.once(this.utils.eventHub.eventType.fileOpened, () => File.editor.library.refreshPanelCommand())
     }