➕ | Add support for showing hidden files

Author: fuzionix

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="media/SocialPreview.png" alt="File Tree Extractor Logo" width="640" />
+  <img src="media/FileTreeLogo.png" alt="File Tree Extractor Logo" width="90" />
 </p>
 
 ---
@@ -271,7 +271,7 @@ The format of the output tree structure.
 
 </br>
 
-### `fileTreeExtractor.directoryOnly`
+### `fileTreeExtractor.directoryOnly` 🆕
 
 **Description:**
 Show only directories in the tree structure, excluding all files from the output.
@@ -294,6 +294,18 @@ menuy/
 
 </br>
 
+### `fileTreeExtractor.showHiddenFiles` 🆕
+
+**Description:**
+Show hidden files in the tree output.
+
+**Default Value:**
+`true`
+
+> Notice: The option only works for Linux and Mac OS. 
+
+</br>
+
 ## Commands
 
 - `File Tree Extractor: Copy File Tree`

media/FileTreeLogo.svg

@@ -93,6 +93,11 @@
           "default": false,
           "description": "Include file sizes in the generated tree."
         },
+        "fileTreeExtractor.showHiddenFiles": {
+          "type": "boolean",
+          "default": true,
+          "description": "Show hidden files (files starting with a dot) in the tree output."
+        },
         "fileTreeExtractor.maxDepth": {
           "type": "number",
           "default": -1,

media/SocialPreview.png

@@ -15,6 +15,7 @@ class ConfigurationManager {
             ignoredBy: 'ignoredItems',
             indent: 1,
             showFileSize: false,
+            showHiddenFiles: true,
             maxDepth: -1,
             outputFormat: 'ascii',
             directoryOnly: false
@@ -40,6 +41,10 @@ class ConfigurationManager {
             errors.push('"showFileSize" must be a boolean')
         }
 
+        if (typeof config.showHiddenFiles !== 'boolean') {
+            errors.push('"showHiddenFiles" must be a boolean value')
+        }
+
         if (typeof config.maxDepth !== 'number' || config.maxDepth < -1) {
             errors.push('"maxDepth" must be -1 or a positive number')
         }

package.json

@@ -24,7 +24,7 @@ async function generateFileTree(startPath) {
     if (configErrors.length > 0) {
       throw new ConfigurationError(configErrors)
     }
-    
+
     // Validate start path
     try {
       await fs.access(startPath, fs.constants.R_OK)
@@ -36,15 +36,15 @@ async function generateFileTree(startPath) {
       }
       throw error
     }
-    
+
     const depth = 0
     const tree = await buildTree(startPath, startPath, buildConfig, depth)
     return formatOutput(tree, buildConfig, depth)
   } catch (error) {
     if (error instanceof TreeExtractorError) {
       throw error
     }
-    
+
     throw new TreeExtractorError(
       'An unexpected error occurred while generating the file tree',
       'UNKNOWN_ERROR',
@@ -64,6 +64,10 @@ async function buildTree(itemPath, startPath, buildConfig, depth) {
     return null
   }
 
+  if (!buildConfig.showHiddenFiles && isHiddenFile(itemPath)) {
+    return null
+  }
+
   if (shouldIgnore(itemPath, startPath, buildConfig.ignoredBy, buildConfig.ignoredItems)) {
     return null
   }
@@ -196,6 +200,11 @@ function transformTreeForXml(node) {
   return transformed
 }
 
+function isHiddenFile(filePath) {
+  const basename = path.basename(filePath)
+  return basename.startsWith('.')
+}
+
 module.exports = {
   generateFileTree
 }