You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(compiler): improve DirInsCommand class documentation
#257
Enhance the documentation for `DirInsCommand` to provide a detailed description of its purpose, functionality, and example output. The updated documentation clarifies the tree-like structure representation and the order of file and directory listing.
* Dir List files and directories in a tree-like structure
9
+
* The `DirInsCommand` class is responsible for listing files and directories in a tree-like structure for a given directory path within a project.
10
+
* It implements the `InsCommand` interface and provides an `execute` method to perform the directory listing operation asynchronously.
11
+
*
12
+
* The tree structure is visually represented using indentation and symbols (`βββ`, `βββ`) to denote files and subdirectories. Files are listed
13
+
* first, followed by subdirectories, which are recursively processed to display their contents.
14
+
*
15
+
* Example output:
16
+
* ```
17
+
* myDirectory/
18
+
* βββ file1.txt
19
+
* βββ file2.txt
20
+
* βββ subDirectory/
21
+
* βββ file3.txt
22
+
* βββ subSubDirectory/
23
+
* βββ file4.txt
24
+
* ```
25
+
*
26
+
* @param myProject The project instance in which the directory resides.
0 commit comments