Merge pull request #66 from MaartenDesnouck/next-version

MaartenDesnouck · web-flow · commit 6155a0c29c51 · 2017-10-01T19:58:17.000+02:00
Next version
diff --git a/README.md b/README.md
@@ -16,7 +16,8 @@ $ npm i -g google-apps-script
 
 # Usage
 
-Authenticate the Drive API (add '-f' to force reauthentication):
+Authenticate the Drive API:   
+(Add '-f' to force reauthentication)
 
 ```
 $ gas auth [-f]
@@ -30,24 +31,25 @@ $ gas delete <projectName|projectId>
 $ gas rename <projectName|projectId> <newProjectName>
 ```
 
-List your remote projects and their iId's (optional filter on projectName):
+List your remote projects and their id's (optional filter on projectName):
 
 ```
 $ gas list [filter]
 ```
 
-Link a remote project to your current directory:
+Link a remote project to your current working directory:
 
 ```
 $ gas link <projectName|projectId>
 ```
 
-Pull and push code from/to your remote project:
-(We map files in local folders to their full path name in a project and the other way around)
+Pull and push code from/to your remote project:   
+(Files in local folders are mapped to their full path name in a project and the other way around)   
+(You can specify to pull or push only a single file by adding a filename to the command)
 
 ```
-$ gas pull
-$ gas push
+$ gas pull [fileName]
+$ gas push [fileName]
 ```
 
 Some shortcuts for creating, linking and pulling projects all in one:
diff --git a/bin/gas b/bin/gas
@@ -21,7 +21,7 @@ program
 
 program
     .command('init <projectName>')
-    .alias('new' )
+    .alias('new')
     .description('create a new Google Apps Script project in your Google Drive and then clone that project locally')
     .action(require(lib + '/init'));
 
@@ -52,14 +52,14 @@ program
     .action(require(lib + '/clone'));
 
 program
-    .command('push')
+    .command('push [fileName]')
     .alias('deploy')
-    .description('push your local code to the linked project on your Google Drive')
+    .description('push your local code to the linked folder on your Google Drive (add a fileName to only pull that file)')
     .action(require(lib + '/push'));
 
 program
-    .command('pull')
-    .option('-i, --include', 'Pull included files from their sources')
+    .command('pull [fileName]')
+    .option('-i, --include', 'Pull included files from their sources (add a fileName to only pull that file)')
     .description('pull code from your Google Drive, (add \'-i\' to also pull included files)')
     .action(require(lib + '/pull'));
 
@@ -86,12 +86,12 @@ program
 
 program
     .command('*')
