feat: add configuration of ignored path while generating tree string for directory

Author: aprilandjan

.vscode/launch.json

@@ -25,7 +25,7 @@
       "args": [
         "--disable-extensions",
         "--extensionDevelopmentPath=${workspaceFolder}",
-        "--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+        "--extensionTestsPath=${workspaceFolder}/out/test/suite"
       ],
       "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
       "preLaunchTask": "npm: watch"

README.md

@@ -51,14 +51,16 @@ In all cases, you can revert formatting tree strings back to their preformatted
 
 ### Generate Tree String for Directory
 
-In addition to being able to format pre-formatted tree strings, you may also generate tree strings for directories inside your current workspace (directories appearing in `Explorer` tab). To do so, right-click on any directory within the `Explorer` tab and select the `Generate Tree String for Directory` menu option. An example is shown below.
+In addition to being able to format pre-formatted tree strings, you may also generate tree strings for directories inside your current workspace (directories appearing in `Explorer` tab). To do so, right-click on any directory, or empty space, within the `Explorer` tab and select the `Generate Tree String for Directory` menu option. An example is shown below.
 
 ![Generate Tree String for Directory](./images/directory.gif)
 
 #### Addendum
 
 The walking process through files is performed asynchronously. Therefore, selecting heavily-nested folders (e.g. `node_modules`) will directly affect performance speed.
 
+By default, `node_modules` and `.git` are ignored while generating tree string for directories. However, this can be customized by setting `asciiTreeGenerator.directoryIgnore` in configurations.
+
 ## Configuration
 
 Each tree string character can be defined by its ASCII code representation (UTF character code, more generally). As such, the theorectical range for character codes is `0` to `65535` (two bytes). However, and important to note, is that not every character code is printable and/or may cause formatting issues.

package.json

@@ -63,6 +63,14 @@
             "type": "integer",
             "default": 32,
             "description": "For blank / space elements (0-65535; Default: 32 ' ')"
+          },
+          "asciiTreeGenerator.directoryIgnore": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "default": ["node_modules", ".git"],
+            "description": "the glob patterns of ignored path while generate tree string for directory"
           }
         }
       }

src/config.ts

