mddir

#!/usr/bin/env node
// base https://github.com/JohnByrneRepo/mddir/blob/master/src/mddir.js

var fs = require('fs'),
    path = require('path');

var folders = {};
var outputText = '';
var markdownText = '';
var depth = 0;
var exported = false;
var outputFileName = 'directoryList.md';
var searchPath = path.resolve(process.argv[2] || '.');
var key = searchPath;//.replace(/\//g,'');
var startFolder = searchPath.split('/')[searchPath.split('/').length - 2];
var startDepth = searchPath.split('/').length - 1;
var currentWorkingDirectory = process.cwd();

var folderIgnoreList = [
    '.git',
    'node_modules',
    '_media'
];

// getFolders 获取文件 / 文件夹列表
var getFolders = function(path){
  fs.readdir(path, function(err, list){
    if (err) return done(err);
    list.forEach(function(item){
      if(fs.lstatSync(path + '/' + item).isDirectory() &&
        folderIgnoreList.indexOf(item) === -1){
        var folderDepth = path.split('/').length;
        if(folderDepth > depth){
          depth = folderDepth;
        }
        var uniqueKey = path + '/' + item.replace(/\//g,'');
        folders[uniqueKey] = {
          depth: folderDepth,
          parentFolder: path,
          path: path + '/' + item,
          name: item,
          folders: [],
          files: [],
          logged: false,
          parsed: false,
          marked: false
        };
        getFolders(path + '/' + item, true);
      }
    });
    getFilesInFolders();
  });
};

// getFiles 获取文件
var getFiles = function(path, key){
  fs.readdir(path, function(err, list){
    list.forEach(function(item){
      if(!fs.lstatSync(path + '/' + item).isDirectory()){
        if(folders[key].files.length === 0 || folders[key].files.indexOf(item) === -1){
          folders[key].files.push(item);
        }
      } else {
        if(folders[key].folders.indexOf(item) === -1){
          folders[key].folders.push(item);
        }
      }
    });
    folders[key].parsed = true;
    listFolders();
  });
};

var getFilesInFolders = function(){
  for (var key in folders) {
    if (folders.hasOwnProperty(key)) {
      getFiles(folders[key].path, key);
    }
  }
};

var listFolders = function(){
  var allParsed = true;
  var numFolders = 0;
  for(var key in folders){
    if(folders.hasOwnProperty(key)){
      numFolders++;
      if(!folders[key].logged || !folders[key].parsed){
        allParsed = false;
      }
      if(folders[key].parsed && !folders[key].logged){
        folders[key].logged = true;
        // console.log(JSON.stringify(folders[key],null,2));
      }
    }
  }
  if(allParsed && !exported){
    exported = true;
    // console.log('Number of folders: ' + numFolders);
    // generateText();
    generateMarkdown();
    console.log(JSON.stringify(folders,null,2));
  }
};

// generateText not used
var generateText = function(){
    outputText += 'Files and folders in ' + searchPath + '\n\n';
    for(var i = 0; i < depth + 1; i++){
      for(var key in folders) {
        if(folders.hasOwnProperty(key)){
          var folder = folders[key];
          if(folder.depth === i){
            var name = folder.path.split(searchPath)[1];
            outputText += name + '\n';
            for(var j = 0; j < name.length; j++){
              outputText += '-';
            }
            outputText += '\n';
            if(folder.files.length === 0){
              outputText += 'No files in folder' + '\n';
            }
            for(var j = 0; j < folder.files.length; j++){
              outputText += folder.files[j] + '\n';
            }
            outputText += '\n\n';
          }
        }
      }
    }
    fs.writeFile(outputFileName, outputText, function(err){
      if (err) return;
      // console.log(outputFileName +  '>' + outputText);
    });
  };
  
var addFileName = function(dirname, name, indent){
    var indent = indent + 4;
    markdownText += '';
    for(var i = 0; i < indent; i++){
        // if(i % 3 === 0){
        // markdownText += '|';
        // } else {
        markdownText += ' ';
        // }
    }
    // before
    // markdownText += '|-- ' + name + '\n';
    dirname = dirname.replace('/workspaces/dubuqingfeng', '.');
    dirname = dirname.replace('./docs', '');
    name = name.replace('.md', '');
    markdownText += '+ [' + name + '](' + dirname + '/' + name  + ')' + '\n';
};

var addFolderName = function(name, index){
if(folders[name] !== undefined){
    if(folders[name].marked){
    return;
    }
    var indent = (folders[name].depth - startDepth) * 4;
    markdownText += '';
    for(var i = 0; i < indent; i++){
        markdownText += ' ';
        // if(folders[name].folders.length > 0){
        //   if(i % 3 === 0){
        //     markdownText += '|';
        //   } else {
        //     markdownText += ' ';
        //   }
        // } else {
        //   markdownText += ' ';
        // }
    }
    if(index === 1){
        console.log('adding root folder');
        // before
        // markdownText += '|-- ' + startFolder + '\n';
        markdownText += '+ ' + startFolder + '\n';
    } else {
        // before
        // markdownText += '|-- ' + folders[name].name + '\n';
        markdownText += '+ ' + folders[name].name + '\n';
    }
    // console.log('Folders[name]:');
    // console.log(folders[name]);
    folders[name].files.forEach(function(f){
        addFileName(name, f, indent);
    });
    folders[name].marked = true;
    folders[name].folders.forEach(function(f){
        var path = name + '/' + f;
        addFolderName(path, 2);
    });    
}
};

var generateMarkdown = function(){
    addFolderName(key, 1);

    addSiblingfolderConnections();

    fs.writeFile(currentWorkingDirectory + '/' + outputFileName, markdownText, function(err){
        if (err) return;
        // console.log(outputFileName +  '>' + outputText);
    });
};

String.prototype.replaceAt=function(index, character) {
    return this.substring(0, index) + character + this.substring(index+character.length);
}

var addSiblingfolderConnections = function(){ 
    var lines = markdownText.split('\n');
    for(var i=1; i<lines.length; i++){
        var line1 = lines[i-1];
        var line2 = lines[i];
        for(var j=0; j<line2.length; j++){
        var char1 = line1.charAt(j);
        var char2 = line2.charAt(j);
        // console.log('comparing ' + char1 + ' with ' + char2);
        // Search for folder below to connect to
        var foundSibling = false;
        for(var k=i; k<lines.length; k++){
            var charBelow = lines[k].charAt(j);
            if(charBelow !== '|' && charBelow !== ' '){
            break;
            }
            if(charBelow === '|'){
            foundSibling = true;
            }
        }
        if(foundSibling && char1 === '|' && char2 === ' '){
            line2 = line2.replaceAt(j, '|');
            lines[i] = line2;
        }
        }
    }
    console.log('lines');
    console.log(lines);
    markdownText = lines.join('\n');
};


// start the mddir
folders[key] = {
    depth: searchPath.split('/').length - 1,
    parentFolder: null,
    path: searchPath,
    name: searchPath.split('/')[searchPath.split('/').length - 1],
    folders: [],
    files: [],
    logged: false,
    parsed: false,
    marked: false
};
fs.readdir(searchPath, function(err, list){
    list.forEach(function(item){
        if(!fs.lstatSync(searchPath + '/' + item).isDirectory()){
            if(folders[key].files.indexOf(item) === -1){
                folders[key].files.push(item);
            }
        }
    });
    folders[key].parsed = true;
});
getFolders(searchPath);