-    .action(function(argv) {
+    .action(function (argv) {
         console.log('\'gas %s\' is not a valid command use \'gas -h\' for help', argv);
         process.exit(2);
     });
 
-program.on('--help', function() {
+program.on('--help', function () {
     console.log('');
     console.log('  Examples:');
     console.log('');
diff --git a/lib/clone.js b/lib/clone.js
@@ -60,7 +60,7 @@ module.exports = (identifier) => {
     });
 
     const unpacked = Promise.all([downloaded, gotMetadata, ]).then((values) => {
-        return unpackRemote(path.join(process.cwd(), values[1].name));
+        return unpackRemote(path.join(process.cwd(), values[1].name), null);
     });
 
     unpacked.then(() => {
diff --git a/lib/functions/downloadRemote.js b/lib/functions/downloadRemote.js
@@ -53,7 +53,7 @@ function downloadRemote(auth, projectId, dir, method) {
             } else {
                 // Deleting id's from remote
                 for (const file of content.files) {
-                    delete file.id;
+                    Reflect.deleteProperty(file,'id');
                 }
                 createFile({
                     name: remote,
diff --git a/lib/functions/packLocal.js b/lib/functions/packLocal.js
@@ -28,7 +28,7 @@ function getFileJSON(rootFolder, file, fileName, extension) {
                         return;
                     }
 
-                    const type = extension === '.js' ? 'server_js' : 'html';
+                    const type = extension === '.html' ? 'html' : 'server_js';
                     const fileJSON = {
                         name: fileName,
                         type,
@@ -64,7 +64,7 @@ function packLocal(rootFolder) {
             const folder = path.parse(file).dir;
 
             // If extension is correct and fileName does not start with a dot
-            if ((extension === '.js' || extension === '.html') && (nameWithoutExtension[0] !== '.')) {
+            if ((extension === '.js' || extension === '.gs' || extension === '.html') && (nameWithoutExtension[0] !== '.')) {
                 const filename = path.join(folder, nameWithoutExtension).replace(`\\`, `/`);
                 if (filenames.includes(filename)) {
                     reject(`Can't construct a Google Apps Script project with files with the same name: '${filename}.*'`);
diff --git a/lib/functions/packLocalSingleFile.js b/lib/functions/packLocalSingleFile.js
@@ -0,0 +1,70 @@
+const fs = require('fs-extra');
+const path = require('path');
+const createFile = require('./createFile.js');
+const getAllFiles = require('./getAllFiles.js');
+const constants = require('../constants.js');
+
+/**
+ * Pack all seperate .js files back into a raw google script file
+ *
+ * @param {string} rootFolder - relative path to the rootFolder of the project
+ * @param {string} fileName - which file we should add to local.json
+ * @returns {Promise} - A promise resolving no value
+ */
+function packLocalSingleFile(rootFolder, fileName) {
+    // Read every local file and create a correct local.json file
+    return new Promise((resolve, reject) => {
+        const fileNameWithoutExtension = path.join(path.parse(fileName).dir, path.parse(fileName).name);
+        const extension = path.parse(fileName).ext;
+
+        if (!(extension === '.js' || extension === '.gs' || extension === '.html')) {
+            reject(`File has an invalid extension`);
+            return;
+        }
+
+        // Read the file we are going to include
+        fs.readFile(path.join(rootFolder, fileName), 'utf8', (err, source) => {
+            if (err) {
+                // TODO handle this well
+                reject(`Can't seem to find '${fileName}'`);
+                return;
+            }
+
+            // Read remote
+            const remote = path.join(rootFolder, constants.META_DIR, constants.META_REMOTE);
+            const remoteData = JSON.parse(fs.readFileSync(remote, 'utf8'));
+
+            // Check if file already in remote
+            let alreadyInRemote = false;
+            for (const file of remoteData.files) {
+                if (file.name === fileNameWithoutExtension) {
+                    file.source = source;
+                    alreadyInRemote = true;
+                    break;
+                }
+            }
+
+            // Add the file if not already in remote
+            if (!alreadyInRemote) {
+                const extension = path.parse(fileName).ext;
+                const type = extension === '.html' ? 'html' : 'server_js';
+                remoteData.files.push({
+                    name: fileNameWithoutExtension,
+                    type,
+                    source,
+                });
+            }
+
+            // Write to local.json
+            const local = path.join(rootFolder, constants.META_DIR, constants.META_LOCAL);
+            const file = {
+                name: local,
+                source: JSON.stringify(remoteData),
+            };
+            createFile(file);
+            resolve();
+        });
+    });
+}
+
+module.exports = packLocalSingleFile;
diff --git a/lib/functions/unpackRemote.js b/lib/functions/unpackRemote.js
@@ -14,10 +14,12 @@ const gitignoreContent = '# .gitignore for Google Apps Script projects using htt
  * Unpack a remote google script file into seperate .js and .html files
  *
  * @param {string} rootFolder - relative path to the rootFolder of the project
+ * @param {string} fileName - if specified, only this file will get unpacked
  * @returns {Promise} - A promise resolving no value
  */
-function unpackRemote(rootFolder) {
+function unpackRemote(rootFolder, fileName) {
     return new Promise((resolve, reject) => {
+        let foundSingleFile = false;
         const local = path.join(rootFolder, constants.META_DIR, constants.META_LOCAL);
         const remote = path.join(rootFolder, constants.META_DIR, constants.META_REMOTE);
 
@@ -39,14 +41,22 @@ function unpackRemote(rootFolder) {
 
                 const included = file.name.substring(0, constants.INCLUDE_DIR.length + 1) === `${constants.INCLUDE_DIR}/`;
 
+                // What files do we need to create?
                 if (!file.source.includes(constants.IGNORE) && !included) {
-                    remoteFiles.push(file);
+                    if (!fileName) {
+                        remoteFiles.push(file);
+                    } else if (fileName === remoteFileName) {
+                        remoteFiles.push(file);
+                        foundSingleFile = true;
+                    }
+
                 }
             }
 
-            // Synch create all necessary files
-            for (const remoteFile of remoteFiles) {
-                createFile(remoteFile);
+            // Reject if we have not found our file
+            if (fileName && !foundSingleFile) {
+                reject(`Can't seem to find the file '${fileName}' in this project`);
+                return;
             }
 
             // Write local.json
@@ -55,28 +65,38 @@ function unpackRemote(rootFolder) {
                 source: data,
             });
 
-            // Remove all .js and .html that were not in remote.json
-            const toDelete = [];
-            for (const localFileName of localFiles) {
-                const extension = path.parse(localFileName).ext;
-                if ((extension === '.html' || extension === '.js') && !remoteNames.includes(localFileName) && localFileName !== constants.INCLUDE_FILE) {
-                    toDelete.push(path.join(rootFolder, localFileName));
-                }
+            // Synch create all necessary files
+            for (const remoteFile of remoteFiles) {
+                createFile(remoteFile);
             }
 
-            for (const fileToDelete of toDelete) {
-                fs.removeSync(fileToDelete);
-            }
+            // If there was no file specified to pull we will do a cleanup
+            if (!fileName) {
+                // Remove all .js and .html that were not in remote.json
+                const toDelete = [];
+                for (const localFileName of localFiles) {
+                    const extension = path.parse(localFileName).ext;
+                    if ((extension === '.html' || extension === '.js' || extension === '.gs') && !remoteNames.includes(localFileName) && localFileName !== constants.INCLUDE_FILE) {
+                        toDelete.push(path.join(rootFolder, localFileName));
+                    }
+                }
+
+                for (const fileToDelete of toDelete) {
+                    if (!fileName) {
+                        fs.removeSync(fileToDelete);
+                    }
+                }
 
-            // Remove all empty folders
-            const allFolders = getAllFolders(rootFolder).sort().reverse();
+                // Remove all empty folders
+                const allFolders = getAllFolders(rootFolder).sort().reverse();
 
-            for (const emptyFolder of allFolders) {
-                const files = fs.readdirSync(emptyFolder);
-                if (files.length === 0) {
-                    fs.removeSync(emptyFolder);
-                } else if (files.length === 1 && files[0] === '.DS_Store') {
-                    fs.removeSync(emptyFolder);
+                for (const emptyFolder of allFolders) {
+                    const files = fs.readdirSync(emptyFolder);
+                    if (files.length === 0) {
+                        fs.removeSync(emptyFolder);
+                    } else if (files.length === 1 && files[0] === '.DS_Store') {
+                        fs.removeSync(emptyFolder);
+                    }
                 }
             }
 
diff --git a/lib/link.js b/lib/link.js
@@ -50,7 +50,6 @@ module.exports = (identifier) => {
 
     const downloaded = Promise.all([gotMetadata, gotAuth, ]).then((values) => {
         const metadata = values[0];
-        process.stdout.clearLine();
         readline.cursorTo(process.stdout, 0);
         process.stdout.write(`Linking '${metadata.name}' to this folder...`);
         return downloadRemote(values[1], metadata.id, '.', 'link');
diff --git a/lib/pull.js b/lib/pull.js
@@ -13,10 +13,11 @@ const getProjectRoot = require('./functions/getProjectRoot.js');
 /**
  * Pull code from a linked remote Google Apps Script project
  *
+ * @param {object} fileName - Optional fileName to pull.
  * @param {object} options - Extra options.
  * @returns {void}
  */
-module.exports = (options) => {
+module.exports = (fileName, options) => {
     const gotProjectRoot = getProjectRoot('.');
 
     const checkedVersion = checkNewVersion();
@@ -52,12 +53,17 @@ module.exports = (options) => {
     const downloaded = Promise.all([gotAuth, gotId, gotMetadata, gotProjectRoot, ]).then((values) => {
         process.stdout.clearLine();
         readline.cursorTo(process.stdout, 0);
-        process.stdout.write(`Pulling \'${values[2].name}\' from Google Drive...`);
+        if (fileName) {
+            process.stdout.write(`Pulling \'${values[2].name} > ${fileName}\' from Google Drive...`);
+        } else {
+            process.stdout.write(`Pulling \'${values[2].name}\' from Google Drive...`);
+        }
+
         return downloadRemote(values[0], values[1], values[3].folder, 'pull');
     });
 
     const unpacked = Promise.all([gotProjectRoot, downloaded, ]).then((values) => {
-        return unpackRemote(values[0].folder);
+        return unpackRemote(values[0].folder, fileName);
     });
 
     unpacked.then(() => {
diff --git a/lib/push.js b/lib/push.js
@@ -1,7 +1,9 @@
+const readline = require('readline');
 const pull = require('./pull.js');
 const authenticate = require('./functions/authenticate.js');
 const getId = require('./functions/getId.js');
 const packLocal = require('./functions/packLocal.js');
+const packLocalSingleFile = require('./functions/packLocalSingleFile.js');
 const pushToRemote = require('./functions/pushToRemote.js');
 const downloadRemote = require('./functions/downloadRemote.js');
 const getMetadata = require('./functions/getMetadata.js');
@@ -14,8 +16,9 @@ const getProjectRoot = require('./functions/getProjectRoot.js');
  * Push all local code to the remote Google Apps Script project
  *
  * @returns {void}
+ * @param {string} fileName - if defined, only this file will be pushed to remote
  */
-module.exports = () => {
+module.exports = (fileName) => {
     const checkedVersion = checkNewVersion();
 
     const gotProjectRoot = getProjectRoot('.');
@@ -48,12 +51,24 @@ module.exports = () => {
         return getMetadata(values[0], values[1]);
     });
 
-    const downloaded = Promise.all([gotAuth, gotId, gotProjectRoot, gotMetadata, ]).then((values) => {
-        return downloadRemote(values[0], values[1], values[2].folder, 'pull');
+    const downloaded = Promise.all([gotAuth, gotId, gotMetadata, gotProjectRoot, ]).then((values) => {
+        process.stdout.clearLine();
+        readline.cursorTo(process.stdout, 0);
+        if (fileName) {
+            process.stdout.write(`Pushing \'${values[2].name} > ${fileName}\' to Google Drive...`);
+        } else {
+            process.stdout.write(`Pushing \'${values[2].name}\' to Google Drive...`);
+        }
+
+        return downloadRemote(values[0], values[1], values[3].folder, 'pull');
     });
 
-    const packed = Promise.all([gotProjectRoot, gotMetadata, ]).then((values) => {
-        return packLocal(values[0].folder);
+    const packed = Promise.all([gotProjectRoot, gotMetadata, downloaded, ]).then((values) => {
+        if (fileName) {
+            return packLocalSingleFile(values[0].folder, fileName);
+        } else {
+            return packLocal(values[0].folder);
+        }
     });
 
     const pushed = Promise.all([gotAuth, gotId, gotProjectRoot, downloaded, packed, ]).then((values) => {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/test/e2e.sh b/test/e2e.sh

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ function downloadRemote(auth, projectId, dir, method) {`
`53`	`53`	`} else {`
`54`	`54`	`// Deleting id's from remote`
`55`	`55`	`for (const file of content.files) {`
`56`		`- delete file.id;`
	`56`	`+ Reflect.deleteProperty(file,'id');`
`57`	`57`	`}`
`58`	`58`	`createFile({`
`59`	`59`	`name: remote,`