feat: ignore .DS_Store on Mac or Thumbs.db on Windows for deploy (#58)

Author: peterpeterparker

src/constants/constants.ts

@@ -14,3 +14,4 @@ export const CONSOLE_URL = 'https://console.juno.build';
 export const CONSOLE_SATELLITE_URL = `${CONSOLE_URL}/satellite/?s=`;
 export const JUNO_CDN_URL = 'https://fmkjf-bqaaa-aaaal-acpza-cai.raw.icp0.io';
 export const GITHUB_API_CLI_URL = 'https://api.github.com/repos/junobuild/cli';
+export const IGNORE_OS_FILES = ['.ds_store', 'thumbs.db'];

src/utils/deploy.utils.ts

@@ -1,6 +1,7 @@
 import {minimatch} from 'minimatch';
 import {lstatSync, readdirSync} from 'node:fs';
-import {join} from 'node:path';
+import {basename, join} from 'node:path';
+import {IGNORE_OS_FILES} from '../constants/constants';
 import type {SatelliteConfig} from '../types/satellite.config';
 
 export const listSourceFiles = ({
@@ -9,13 +10,24 @@ export const listSourceFiles = ({
 }: {sourceAbsolutePath: string} & Required<Pick<SatelliteConfig, 'ignore'>>): string[] => {
   const sourceFiles = files(sourceAbsolutePath);
 
-  const filteredEmptyFiles = sourceFiles.filter((file) => lstatSync(file).size > 0);
+  return sourceFiles.filter((file) => filterFile({file, ignore}));
+};
+
+const filterFile = ({
+  file,
+  ignore
+}: {file: string} & Required<Pick<SatelliteConfig, 'ignore'>>): boolean => {
+  // File must not be empty >= 0kb
+  if (lstatSync(file).size <= 0) {
+    return false;
+  }
 
-  const filteredSourceFiles = filteredEmptyFiles.filter(
-    (file) => ignore.find((pattern) => minimatch(file, pattern)) === undefined
-  );
+  // Ignore .DS_Store on Mac or Thumbs.db on Windows
+  if (IGNORE_OS_FILES.includes(basename(file).toLowerCase())) {
+    return false;
+  }
 
-  return filteredSourceFiles;
+  return ignore.find((pattern) => minimatch(file, pattern)) === undefined;
 };
 
 const files = (source: string): string[] =>