Merge pull request #113 from tldr-pages/fse

Remove wrench from the codebase

Author: agnivade

lib/cache.js

@@ -1,7 +1,5 @@
-var fs = require('fs');
+var fs = require('fs-extra');
 var path = require('path');
-var rmdir = require('rimraf');
-var wrench = require('wrench');
 var config = require('./config');
 var remote = require('./remote');
 var platform = require('./platform');
@@ -27,17 +25,17 @@ exports.getPage = function(page) {
 };
 
 exports.clear = function(done) {
-  rmdir(CACHE_FOLDER, done);
+  fs.remove(CACHE_FOLDER, done);
 };
 
 exports.update = function(done) {
   remote.download(function(err, tempFolder) {
     if (err) {
       return done(err);
     }
-    wrench.mkdirSyncRecursive(CACHE_FOLDER);
-    wrench.copyDirSyncRecursive(tempFolder, CACHE_FOLDER, {
-      forceDelete: true
+    fs.mkdirsSync(CACHE_FOLDER);
+    fs.copySync(tempFolder, CACHE_FOLDER, {
+      clobber: true
     });
     index.rebuildPagesIndex();
     return done();

lib/index.js

@@ -1,9 +1,10 @@
 'use strict';
 
-var fs = require('fs');
-var wrench = require('wrench');
+var fs = require('fs-extra');
 var path = require('path');
+
 var config = require('./config');
+var utils = require('./utils');
 
 var shortIndex = null;
 var classicIndex = null;
@@ -114,7 +115,7 @@ function readClassicPagesIndex() {
 
 function buildShortPagesIndex() {
   try {
-    var files = wrench.readdirSyncRecursive(pagesPath);
+    var files = utils.walkSync(pagesPath);
     files = files.filter(isPage);
     var reducer = function(index, file) {
       var os = parsePlatform(file);
@@ -133,6 +134,8 @@ function buildShortPagesIndex() {
   }
 }
 
+
+
 function buildClassicPagesIndex() {
   var shortIdx = getShortIndex();
   var index = Object.keys(shortIdx)

lib/remote.js

@@ -1,7 +1,6 @@
 var path = require('path');
 var os = require('os');
-var wrench = require('wrench');
-var rimraf = require('rimraf');
+var fs = require('fs-extra');
 var config  = require('./config');
 
 
@@ -17,8 +16,8 @@ exports.download = function(done) {
     inside = path.join(target, src.repo + '-' + src.branch);
   }
 
-  rimraf.sync(target);
-  wrench.mkdirSyncRecursive(target);
+  fs.removeSync(target);
+  fs.mkdirsSync(target);
 
   var extractor = unzip.Extract({path: target});
   extractor.on('error', function () {

lib/utils.js

@@ -0,0 +1,20 @@
+var fs = require('fs-extra');
+var path = require('path');
+
+var walkSync = function(dir, filelist) {
+  var files = fs.readdirSync(dir);
+  filelist = filelist || [];
+  files.forEach(function(file) {
+    if (fs.statSync(path.join(dir, file)).isDirectory()) {
+      filelist = walkSync(path.join(dir, file), filelist);
+    }
+    else {
+      filelist.push(path.join(path.basename(dir), file));
+    }
+  });
+  return filelist;
+};
+
+module.exports = {
+  walkSync: walkSync
+};

package.json

@@ -51,6 +51,7 @@
   "dependencies": {
     "chalk": "~1.1.1",
     "commander": "~2.9.0",
+    "fs-extra": "^0.30.0",
     "lodash.compact": "~3.0.0",
     "lodash.defaults": "~4.2.0",
     "lodash.get": "~4.4.2",
@@ -66,9 +67,7 @@
     "ms": "~0.7.1",
     "os-homedir": "~1.0.1",
     "request": "~2.75.0",
-    "rimraf": "~2.5.0",
-    "unzip2": "~0.2.5",
-    "wrench": "~1.5.8"
+    "unzip2": "~0.2.5"
   },
   "devDependencies": {
     "env-test": "*",

test/cache.spec.js

@@ -1,7 +1,7 @@
 var cache = require('../lib/cache');
 var should = require('should');
 var sinon = require('sinon');
-var fs = require('fs');
+var fs = require('fs-extra');
 var index = require('../lib/index');
 var platform = require('../lib/platform');
 

test/index.spec.js

@@ -1,14 +1,13 @@
-var wrench = require('wrench');
-var fs = require('fs');
+var fs = require('fs-extra');
 var index = require('../lib/index');
+var utils = require('../lib/utils');
 var sinon = require('sinon');
 var should = require('should');
 
 describe('Index', function() {
-
   beforeEach(function() {
     index.clearRuntimeIndex();
-    sinon.stub(wrench, 'readdirSyncRecursive')
+    sinon.stub(utils, 'walkSync')
       .returns([
         'index.json',
         'common/cp.md',
@@ -30,7 +29,7 @@ describe('Index', function() {
   });
 
   afterEach(function() {
-    wrench.readdirSyncRecursive.restore();
+    utils.walkSync.restore();
     fs.readFileSync.restore();
     fs.writeFileSync.restore();
   });