Add CLI implementation

Author: yangshun

__tests__/fixtures/chain/alpha/alpha/alpha/alpha/alpha/alpha/alpha/alpha/alpha.txt renamed to __tests__/__fixtures__/chain/alpha/alpha/alpha/alpha/alpha/alpha/alpha/alpha/alpha.txt

@@ -3,7 +3,7 @@ const junk = require('junk');
 const path = require('path');
 const tree = require('../tree');
 
-const PATH_TO_TEST = '__tests__/fixtures';
+const PATH_TO_TEST = '__tests__/__fixtures__';
 const dirs = fs.readdirSync(PATH_TO_TEST).filter(junk.not);
 
 describe('tree', () => {
@@ -13,58 +13,74 @@ describe('tree', () => {
     });
   });
 
-  test('directoriesOnly', () => {
+  test('allFiles', () => {
     dirs.forEach(dir => {
-      expect(tree(path.join(PATH_TO_TEST, dir), {
-        directoriesOnly: true,
-      })).toMatchSnapshot();
+      expect(
+        tree(path.join(PATH_TO_TEST, dir), {
+          allFiles: true,
+        }),
+      ).toMatchSnapshot();
     });
   });
 
-  test('directoriesTrailingSlash', () => {
+  test('dirOnly', () => {
     dirs.forEach(dir => {
-      expect(tree(path.join(PATH_TO_TEST, dir), {
-        directoriesTrailingSlash: true,
-      })).toMatchSnapshot();
+      expect(
+        tree(path.join(PATH_TO_TEST, dir), {
+          dirOnly: true,
+        }),
+      ).toMatchSnapshot();
     });
   });
 
-  test('excludeDirs', () => {
+  test('exclude', () => {
     dirs.forEach(dir => {
-      expect(tree(path.join(PATH_TO_TEST, dir), {
-        excludeDirs: ['beta'],
-      })).toMatchSnapshot();
+      expect(
+        tree(path.join(PATH_TO_TEST, dir), {
+          exclude: ['beta'],
+        }),
+      ).toMatchSnapshot();
     });
     dirs.forEach(dir => {
-      expect(tree(path.join(PATH_TO_TEST, dir), {
-        excludeDirs: ['charlie'],
-      })).toMatchSnapshot();
+      expect(
+        tree(path.join(PATH_TO_TEST, dir), {
+          exclude: ['charlie'],
+        }),
+      ).toMatchSnapshot();
     });
     dirs.forEach(dir => {
-      expect(tree(path.join(PATH_TO_TEST, dir), {
-        excludeDirs: ['beta', 'charlie'],
-      })).toMatchSnapshot();
+      expect(
+        tree(path.join(PATH_TO_TEST, dir), {
+          exclude: ['beta', 'charlie'],
+        }),
+      ).toMatchSnapshot();
     });
   });
 
-  test('hideHiddenFiles', () => {
+  test('maxDepth', () => {
     dirs.forEach(dir => {
-      expect(tree(path.join(PATH_TO_TEST, dir), {
-        hideHiddenFiles: false,
-      })).toMatchSnapshot();
+      expect(
+        tree(path.join(PATH_TO_TEST, dir), {
+          maxDepth: 1,
+        }),
+      ).toMatchSnapshot();
     });
-  });
-
-  test('maxDepth', () => {
     dirs.forEach(dir => {
-      expect(tree(path.join(PATH_TO_TEST, dir), {
-        maxDepth: 1,
-      })).toMatchSnapshot();
+      expect(
+        tree(path.join(PATH_TO_TEST, dir), {
+          maxDepth: 2,
+        }),
+      ).toMatchSnapshot();
     });
+  });
+
+  test('trailingSlash', () => {
     dirs.forEach(dir => {
-      expect(tree(path.join(PATH_TO_TEST, dir), {
-        maxDepth: 2,
-      })).toMatchSnapshot();
+      expect(
+        tree(path.join(PATH_TO_TEST, dir), {
+          trailingSlash: true,
+        }),
+      ).toMatchSnapshot();
     });
   });
 });

__tests__/fixtures/double-level/alpha.txt renamed to __tests__/__fixtures__/double-level/alpha.txt

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+const program = require('commander');
+
+const package = require('../package.json');
+const tree = require('../tree');
+
+const PATTERN_SEPARATOR = '|';
+
+program
+  .version(package.version)
+  .option('-a, --all-files', 'All files, include hidden files, are printed.')
+  .option('-d, --dir-only', 'List directories only.')
+  .option(
+    '-I, --exclude [patterns]',
+    'Exclude files that match the pattern. | separates alternate patterns. ' +
+      'Wrap your pattern in double quotes.',
+  )
+  .option('-L, --max-depth', 'Max display depth of the directory tree.')
+  .option('--trailing-slash', 'Add a trailing slash behind directories.');
+
+program.parse(process.argv);
+const path = program.args[0];
+
+const options = {
+  allFiles: program.allFiles,
+  dirOnly: program.dirOnly,
+  exclude: program.exclude,
+  maxDepth: program.maxDepth,
+  trailingSlash: program.trailingSlash,
+};
+
+Object.keys(options).forEach(key => {
+  if (options[key] === undefined) {
+    delete options[key];
+  }
+});
+
+if (options.exclude) {
+  options.exclude = options.exclude.split(PATTERN_SEPARATOR);
+}
+
+console.log(tree(path, options));

__tests__/fixtures/double-level/beta/alpha.txt renamed to __tests__/__fixtures__/double-level/beta/alpha.txt

@@ -1,3 +1,3 @@
 module.exports = {
-  testPathIgnorePatterns: ['fixtures'],
+  testPathIgnorePatterns: ['__fixtures__'],
 };

__tests__/fixtures/empty-dir/.gitkeep renamed to __tests__/__fixtures__/empty-dir/.gitkeep

@@ -12,5 +12,8 @@
   "devDependencies": {
     "jest": "^22.4.3",
     "junk": "^2.1.0"
+  },
+  "dependencies": {
+    "commander": "^2.15.1"
   }
 }

__tests__/fixtures/multi-files/alpha.txt renamed to __tests__/__fixtures__/multi-files/alpha.txt

@@ -2,10 +2,10 @@ const fs = require('fs');
 const nodePath = require('path');
 
 const DEFAULT_OPTIONS = {
-  directoriesOnly: false,
-  directoriesTrailingSlash: false,
-  excludeDirs: [],
-  hideHiddenFiles: true,
+  allFiles: false,
+  dirOnly: false,
+  trailingSlash: false,
+  exclude: [],
   maxDepth: Number.POSITIVE_INFINITY,
 };
 
@@ -17,10 +17,7 @@ const SYMBOLS = {
   VERTICAL: '│   ',
 };
 
-// Files we want to exclude no matter what.
-const EXCLUSIONS = [
-  '.DS_Store',
-];
+const EXCLUDED_PATTERNS = [/\.DS_Store/];
 
 function isHiddenFile(filename) {
   return filename[0] === '.';
@@ -36,19 +33,29 @@ function print(
 ) {
   const isFile = fs.lstatSync(path).isFile();
   const isDir = !isFile;
+
   const lines = [];
+  // Do not show these regardless.
+  for (let i = 0; i < EXCLUDED_PATTERNS.length; i++) {
+    if (EXCLUDED_PATTERNS[i].test(path)) {
+      return lines;
+    }
+  }
+
   // Handle directories only.
-  if (isFile && options.directoriesOnly) {
+  if (isFile && options.dirOnly) {
     return lines;
   }
 
-  // Handle excluded dirs.
-  if (isDir && options.excludeDirs.includes(filename)) {
-    return lines;
+  // Handle excluded patterns.
+  for (let i = 0; i < options.exclude.length; i++) {
+    if (options.exclude[i].test(path)) {
+      return lines;
+    }
   }
 
-  // Handle hidden files.
-  if (options.hideHiddenFiles && isHiddenFile(filename)) {
+  // Handle showing of all files.
+  if (!options.allFiles && isHiddenFile(filename)) {
     return lines;
   }
 
@@ -63,7 +70,7 @@ function print(
     line.push(isLast ? SYMBOLS.LAST_BRANCH : SYMBOLS.BRANCH);
   }
   line.push(filename);
-  if (isDir && options.directoriesTrailingSlash) {
+  if (isDir && options.trailingSlash) {
     line.push('/');
   }
   lines.push(line.join(''));
@@ -73,18 +80,15 @@ function print(
   }
 
   // Handle directory files.
-  let files = fs.readdirSync(path)
-    .filter(
-      file => !EXCLUSIONS.includes(file)
-    );
-  if (options.directoriesOnly) {
+  let files = fs.readdirSync(path);
+  if (options.dirOnly) {
     // We have to filter here instead of at the start of the function
     // because we need to know how many non-directories there are before
     // we even start recursing.
     files = files.filter(file => {
       const filePath = nodePath.join(path, file);
       return !fs.lstatSync(filePath).isFile();
-    })
+    });
   }
 
   files.forEach((file, index) => {
@@ -107,9 +111,17 @@ function print(
 
 function tree(path, options) {
   const combinedOptions = { ...DEFAULT_OPTIONS, ...options };
-  return print(nodePath.basename(path), path, 0, '', combinedOptions).join(
-    '\n',
+  combinedOptions.exclude = combinedOptions.exclude.map(
+    pattern => new RegExp(pattern),
   );
+
+  return print(
+    nodePath.basename(nodePath.join(process.cwd(), path)),
+    path,
+    0,
+    '',
+    combinedOptions,
+  ).join('\n');
 }
 
 module.exports = tree;

__tests__/fixtures/multi-files/beta.txt renamed to __tests__/__fixtures__/multi-files/beta.txt

@@ -545,6 +545,10 @@ [email protected], combined-stream@~1.0.5:
   dependencies:
     delayed-stream "~1.0.0"
 
+commander@^2.15.1:
+  version "2.15.1"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-2.15.1.tgz#df46e867d0fc2aec66a34662b406a9ccafff5b0f"
+
 compare-versions@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/compare-versions/-/compare-versions-3.1.0.tgz#43310256a5c555aaed4193c04d8f154cf9c6efd5"