@@ -3,7 +3,7 @@ import { IVsCodeConfig } from './lib/interface';
 
 export function getConfig(): IVsCodeConfig {
   const config: IVsCodeConfig = {
-    ignore: ['node_modules'],
+    directoryIgnore: vscode.workspace.getConfiguration().get<string[]>('asciiTreeGenerator.directoryIgnore'),
     rootCharCode: vscode.workspace
       .getConfiguration()
       .get<number>('asciiTreeGenerator.rootElement'),

src/extension.ts

@@ -6,7 +6,7 @@ import * as path from 'path';
 
 import { formatFileTreeItemsFromDirectory } from './lib/directory';
 import { generate } from './lib/generator';
-import { getUserEOL, createWebview, revertTreeString } from './utils';
+import { getUserEOL, createWebview, revertTreeString, getCharCodesFromConfig, getDirectoryIgnoreFromConfig } from './utils';
 import { formatFileTreeItemsFromText } from './lib/text';
 
 export function activate(context: vscode.ExtensionContext) {
@@ -62,11 +62,10 @@ export function activate(context: vscode.ExtensionContext) {
       const root =
         path.relative(rootWorkspace.uri.fsPath, target.fsPath) || '.';
 
-      // Todo: read plugin configuration
       const items = await formatFileTreeItemsFromDirectory(target!.fsPath, {
         maxDepth: Number.MAX_VALUE,
         sort: true,
-        ignore: [],
+        ignore: getDirectoryIgnoreFromConfig(),
       });
       const text = generate(items, {
         eol: getUserEOL(),
@@ -102,7 +101,7 @@ export function activate(context: vscode.ExtensionContext) {
     const items = formatFileTreeItemsFromText(rawText);
     const text = generate(items, {
       eol: editor.document.eol === vscode.EndOfLine.CRLF ? '\r\n' : '\n',
-      // Todo: read plugin configurations
+      charset: getCharCodesFromConfig(),
     });
     editor.edit((edit) => {
       edit.replace(editor.selection, text);

src/lib/generator.ts

@@ -1,14 +1,6 @@
-import { IFileTreeItem, ICharset, IFormatOptions } from './interface';
-import { getUserEOL, getCharCodesFromConfig } from '../utils';
-
-export const defaultCharset: ICharset = {
-  root: String.fromCharCode(46), // '.',
-  child: String.fromCharCode(9500), // '├',
-  last: String.fromCharCode(9492), // '└',
-  parent: String.fromCharCode(9474), // '|',
-  dash: String.fromCharCode(9472), // '─',
-  blank: String.fromCharCode(32), // ' ',
-};
+import { EOL } from 'os';
+import { IFileTreeItem, IFormatOptions } from './interface';
+import { defaultCharset } from '../utils';
 
 function createTreeString(start: string, fill: string, size = 3) {
   let result = '';
@@ -25,8 +17,8 @@ function createTreeString(start: string, fill: string, size = 3) {
 /** generate tree string */
 export function generate(items: IFileTreeItem[], options: IFormatOptions = {}) {
   const {
-    eol = getUserEOL(),
-    charset = getCharCodesFromConfig(),
+    eol = EOL,
+    charset = defaultCharset,
     fillLeft = true,
   } = options;
   let leftSpace = '';

src/lib/interface.ts

@@ -36,7 +36,7 @@ export interface ICharset {
 
 //  the VS code config interface
 export interface IVsCodeConfig {
-  ignore: string[];
+  directoryIgnore: string[] | undefined;
   rootCharCode: number | undefined;
   childCharCode: number | undefined;
   lastCharCode: number | undefined;

src/test/suite/extension.test.ts src/test/extension.test.tssrc/test/suite/extension.test.ts renamed to src/test/extension.test.ts

@@ -1,7 +1,7 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import * as assert from 'assert';
-import { revertTreeString } from '../../utils';
+import { revertTreeString } from '../utils';
 
 // Defines a Mocha test suite to group tests of similar kind together
 suite('Extension Tests', function () {
@@ -14,11 +14,11 @@ suite('Extension Tests', function () {
   // });
   test('revert tree string to text', function () {
     const rootText = fs.readFileSync(
-      path.join(__dirname, '../../../fixtures/root.txt'),
+      path.join(__dirname, '../../fixtures/root.txt'),
       'utf8'
     );
     const rootReverted = fs.readFileSync(
-      path.join(__dirname, '../../../fixtures/root-reverted.txt'),
+      path.join(__dirname, '../../fixtures/root-reverted.txt'),
       'utf8'
     );
     const reverted = revertTreeString(rootText);
@@ -35,11 +35,11 @@ suite('Extension Tests', function () {
   // https://github.com/aprilandjan/ascii-tree-generator/pull/11
   test('revert more-depth tree string to text', function () {
     const origin = fs.readFileSync(
-      path.join(__dirname, '../../../fixtures/more-depth-reverted.txt'),
+      path.join(__dirname, '../../fixtures/more-depth-reverted.txt'),
       'utf8'
     );
     const treeString = fs.readFileSync(
-      path.join(__dirname, '../../../fixtures/more-depth.txt'),
+      path.join(__dirname, '../../fixtures/more-depth.txt'),
       'utf8'
     );
     const reverted = revertTreeString(treeString);

src/test/suite/lib/directory.test.ts src/test/lib/directory.test.tssrc/test/suite/lib/directory.test.ts renamed to src/test/lib/directory.test.ts

@@ -4,8 +4,8 @@ import * as path from 'path';
 import {
   listDirectory,
   formatFileTreeItemsFromDirectory,
-} from '../../../lib/directory';
-import { IFileStat } from '../../../lib/interface';
+} from '../../lib/directory';
+import { IFileStat } from '../../lib/interface';
 
 function findFileByName(files: IFileStat[] = [], name: string) {
   let result: IFileStat | undefined = undefined;
@@ -22,7 +22,7 @@ function findFileByName(files: IFileStat[] = [], name: string) {
 suite('lib/directory functions', function () {
   this.timeout(120000);
 
-  const rootDir: string = path.resolve(__dirname, '../../../../fixtures/root');
+  const rootDir: string = path.resolve(__dirname, '../../../fixtures/root');
 
   test('should correctly list directory', async () => {
     const files = await listDirectory(rootDir);

src/test/suite/lib/generator.test.ts src/test/lib/generator.test.tssrc/test/suite/lib/generator.test.ts renamed to src/test/lib/generator.test.ts

@@ -2,26 +2,26 @@ import * as assert from 'assert';
 import * as fs from 'fs';
 import * as path from 'path';
 
-import { formatFileTreeItemsFromDirectory } from '../../../lib/directory';
-import { formatFileTreeItemsFromText } from '../../../lib/text';
-import { generate } from '../../../lib/generator';
-import { setTestMode } from '../../../utils';
+import { formatFileTreeItemsFromDirectory } from '../../lib/directory';
+import { formatFileTreeItemsFromText } from '../../lib/text';
+import { generate } from '../../lib/generator';
+import { setTestMode } from '../../utils';
 
 suite('lib/generator functions', function () {
   this.timeout(120000);
   // Enable test mode to override user defined chars with defaults
   setTestMode();
-  const rootDir: string = path.resolve(__dirname, '../../../../fixtures/root');
+  const rootDir: string = path.resolve(__dirname, '../../../fixtures/root');
   const rootText = fs.readFileSync(
-    path.join(__dirname, '../../../../fixtures/root.txt'),
+    path.join(__dirname, '../../../fixtures/root.txt'),
     'utf8'
   );
   const rootSorted = fs.readFileSync(
-    path.join(__dirname, '../../../../fixtures/root-sorted.txt'),
+    path.join(__dirname, '../../../fixtures/root-sorted.txt'),
     'utf8'
   );
   const rootFillLeft = fs.readFileSync(
-    path.join(__dirname, '../../../../fixtures/root-fill-left.txt'),
+    path.join(__dirname, '../../../fixtures/root-fill-left.txt'),
     'utf8'
   );
 
@@ -36,7 +36,7 @@ suite('lib/generator functions', function () {
 
   test('should correctly generate tree from hash text', () => {
     const text = fs.readFileSync(
-      path.join(__dirname, '../../../../fixtures/hash.txt'),
+      path.join(__dirname, '../../../fixtures/hash.txt'),
       'utf8'
     );
     const items = formatFileTreeItemsFromText(text);
@@ -46,7 +46,7 @@ suite('lib/generator functions', function () {
 
   test('should correctly generate tree from indent text', () => {
     const text = fs.readFileSync(
-      path.join(__dirname, '../../../../fixtures/indent.txt'),
+      path.join(__dirname, '../../../fixtures/indent.txt'),
       'utf8'
     );
     const items = formatFileTreeItemsFromText(text);
@@ -56,7 +56,7 @@ suite('lib/generator functions', function () {
 
   test('should correctly generate tree from hash-indented text if fill-left', () => {
     const text = fs.readFileSync(
-      path.join(__dirname, '../../../../fixtures/hash-indented.txt'),
+      path.join(__dirname, '../../../fixtures/hash-indented.txt'),
       'utf8'
     );
     const items = formatFileTreeItemsFromText(text);
@@ -66,7 +66,7 @@ suite('lib/generator functions', function () {
 
   test('should correctly generate tree from hash-indented text if not fill-left', () => {
     const text = fs.readFileSync(
-      path.join(__dirname, '../../../../fixtures/hash-indented.txt'),
+      path.join(__dirname, '../../../fixtures/hash-indented.txt'),
       'utf8'
     );
     const items = formatFileTreeItemsFromText(text);