Removed path.getProjectFolderName().

Added docblocks throughout.

src/path.js

@@ -3,27 +3,43 @@
 const fs = require('fs');
 const path = require('path');
 
-const getProjectFolderName = (givenPath) => {
-    return givenPath.split(path.sep).pop();
+/**
+ * Checks if `file` exists and returns `true`, `false` otherwise.
+ *
+ * @param  {String} file Path of the file
+ *
+ * @return {Boolean}
+ */
+const isFile = (file) => {
+    return fs.statSync(file).isFile();
 };
 
-const isFile = (givenPath) => {
-    return fs.statSync(givenPath).isFile();
+/**
+ * Checks if `directory` exists and returns `true`, `false` otherwise.
+ *
+ * @param  {String} directory
+ *
+ * @return {Boolean}
+ */
+const isDirectory = (directory) => {
+    return fs.statSync(directory).isDirectory();
 };
 
-const isDirectory = (givenPath) => {
-    return fs.statSync(givenPath).isDirectory();
-};
-
-const makeDirectory = (givenPath) => {
-    if (!fs.existsSync(givenPath)) {
-        fs.mkdirSync(givenPath);
+/**
+ * Creates a directory at `directory` if it doesn't already exist
+ *
+ * @param  {String} directory
+ *
+ * @return {Void}
+ */
+const makeDirectory = (directory) => {
+    if (!fs.existsSync(directory)) {
+        fs.mkdirSync(directory);
     }
 };
 
 module.exports = {
     isFile: isFile,
     isDirectory: isDirectory,
     makeDirectory: makeDirectory,
-    getProjectFolderName: getProjectFolderName,
 };

src/process.js

@@ -2,6 +2,15 @@
 
 let spawn = require('child_process').spawn;
 
+/**
+ * Runs `command` as a shell process. Optionally, options can be passed to the
+ * underlying `child_process.spawn()` command via `sArgs`.
+ *
+ * @param  {String} command
+ * @param  {Object} sArgs
+ *
+ * @return {Void}
+ */
 const run = (command, sArgs) => {
     const spawnArgs = sArgs || {stdio: 'inherit', stdin: 'inherit'};
 

src/project.js

@@ -3,8 +3,15 @@
 const path = require('path');
 const log = require('npmlog');
 
+/**
+ * Retrieve the `package.json` file from the path provided by `folder`.
+ *
+ * @param  {String} folder
+ *
+ * @return {Object}
+ */
 const getPackageJson = (folder) => {
-    let pkg = [];
+    let pkg = {};
     try {
         pkg = require(path.join(folder, 'package.json'));
     } catch (e) {

src/validate.js

@@ -1,15 +1,36 @@
 'use strict';
 
+/**
+ * If `name` is a valid package name, returns `true`, otherwise `false`.
+ *
+ * @param  {String} name
+ *
+ * @return {Boolean}
+ */
 const isPackageName = (name) => {
     return !name.match(/^([a-zA-Z_$][a-zA-Z\d_$]*\.)+([a-zA-Z_$][a-zA-Z\d_$]*)$/)
     ? false
     : true;
 };
 
+/**
+ * If `dependency` is a valid React Native dependency, returns `true`, otherwise `false`.
+ *
+ * @param  {String} dependency
+ *
+ * @return {Boolean}
+ */
 const isPlugin = (dependency) => {
     return !!~dependency.indexOf('react-native-');
 };
 
+/**
+ * If `RN_PROJECT_ROOT`
+ *
+ * @param  {String} folder
+ *
+ * @return {Boolean}
+ */
 const isProject = () => {
     const pkg = require('./project').getPackageJson(process.env.RN_PROJECT_ROOT);
     var result = false;
@@ -25,6 +46,12 @@ const isProject = () => {
     return result;
 };
 
+/**
+ * If the current working directory matches the `RN_PROJECT_ROOT` environment
+ * variable, then returns `true`, otherwise `false`.
+ *
+ * @return {Boolean}
+ */
 const inProject = () => {
     return process.cwd() === process.env.RN_PROJECT_ROOT;
 };

tests/path.spec.js

@@ -45,13 +45,5 @@ describe('path', () => {
 
     });
 
-    describe('#getProjectFolderName', () => {
-
-        it('should get the folder name', () => {
-            expect(pathUtils.getProjectFolderName(path.join(__dirname, '..'))).to.deep.equals('rsx-common');
-        });
-
-    });
-
 });
 

tests/project.spec.js

@@ -21,7 +21,7 @@ describe('project', () => {
 
         it('should return an empty array if no package file exists', () => {
             let nonprojectPath = path.join(__dirname, 'fixtures');
-            expect(projectUtils.getPackageJson(nonprojectPath)).to.deep.equals([]);
+            expect(projectUtils.getPackageJson(nonprojectPath)).to.deep.equals({});
         });
 
     });