Improve UX: Support glob patterns in triple-slash comment

__tests__/fixtures/directive/dep7.ts

@@ -0,0 +1 @@
+/// <dependency-tree depends-on="./*.sh" />

__tests__/fixtures/directive/util.ts

@@ -6,3 +6,4 @@
  */
 
 /// <dependency-tree depends-on="./dep4.ejs" />
+/// <dependency-tree depends-on="./dir1/**/*" />

__tests__/index.test.ts

@@ -460,6 +460,7 @@ describe('dependencyTree', () => {
         ]),
         resolved: new Map([
           [fixture(dir, 'dep1.ts'), new Set()],
+          [fixture(dir, 'dep7.ts'), new Set([fixture(dir, 'dep3.sh')])],
           [
             fixture(dir, 'index.ts'),
             new Set([
@@ -468,7 +469,14 @@ describe('dependencyTree', () => {
               fixture(dir, 'dep3.sh'),
             ]),
           ],
-          [fixture(dir, 'util.ts'), new Set([fixture(dir, 'dep4.ejs')])],
+          [
+            fixture(dir, 'util.ts'),
+            new Set([
+              fixture(dir, 'dep4.ejs'),
+              fixture(dir, 'dir1/dep5.py'),
+              fixture(dir, 'dir1/dir2/dep6.md'),
+            ]),
+          ],
         ]),
       });
     });

docs/directive.md

@@ -43,7 +43,9 @@ The element can be closed at a new line:
 
 Available attributes:
 
-- **`depends-on="..."`** - contains a relative path to a dependency file.
+- **`depends-on="..."`**
+    - contains a relative path to a dependency file.
+    - or a relative path with glob pattern.
 
 Note that unavailable attributes will cause a validation error.
 
@@ -59,6 +61,14 @@ resolve(__dirname, './dep1.sh');
 resolve(__dirname, './dep2.ts'); /// <dependency-tree depends-on="./dep2.js" />
 ```
 
+directive comment can detect glob patterns:
+
+```typescript
+///<dependency-tree depends-on="./dir1/**/*" />
+resolve(__dirname, './dir1/dep5.py');
+resolve(__dirname, './dir1/dir2/dep6.md');
+```
+
 Element's definition can be split into multiple lines:
 
 ```typescript
@@ -81,5 +91,39 @@ The line below will be treated as a comment and not being parsed because of the
 // <dependency-tree invalid directive declaration example />
 ```
 
+#### Example
+
+```bash
+root_dir/
+  |- index.js
+  |- dep1.sh
+  |- util.ts
+  |- dir1/
+      |- dep5.py
+      |- dir2/
+          |- dep6.md
+```
+
+```typescript
+// root_dir/util.ts
+
+/// <dependency-tree depends-on="./dep1.sh" />
+///<dependency-tree depends-on="./dir1/**/*" />
+```
+
+```typescript
+// index.js
+const dependencyTree = new DependencyTree(['root_dir']);
+const result = await dependencyTree.gather();
+const dependencies = result.resolved;
+//{
+//  "root_dir/util.ts" => Set {
+//    "root_dir/dep1.sh",
+//    "root_dir/dir1/dep5.py",
+//    "root_dir/dir1/dir2/dep6.md",
+// },
+//}
+```
+
 [xml]: https://www.w3schools.com/xml/
 [typescript]: https://www.typescriptlang.org/docs/home.html

src/processors/directive.ts

@@ -3,8 +3,10 @@
 import * as camelcase from 'camelcase';
 import escapeRegExp = require('lodash.escaperegexp');
 import { OptionsV2, parseStringPromise as xml2js } from 'xml2js';
-import { DependencyTree, FileToDeps, Path } from '../';
+import { DependencyTree, FileToDeps, Path, ReferenceTransformFn } from '../';
 import { FileProcessor } from '../file_processor';
+import * as path from 'path';
+import * as fg from 'fast-glob';
 
 type Directive = {
   dependsOn?: string;
@@ -19,6 +21,23 @@ type Options = {
   fileTypes: string[];
 };
 
+/**
+ * If reference is a glob pattern (for example `./foo/*.ts`), this function should transform to
+ * the list of files, such as `['./foo/bar.ts', './foo/baz.ts']`.
+ */
+export const transformReference: ReferenceTransformFn = (
+  ref: string,
+  source: string,
+) => {
+  if (fg.isDynamicPattern(ref)) {
+    // Glob pattern
+    return fg
+      .sync(ref, { cwd: path.dirname(source), absolute: true })
+      .map((r) => r);
+  }
+  return ref;
+};
+
 /**
  * An abstract DirectiveProcessor class that implements language-agnostic generic logic of
  * directives' parsing. For more info see: tools/dependency-tree/docs/directive.md.
@@ -160,12 +179,13 @@ abstract class DirectiveProcessor implements FileProcessor {
   ) {
     const importedFiles = new Set<Path>();
     const directives = await this.getDirectives(contents, file);
+
     // Handle directives with 'depends-on' attribute defined
     directives.forEach(({ dependsOn }) => {
       dependsOn &&
         dependencyTree.resolveAndCollect(
           file,
-          dependencyTree.transformReference(dependsOn, file),
+          transformReference(dependsOn, file),
           importedFiles,
           missing,
         );

src/processors/javascript.ts

@@ -56,6 +56,7 @@ export class JavascriptFileProcessor implements FileProcessor {
     files: ReadonlyArray<Path>,
     dependencyTree: DependencyTree,
   ): Promise<Set<Path>> {
+    // TODO: change
     const importedFiles = new Set<Path>();
     const referencedFiles = new Set<Path>(extractJsImports(contents));
     referencedFiles.forEach((referencedFile) => {