@shipstatic/ship 0.4.21 → 0.4.22

package/dist/browser.d.ts

@@ -422,12 +422,17 @@ declare const JUNK_DIRECTORIES: readonly ["__MACOSX", ".Trashes", ".fseventsd",
 /**
  * Filters an array of file paths, removing those considered junk
  *
- * A path is filtered out if either:
+ * A path is filtered out if any of these conditions are met:
  * 1. The basename is identified as junk by the 'junk' package (e.g., .DS_Store, Thumbs.db)
- * 2. Any directory segment in the path matches an entry in JUNK_DIRECTORIES (case-insensitive)
+ * 2. Any path segment (file or directory) starts with a dot (e.g., .env, .git, .gitattributes)
+ * 3. Any path segment exceeds 255 characters (filesystem limit)
+ * 4. Any directory segment in the path matches an entry in JUNK_DIRECTORIES (case-insensitive)
  *
  * All path separators are normalized to forward slashes for consistent cross-platform behavior.
  *
+ * Note: Dot files are filtered for security - they typically contain sensitive configuration
+ * (.env, .git) or are not meant to be served publicly. This matches server-side filtering.
+ *
  * @param filePaths - An array of file path strings to filter
  * @returns A new array containing only non-junk file paths
  *
@@ -436,7 +441,7 @@ declare const JUNK_DIRECTORIES: readonly ["__MACOSX", ".Trashes", ".fseventsd",
  * import { filterJunk } from '@shipstatic/ship';
  *
  * // Filter an array of file paths
- * const paths = ['index.html', '.DS_Store', '__MACOSX/file.txt', 'app.js'];
+ * const paths = ['index.html', '.DS_Store', '.gitattributes', '__MACOSX/file.txt', 'app.js'];
  * const clean = filterJunk(paths);
  * // Result: ['index.html', 'app.js']
  * ```