fix: Add env to enable glob dot

Author: FoxxMD

docsite/docs/usage/overview.mdx

@@ -201,11 +201,12 @@ The configuration and behaviors below are applicable to all Stacks:
 | ENV                       | Required | Default                                | Description                                                                                                                                                  |
 | :------------------------ | :------- | -------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `SERVER_NAME`             | ☑️     |                                        | The name of the Komodo [Server](https://komo.do/docs/resources#server) where a Stack is located                                                              |
-| `STACKS_FROM`             | ☑️     | `dir`                                  | What [**Stack Sources**](#stack-sources) to generate Stacks from? `dir` or `compose`                                                                                                     |
+| `STACKS_FROM`             | ☑️     | `dir`                                  | What [**Stack Sources**](#stack-sources) to generate Stacks from? `dir` or `compose`                                                                         |
 | `HOST_DIR`                | ☑️     |                                        | The parent directory on the **host** that mounted into the Komodo Import container                                                                           |
 | `WRITE_ENV`               | -        | `true`                                 | Write the contents of found .env files to Komodo **Environment**. Likely want this as `true`.                                                                |
 | `COMPOSE_FILE_GLOB`       | -        | `**/{compose,docker-compose}*.y?(a)ml` | The [glob](https://github.com/isaacs/node-glob?tab=readme-ov-file#glob-primer) pattern to use for finding files for **Files Paths** in Stack config          |
 | `ENV_FILE_GLOB`           | -        | `**/.env`                              | The [glob](https://github.com/isaacs/node-glob?tab=readme-ov-file#glob-primer) pattern to use for finding files for **Additional Env Files** in Stack config |
+| `GLOB_DOT`                | -        | `false`                                | Allow glob patterns, outside of ENV pattern, to find files/folders that start with `.`                                                                       |
 | `KOMODO_ENV_NAME`         | -        | `.komodoenv`                           | If existing .env files are found, and `WRITE_ENV=false`, then this name will be used for the .env that Komodo writes using its own Environment section       |
 | `IMAGE_REGISTRY_PROVIDER` | -        |                                        | Name of Image Registry to use                                                                                                                                |
 | `IMAGE_REGISTRY_ACCOUNT`  | -        |                                        | Image Registry account to use                                                                                                                                |

docsite/src/components/QuickstartCompose.tsx

@@ -26,6 +26,8 @@ import ApiOutput from './QuickStartSnippets/apiOutput.mdx';
 const doc = parseDocument(ComposeExample);
 const proxyCollection = parseDocument(SocketProxyExample);
 
+const DOT_FOLDER_REGEX = new RegExp(/(?:^|[\/\\])\.\S/);
+
 interface ComposeStateData {
     autoUpdate?: boolean
     pollUpdate?: boolean
@@ -132,6 +134,12 @@ const QuickstartCompose = (props: AIOProps) => {
     hostS.commentBefore = `# Same as mounted directory above`
     seq.add(hostS);
 
+    if(DOT_FOLDER_REGEX.test(hostPath)) {
+        const dotS = new Scalar(`GLOB_DOT=true`);
+        dotS.commentBefore = `# Forces glob to not ignore dot folders`
+        seq.add(dotS);    
+    }
+
     const stacksFromS = new Scalar(`STACKS_FROM=${composeState.stacksFrom}`);
     stacksFromS.commentBefore = '# Determines what sources to generate Stacks from'
     stacksFromS.comment = `# ${composeState.stacksFrom === 'dir' ? 'Generate stacks from subfolders in directory' : 'Generate stacks from compose projects'}`

src/builders/stack/gitStack.ts

@@ -25,6 +25,7 @@ export const buildGitStack = async (path: string, options: BuildGitStackOptions)
         projectName,
         composeFiles = [],
         writeEnv = false,
+        allowGlobDot,
     } = options
 
     let gitStackConfig: _PartialStackConfig = {}
@@ -52,7 +53,7 @@ export const buildGitStack = async (path: string, options: BuildGitStackOptions)
     }
 
     if(gitData === undefined) {
-        const parentGitPath = await findPathRecuriveParently(path, '.git');
+        const parentGitPath = await findPathRecuriveParently(path, '.git', {dot: allowGlobDot});
         if (parentGitPath !== undefined) {
             const parentGitDir = dirname(parentGitPath)
             try {

src/builders/stack/stackBuilder.ts

@@ -48,7 +48,8 @@ export class StackBuilder {
             ignoreFolderGlob,
             envFileGlob = DEFAULT_ENV_GLOB,
             composeGlob = DEFAULT_GLOB_COMPOSE,
-            ignoreComposeGlob
+            ignoreComposeGlob,
+            allowGlobDot = false
         } = this.stackConfigOptions;
 
         let folderPaths: string[] = [];
@@ -66,9 +67,9 @@ export class StackBuilder {
 
             await this.parseComposeProjects();
 
-            const includeGlob = new Minimatch(composeGlob);
-            const excludeGlob = ignoreComposeGlob === undefined ? undefined : new Minimatch(ignoreComposeGlob);
-            const komodoGlob = new Minimatch(KOMODO_GLOB_IGNORE_COMPOSE);
+            const includeGlob = new Minimatch(composeGlob, {dot: allowGlobDot});
+            const excludeGlob = ignoreComposeGlob === undefined ? undefined : new Minimatch(ignoreComposeGlob, {dot: allowGlobDot});
+            const komodoGlob = new Minimatch(KOMODO_GLOB_IGNORE_COMPOSE, {dot: allowGlobDot});
 
             for (const c of this.composeCandidateStacks) {
                 if (!c.workingDir.includes(this.dirData.host)) {
@@ -100,7 +101,7 @@ export class StackBuilder {
             this.logger.info(`Folder Ignore Glob: ${ignoreFolderGlob ?? 'N/A'}`);
 
             await this.parseComposeProjects();
-            const dirs = await findFolders(this.dirData.scan, folderGlob, ignoreFolderGlob)
+            const dirs = await findFolders(this.dirData.scan, folderGlob, {ignore: ignoreFolderGlob, dot: allowGlobDot})
             folderPaths = dirs.map(x => joinPath(this.dirData.scan, x));
             this.logger.verbose(`Got ${folderPaths.length} folders in ${this.dirData.scan}:\n${formatIntoColumns(dirs, 3)}`);
         }

src/common/infrastructure/config/common.ts

@@ -11,4 +11,5 @@ export interface CommonImportOptions {
     ignoreFolderGlob?: string
     composeGlob?: string
     ignoreComposeGlob?: string
+    allowGlobDot?: boolean
 }

src/common/utils/io.ts

@@ -1,9 +1,10 @@
 import { accessSync, constants, promises } from "fs";
 import pathUtil, { join, dirname } from "path";
-import { glob, GlobOptionsWithFileTypesUnset } from 'glob';
+import { glob, GlobOptionsWithFileTypesUnset, GlobOptionsWithFileTypesTrue } from 'glob';
 import clone from 'clone';
 import { DEFAULT_GLOB_FOLDER, DirectoryConfig, DirectoryConfigValues } from "../infrastructure/atomic.js";
 import { parseBool } from "./utils.js";
+import { testMaybeRegex } from "@foxxmd/regex-buddy-core";
 
 export async function writeFile(path: any, text: any) {
     try {
@@ -80,7 +81,7 @@ export const findFilesRecurive = async (filePattern: string, fromDir: string, op
     }
 }
 
-export const findPathRecuriveParently = async (fromDir: string, path: string) => {
+export const findPathRecuriveParently = async (fromDir: string, path: string, options: GlobOptionsWithFileTypesUnset = {}) => {
 
     let currDirectory = fromDir;
     let parentDirectory = fromDir;
@@ -93,6 +94,7 @@ export const findPathRecuriveParently = async (fromDir: string, path: string) =>
 
         const files = await glob(path, {
             cwd: parentDirectory,
+            ...options
         });
 
         if(files.length > 0) {
@@ -157,13 +159,13 @@ export const readDirectories = async (path: string, options: ReadDirectoryOption
     }
 }
 
-export const findFolders = async (fromDir: string, filePattern: string = DEFAULT_GLOB_FOLDER, ignore?: string): Promise<string[]> => {
+export const findFolders = async (fromDir: string, filePattern: string = DEFAULT_GLOB_FOLDER, options: Partial<GlobOptionsWithFileTypesTrue> = {}): Promise<string[]> => {
     try {
         const res = await glob(filePattern, {
             cwd: fromDir,
             nodir: false,
             withFileTypes: true,
-            ignore
+            ...options,
         });
         return res.filter(x => x.isDirectory()).map(x => x.name);
     } catch (e) {
@@ -175,6 +177,9 @@ export const dirHasGitConfig = (paths: string[]): boolean => {
     return paths.some(x => x === '.git');
 }
 
+const DOT_FOLDER_REGEX = new RegExp(/(?:^|[\/\\])\.\S/);
+export const pathHasDotFolder = (pathVal: string): boolean => DOT_FOLDER_REGEX.test(pathVal)
+
 export const parseDirectoryConfig = async (dirConfig: DirectoryConfigValues = {}): Promise<[DirectoryConfigValues, DirectoryConfig]> => {
     const {
         mountVal = process.env.MOUNT_DIR,

src/index.ts

@@ -17,7 +17,7 @@ import { exportToFile } from './exporters/exportToFile.js';
 import { exportToSync } from './exporters/exportToApiSync.js';
 import { getDefaultKomodoApi } from './common/utils/komodo.js';
 import { StackBuilder } from './builders/stack/stackBuilder.js';
-import { parseDirectoryConfig } from './common/utils/io.js';
+import { parseDirectoryConfig, pathHasDotFolder } from './common/utils/io.js';
 import { DirectoryConfig, DirectoryConfigValues } from './common/infrastructure/atomic.js';
 
 dayjs.extend(utc)
@@ -56,16 +56,6 @@ try {
 
     getDefaultKomodoApi(logger);
 
-    let dirData: [DirectoryConfigValues, DirectoryConfig];
-    try {
-        dirData = await parseDirectoryConfig();
-        logger.info(`Mount Dir : ${dirData[0].mountVal} -> Resolved: ${dirData[1].mount}`);
-        logger.info(`Host Dir  : ${dirData[0].hostVal} -> Resolved: ${dirData[1].host}`);
-        logger.info(`Scan Dir  : ${dirData[0].scanVal} -> Resolved: ${dirData[1].scan}`);
-    } catch (e) {
-        throw new Error('Could not parse required directories', {cause: e});
-    }
-
     const importOptions: CommonImportOptions = {
         server: process.env.SERVER_NAME,
         imageRegistryProvider: process.env.IMAGE_REGISTRY_PROVIDER,
@@ -74,11 +64,30 @@ try {
         pollForUpdate: isUndefinedOrEmptyString(process.env.POLL_FOR_UPDATE) ? undefined : parseBool(process.env.POLL_FOR_UPDATE),
         komodoEnvName: process.env.KOMODO_ENV_NAME,
         composeFileGlob: process.env.COMPOSE_FILE_GLOB,
+        allowGlobDot: isUndefinedOrEmptyString(process.env.GLOB_DOT) ? undefined : parseBool(process.env.GLOB_DOT),
         envFileGlob: process.env.ENV_FILE_GLOB,
         folderGlob: isUndefinedOrEmptyString(process.env.FOLDER_GLOB) ? undefined : process.env.FOLDER_GLOB.trim(),
         ignoreFolderGlob: isUndefinedOrEmptyString(process.env.FOLDER_IGNORE_GLOB) ? undefined : process.env.FOLDER_IGNORE_GLOB.trim(),
     };
 
+    let dirData: [DirectoryConfigValues, DirectoryConfig];
+    try {
+        dirData = await parseDirectoryConfig(undefined);
+        logger.info(`Mount Dir : ${dirData[0].mountVal} -> Resolved: ${dirData[1].mount}`);
+        logger.info(`Host Dir  : ${dirData[0].hostVal} -> Resolved: ${dirData[1].host}`);
+        logger.info(`Scan Dir  : ${dirData[0].scanVal} -> Resolved: ${dirData[1].scan}`);
+    } catch (e) {
+        throw new Error('Could not parse required directories', {cause: e});
+    }
+
+    if(pathHasDotFolder(dirData[1].host) && importOptions.allowGlobDot !== true) {
+        logger.warn(`It looks like your Host Dir has a dot folder in its path and the env GLOB_DOT is not true/set. Komodo Import may not be able to match your paths because of this. If results are not as expected try setting GLOB_DOT=true`);
+    }
+    if(pathHasDotFolder(dirData[1].scan) && dirData[1].host !== dirData[1].scan && importOptions.allowGlobDot !== true) {
+        logger.warn(`It looks like your Scan Dir has a dot folder in its path and the env GLOB_DOT is not true/set. Komodo Import may not be able to match your paths because of this. If results are not as expected try setting GLOB_DOT=true`);
+    }
+
+
     if (importOptions.server === undefined || importOptions.server.trim() === '') {
         logger.error('ENV SERVER_NAME must be set');
         process.exit(1);

tests/util.test.ts

@@ -99,7 +99,7 @@ describe('#Utils', function () {
                 await mkdir(path.join(process.cwd(), 'test_1'));
                 await mkdir(path.join(process.cwd(), 'ignoreme', 'subfolder'), {recursive: true});
                 await writeFile(path.join(process.cwd(), 'ignoreme', 'subfolder', 'test.txt'), '');
-                const folders = await findFolders(process.cwd(), undefined, 'ignore*');
+                const folders = await findFolders(process.cwd(), undefined, {ignore: 'ignore*'});
                 expect(folders).to.deep.eq(['test_1']);
             }, { unsafeCleanup: true });
         });