Merge pull request #39 from AthennaIO/develop

fix(file): make getFilesByPattern recursive by default
AthennaIO · Mar 23, 2023 · 400fdb1 · 400fdb1
2 parents 79e215a + 8ce4299
commit 400fdb1
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 86 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@athenna/common",
-  "version": "3.4.4",
+  "version": "3.4.5",
   "description": "The Athenna common helpers to use in any Node.js ESM project.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",

diff --git a/src/Helpers/FakeApi.ts b/src/Helpers/FakeApi.ts
@@ -88,7 +88,7 @@ export class FakeApi {
    * Register all file routes found in folder path.
    */
   public static async registerFolder(path: string): Promise<void> {
-    const files = new Folder(path).getFilesByPattern('*/**/*.json', true)
+    const files = new Folder(path).getFilesByPattern('**/*.json')
 
     const promises = files.map(file =>
       file.load().then(fileLoaded => this.registerFile(fileLoaded)),

diff --git a/src/Helpers/Folder.ts b/src/Helpers/Folder.ts
@@ -659,7 +659,7 @@ export class Folder {
   /**
    * Get all the files of folder using glob pattern.
    */
-  public getFilesByPattern(pattern?: string, recursive = false): File[] {
+  public getFilesByPattern(pattern?: string): File[] {
     this.loadSync({ withSub: true, isInternalLoad: true })
 
     if (pattern) {
@@ -669,26 +669,22 @@ export class Folder {
     const files = []
 
     this.files.forEach(file => {
-      if (pattern && minimatch(file.path, pattern)) {
-        files.push(file)
-
+      if (pattern && !minimatch(file.path, pattern)) {
         return
       }
 
       files.push(file)
     })
 
-    if (recursive) {
-      files.push(...Folder.getSubFiles(this.folders, pattern))
-    }
+    files.push(...Folder.getSubFiles(this.folders, pattern))
 
     return files
   }
 
   /**
    * Get all the folders of folder using glob pattern.
    */
-  public getFoldersByPattern(pattern?: string, recursive = false): Folder[] {
+  public getFoldersByPattern(pattern?: string): Folder[] {
     this.loadSync({ withSub: true, isInternalLoad: true })
 
     if (pattern) {
@@ -698,8 +694,8 @@ export class Folder {
     const folders = []
 
     this.folders.forEach(folder => {
-      if (recursive && folder.folders.length) {
-        folders.push(...Folder.getSubFolders(folder, recursive, pattern))
+      if (folder.folders.length) {
+        folders.push(...Folder.getSubFolders(folder, true, pattern))
       }
 
       if (pattern && minimatch(folder.path, pattern)) {

diff --git a/src/Helpers/Module.ts b/src/Helpers/Module.ts
@@ -145,10 +145,7 @@ export class Module {
 
     const folder = await new Folder(path).load()
 
-    // FIXME Why glob pattern *.js is retrieving .d.ts and .js.map files?
-    return folder
-      .getFilesByPattern(`*/**/*.${Path.ext()}`, true)
-      .filter(file => file.extension.endsWith(`.${Path.ext()}`))
+    return folder.getFilesByPattern(`**/*.${Path.ext()}`)
   }
 
   /**

diff --git a/tests/Unit/FolderTest.ts b/tests/Unit/FolderTest.ts
@@ -232,90 +232,80 @@ test.group('FolderTest', group => {
   test('should get all files/folders that match the pattern', async ({ assert }) => {
     const path = bigFolderPath.concat(sep, 'folder')
 
-    await File.createFileOfSize(path.concat('/file.txt'), 1024 * 1024)
-
-    new Folder(path.concat('/A')).loadSync()
-    new Folder(path.concat('/A', '/B')).loadSync()
-
-    await File.createFileOfSize(path.concat('/A', '/B', '/file.txt'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileOne.ts'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileTwo.ts'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileOne.txt'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileTwo.txt'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileOne.json'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileTwo.json'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileOne.edge'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileTwo.edge'), 1024 * 1024)
+
+    await new Folder(path.concat('/A')).load()
+    await new Folder(path.concat('/A', '/B')).load()
+
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileOne.ts'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileTwo.ts'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileOne.txt'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileTwo.txt'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileOne.json'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileTwo.json'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileOne.edge'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileTwo.edge'), 1024 * 1024)
 
     const folder = new Folder(path)
 
-    const files = folder.getFilesByPattern('**/*.txt')
+    const ts = folder.getFilesByPattern('**/*.ts')
+    const txt = folder.getFilesByPattern('**/*.txt')
+    const json = folder.getFilesByPattern('**/*.json')
+    const edge = folder.getFilesByPattern('**/*.edge')
     const folders = folder.getFoldersByPattern('**/*')
 
-    assert.lengthOf(files, 1)
-    assert.lengthOf(folders, 1)
-  })
-
-  test('should be able to get all files/folders without any pattern', async ({ assert }) => {
-    const path = bigFolderPath.concat(sep, 'folder')
-
-    await File.createFileOfSize(path.concat('/file.txt'), 1024 * 1024)
-
-    new Folder(path.concat('/A')).loadSync()
-    new Folder(path.concat('/A', '/B')).loadSync()
-
-    await File.createFileOfSize(path.concat('/A', '/B', '/file.txt'), 1024 * 1024)
-
-    const folder = new Folder(path)
-
-    const files = folder.getFilesByPattern()
-    const folders = folder.getFoldersByPattern()
-
-    assert.lengthOf(files, 1)
-    assert.lengthOf(folders, 1)
-  })
+    assert.lengthOf(folders, 2)
 
-  test('should get all files/folders recursively that match the pattern', async ({ assert }) => {
-    const path = bigFolderPath.concat(sep, 'folder')
+    assert.lengthOf(ts, 4)
+    ts.forEach(file => assert.equal(file.extension, '.ts'))
 
-    await new Folder(path.concat('/A')).load({ withSub: false })
-    new Folder(path.concat('/B')).loadSync({ withSub: false })
-    new Folder(path.concat('/C')).loadSync()
-    new Folder(path.concat('/C', '/D')).loadSync()
-    new Folder(path.concat('/C', '/D', '/E')).loadSync()
+    assert.lengthOf(txt, 4)
+    txt.forEach(file => assert.equal(file.extension, '.txt'))
 
-    const size = 1024 * 1024
-
-    await File.createFileOfSize(path.concat('/A', '/file.txt'), size)
-    await File.createFileOfSize(path.concat('/B', '/file.txt'), size)
-    await File.createFileOfSize(path.concat('/C', '/file.txt'), size)
-    await File.createFileOfSize(path.concat('/C', '/D', '/file.txt'), size)
-    await File.createFileOfSize(path.concat('/C', '/D', '/E', '/file.txt'), size)
-
-    const folder = new Folder(path)
+    assert.lengthOf(json, 4)
+    json.forEach(file => assert.equal(file.extension, '.json'))
 
-    assert.lengthOf(folder.getFilesByPattern('**/*.txt', true), 5)
-    assert.lengthOf(folder.getFoldersByPattern('**/*', true), 5)
-
-    assert.lengthOf(folder.getFilesByPattern('*/*.txt', true), 3)
-    assert.lengthOf(folder.getFoldersByPattern('*', true), 3)
+    assert.lengthOf(edge, 4)
+    edge.forEach(file => assert.equal(file.extension, '.edge'))
   })
 
-  test('should be able to get all files/folders recursively without any pattern', async ({ assert }) => {
+  test('should be able to get all files/folders without any pattern', async ({ assert }) => {
     const path = bigFolderPath.concat(sep, 'folder')
 
-    await new Folder(path.concat('/A')).load({ withSub: false })
-    new Folder(path.concat('/B')).loadSync({ withSub: false })
-    new Folder(path.concat('/C')).loadSync()
-    new Folder(path.concat('/C', '/D')).loadSync()
-    new Folder(path.concat('/C', '/D', '/E')).loadSync()
-
-    const size = 1024 * 1024
-
-    await File.createFileOfSize(path.concat('/A', '/file.txt'), size)
-    await File.createFileOfSize(path.concat('/B', '/file.txt'), size)
-    await File.createFileOfSize(path.concat('/C', '/file.txt'), size)
-    await File.createFileOfSize(path.concat('/C', '/D', '/file.txt'), size)
-    await File.createFileOfSize(path.concat('/C', '/D', '/E', '/file.txt'), size)
+    await File.createFileOfSize(path.concat('/fileOne.ts'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileTwo.ts'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileOne.txt'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileTwo.txt'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileOne.json'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileTwo.json'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileOne.edge'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/fileTwo.edge'), 1024 * 1024)
+
+    await new Folder(path.concat('/A')).load()
+    await new Folder(path.concat('/A', '/B')).load()
+
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileOne.ts'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileTwo.ts'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileOne.txt'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileTwo.txt'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileOne.json'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileTwo.json'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileOne.edge'), 1024 * 1024)
+    await File.createFileOfSize(path.concat('/A', '/B', '/fileTwo.edge'), 1024 * 1024)
 
     const folder = new Folder(path)
 
-    const files = folder.getFilesByPattern(null, true)
-    const folders = folder.getFoldersByPattern(null, true)
+    const files = folder.getFilesByPattern()
+    const folders = folder.getFoldersByPattern()
 
-    assert.lengthOf(files, 5)
-    assert.lengthOf(folders, 5)
+    assert.lengthOf(files, 16)
+    assert.lengthOf(folders, 2)
   })
 })