feat(cli): ignore all hidden files

kuroidoruido · kuroidoruido · commit 8b1c7637764a · 2025-09-19T15:18:51.000+02:00
diff --git a/cli/command-check.spec.ts b/cli/command-check.spec.ts
@@ -53,29 +53,14 @@ describe("check command", () => {
                 docs: {
                     assets: {
                         images: {
-                            "bg.png": imageFile(),
                             "foo.png": imageFile(),
-                            "foo2.png": imageFile(),
-                            "foo3.png": imageFile(),
-                            "foo4.png": imageFile(),
-                            "foo5.png": imageFile(),
-                            "foo6.png": imageFile(),
                         },
                     },
                     css: {
                         "slides.css": slideCssFile(),
                     },
                     markdown: {
                         "01-getting-started.md": "![](./assets/images/foo.png)",
-                        "02-html-images.md":
-                            '<!-- .slide: data-background="./assets/images/bg.png"  -->\n' +
-                            '<img src="./assets/images/foo2.png"/>\n' +
-                            '<img class="tc-bg" src="./assets/images/foo3.png"/>\n' +
-                            '<div>\n' +
-                            '    <img src="./assets/images/foo4.png" />\n' +
-                            '</div>\n' +
-                            '<img src="./assets/images/foo5.png"/><img src="./assets/images/foo6.png"/>\n'
-                        ,
                         "99-lab-getting-started.md": labSlideFile({
                             title: "Getting started",
                             cmd: "Go to 01-getting-started",
@@ -84,7 +69,6 @@ describe("check command", () => {
                     scripts: {
                         "slides.js": slideJsFile([
                             "01-getting-started.md",
-                            "02-html-images.md",
                             "99-lab-getting-started.md",
                         ]),
                     },
@@ -226,8 +210,14 @@ describe("check command", () => {
                 docs: {
                     assets: {
                         images: {
+                            "bg.png": imageFile(),
                             "intro.png": imageFile(),
                             "logo-sfeir-blanc.png": imageFile(),
+                            "foo2.png": imageFile(),
+                            "foo3.png": imageFile(),
+                            "foo4.png": imageFile(),
+                            "foo5.png": imageFile(),
+                            "foo6.png": imageFile(),
                             speakers: {
                                 "CMA.jpg": imageFile(),
                                 "the-conf.svg": imageFile(),
@@ -265,11 +255,21 @@ describe("check command", () => {
 
 ![](./assets/images/intro.png)
                         `,
+                        "02-html-images.md":
+                            '<!-- .slide: data-background="./assets/images/bg.png"  -->\n' +
+                            '<img src="./assets/images/foo2.png"/>\n' +
+                            '<img class="tc-bg" src="./assets/images/foo3.png"/>\n' +
+                            '<div>\n' +
+                            '    <img src="./assets/images/foo4.png" />\n' +
+                            '</div>\n' +
+                            '<img src="./assets/images/foo5.png"/><img src="./assets/images/foo6.png"/>\n'
+                        ,
                     },
                     scripts: {
                         "slides.js": slideJsFile([
                             "00-speaker-cma.md",
                             "01-getting-started.md",
+                            "02-html-images.md"
                         ]),
                     },
                     ...web_modules(),
@@ -283,6 +283,50 @@ describe("check command", () => {
             console.error(getErrors());
             expect(getErrors()).toHaveLength(0);
         });
+
+
+        it("should ignore hidden files", async () => {
+            const rootDir = buildProject({
+                ...configFile({ stepCommandPrefix: "npm run " }),
+                '.DS_Store': '',
+                'Thumbs.db': '',
+                docs: {
+                    '.DS_Store': '',
+                    'Thumbs.db': '',
+                    assets: {
+                        '.DS_Store': '',
+                        'Thumbs.db': '',
+                        images: {
+                            '.hidden-image.png': imageFile(),
+                            '.DS_Store': '',
+                            'Thumbs.db': '',
+                        }
+                    },
+                    css: {
+                        "slides.css": slideCssFile(),
+                    },
+                    markdown: {
+                        '.hidden-slide.md': '',
+                        'Thumbs.db': '',
+                        '.DS_Store': '',
+                    },
+                    scripts: {
+                        "slides.js": slideJsFile(),
+                    },
+                    ...web_modules(),
+                },
+                steps: {
+                    '.DS_Store': '',
+                    'Thumbs.db': '',
+                    '.hidden-slide.md': '',
+                    "package.json": packageJsonFile(),
+                },
+            });
+
+            await checkCommandInternal({ type: "check", rootDir });
+            console.error(getErrors());
+            expect(getErrors()).toHaveLength(0);
+        });
     });
 
     describe("invalid projects", () => {
diff --git a/cli/command/check/check-root-dir.ts b/cli/command/check/check-root-dir.ts
@@ -1,7 +1,6 @@
+import { isDirectory, readdirSync } from "../../utils/fs.utils";
 import { CheckCommand } from "../../cli";
 import { check } from "../../utils/assert.utils";
-import fs from "node:fs";
-import { isDirectory } from "../../utils/fs.utils";
 
 export function checkRootDir(command: CheckCommand) {
     check(
@@ -35,5 +34,5 @@ export function checkRootDir(command: CheckCommand) {
 }
 
 function readRootDir(command: CheckCommand) {
-    return fs.readdirSync(command.rootDir);
+    return readdirSync(command.rootDir);
 }
diff --git a/cli/utils/fs.utils.ts b/cli/utils/fs.utils.ts
@@ -1,4 +1,4 @@
-import fs from "node:fs";
+import fs, { PathLike } from "node:fs";
 import path from "node:path";
 
 export function isDirectory(dir: string, file?: string): boolean {
@@ -12,3 +12,16 @@ export function isDirectory(dir: string, file?: string): boolean {
         return false;
     }
 }
+
+export function readdirSync(pathLike: PathLike,
+    options?:
+        | {
+            encoding: BufferEncoding | null;
+            withFileTypes?: false | undefined;
+            recursive?: boolean | undefined;
+        }
+        | BufferEncoding
+        | null,
+): string[] {
+    return fs.readdirSync(pathLike, options).filter(file => !file.startsWith('.') && file !== 'Thumbs.db')
+}
diff --git a/cli/utils/labs.utils.ts b/cli/utils/labs.utils.ts
@@ -1,3 +1,4 @@
+import { isDirectory, readdirSync } from "./fs.utils";
 import {
     labPackageJsonPath,
     labReadmePath,
@@ -7,7 +8,6 @@ import {
 } from "./path.utils";
 import { ConfigJson } from "./config.utils";
 import fs from "node:fs";
-import { isDirectory } from "./fs.utils";
 import { isNotDefined } from "./fp.utils";
 
 export function isStepDirectoryExists(stepDirPath: string) {
@@ -88,7 +88,7 @@ export function getLabCommandTarget(labCommandRow: string, config: ConfigJson) {
 }
 
 export function getAllLabsFromFs(rootDir: string, config: ConfigJson) {
-    return fs.readdirSync(labsPath(rootDir), { encoding: "utf-8" })
+    return readdirSync(labsPath(rootDir), { encoding: "utf-8" })
         .filter((filePath) => !config.ignoreStepsDirectories.includes(filePath))
         .filter(
             (filePath) => isDirectory(labsPath(rootDir), filePath),
diff --git a/cli/utils/slide.utils.ts b/cli/utils/slide.utils.ts
@@ -6,10 +6,10 @@ import {
     docsPath,
     slidePath,
 } from "./path.utils";
+import { isDirectory, readdirSync } from "./fs.utils";
 import { ConfigJson } from "./config.utils";
 import fs from "node:fs";
 import { isDefinedAndNotEmpty } from "./fp.utils";
-import { isDirectory } from "./fs.utils";
 import path from "node:path";
 
 export interface SlideEntry {
@@ -33,11 +33,10 @@ export async function getSlideFilesFromSlidesJs(
 export function getSlideFilesFromFs(
     rootDir: string,
 ): FilePath[] {
-    return fs
-        .readdirSync(path.resolve(docsMarkdownPath(rootDir)), {
-            encoding: "utf-8",
-            recursive: true,
-        })
+    return readdirSync(path.resolve(docsMarkdownPath(rootDir)), {
+        encoding: "utf-8",
+        recursive: true,
+    })
         .filter((path) => path.endsWith(".md"));
 }
 
@@ -134,7 +133,7 @@ export function getImagesPathFromSlides(
 export function getImagesPathFromFs(
     rootDir: string,
 ): string[] {
-    return fs.readdirSync(docsImagesPath(rootDir), {
+    return readdirSync(docsImagesPath(rootDir), {
         encoding: "utf-8",
         recursive: true,
     }).filter((imagePath) => !isDirectory(docsImagesPath(rootDir), imagePath))

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
	`1`	`+import { isDirectory, readdirSync } from "../../utils/fs.utils";`
`1`	`2`	`import { CheckCommand } from "../../cli";`
`2`	`3`	`import { check } from "../../utils/assert.utils";`
`3`		`-import fs from "node:fs";`
`4`		`-import { isDirectory } from "../../utils/fs.utils";`
`5`	`4`
`6`	`5`	`export function checkRootDir(command: CheckCommand) {`
`7`	`6`	`check(`
`@@ -35,5 +34,5 @@ export function checkRootDir(command: CheckCommand) {`
`35`	`34`	`}`
`36`	`35`
`37`	`36`	`function readRootDir(command: CheckCommand) {`
`38`		`- return fs.readdirSync(command.rootDir);`
	`37`	`+ return readdirSync(command.rootDir);`
`39`	`38`	`}`