Wrap Linux filepath in quotes so spaces aren't seen as arguments

nwutils · Jun 15, 2022 · e0b9ab2 · e0b9ab2
1 parent fa3fd0f
commit e0b9ab2
Show file tree

Hide file tree

Showing 8 changed files with 1,752 additions and 1,593 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -20,8 +20,6 @@ module.exports = {
     'tjw-jsdoc'
   ],
   rules: {
-    // Turn on after https://github.com/eslint/eslint/issues/14745 resolved
-    'jsdoc/check-examples': 0,
     'jsdoc/require-example': 1
   }
 };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "create-desktop-shortcuts",
   "main": "index.js",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "Easy API to create desktop shortcuts with Node",
   "author": "The Jared Wilcurt",
   "keywords": [
@@ -30,12 +30,12 @@
     "which": "^2.0.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.18.2",
+    "@babel/core": "^7.18.5",
     "@babel/eslint-parser": "^7.18.2",
     "eslint": "^8.17.0",
     "eslint-config-tjw-base": "^2.0.0",
     "eslint-config-tjw-jest": "^2.0.0",
-    "eslint-config-tjw-jsdoc": "^1.0.1",
+    "eslint-config-tjw-jsdoc": "^1.0.2",
     "eslint-plugin-jsdoc": "^39.3.2",
     "fs-extra": "8.1.0",
     "jest": "24.9.0",

diff --git a/src/library.js b/src/library.js
@@ -32,7 +32,7 @@ const library = {
     // Set defaults
     let type = 'Type=Application';
     let terminal = 'Terminal=false';
-    let exec = 'Exec=' + options.linux.filePath;
+    let exec = 'Exec="' + options.linux.filePath + '"';
     let name = 'Name=' + path.parse(options.linux.filePath).name;
     let comment = '';
     let icon = '';

diff --git a/src/validation.js b/src/validation.js
@@ -171,7 +171,7 @@ const validation = {
    * object is a boolean, and if not, give it the correct default value.
    *
    * @example
-   * options = defaultBoolean(options);
+   * options = defaultBoolean(options, 'linux', 'chmod', true);
    *
    * @param  {object}  options          User's options
    * @param  {string}  operatingSystem  'windows', 'linux', or 'osx'

diff --git a/tests/e2e.js b/tests/e2e.js
@@ -3,6 +3,9 @@
  * @author  TheJaredWilcurt
  */
 
+const timeLabel = '|              |  Executed in';
+console.time(timeLabel);
+
 const fs = require('fs-extra');
 const path = require('path');
 
@@ -74,6 +77,7 @@ function alert (pass, message) {
   console.log('\n ______________ ' + fill('_'));
   console.log('|              |' + fill(' ') + '|');
   console.log('|  E2E ' + state + '  |  ' + message + '  |');
+  console.timeEnd(timeLabel);
   console.log('|              |' + fill(' ') + '|');
   console.log(' ¯¯¯¯¯¯¯¯¯¯¯¯¯¯ ' + fill('¯') + '\n\n');
 

diff --git a/tests/src/library.test.js b/tests/src/library.test.js
@@ -65,7 +65,7 @@ describe('library', () => {
           'Version=1.0',
           'Type=Application',
           'Terminal=false',
-          'Exec=/home/DUMMY/file.ext',
+          'Exec="/home/DUMMY/file.ext"',
           'Name=file'
         ].join('\n'));
     });
@@ -80,7 +80,7 @@ describe('library', () => {
           'Version=1.0',
           'Type=Application',
           'Terminal=true',
-          'Exec=/home/DUMMY/file.ext',
+          'Exec="/home/DUMMY/file.ext"',
           'Name=file'
         ].join('\n'));
     });
@@ -96,7 +96,7 @@ describe('library', () => {
           'Version=1.0',
           'Type=Directory',
           'Terminal=false',
-          'Exec=/home/DUMMY',
+          'Exec="/home/DUMMY"',
           'Name=DUMMY'
         ].join('\n'));
     });
@@ -111,7 +111,7 @@ describe('library', () => {
           'Version=1.0',
           'Type=Application',
           'Terminal=false',
-          'Exec=/home/DUMMY/file.ext',
+          'Exec="/home/DUMMY/file.ext"',
           'Name=Test'
         ].join('\n'));
     });
@@ -126,7 +126,7 @@ describe('library', () => {
           'Version=1.0',
           'Type=Application',
           'Terminal=false',
-          'Exec=/home/DUMMY/file.ext',
+          'Exec="/home/DUMMY/file.ext"',
           'Name=file',
           'comment=Test'
         ].join('\n'));
@@ -142,7 +142,7 @@ describe('library', () => {
           'Version=1.0',
           'Type=Application',
           'Terminal=false',
-          'Exec=/home/DUMMY/file.ext',
+          'Exec="/home/DUMMY/file.ext"',
           'Name=file',
           'Icon=/home/DUMMY/icon.png'
         ].join('\n'));
@@ -158,7 +158,23 @@ describe('library', () => {
           'Version=1.0',
           'Type=Application',
           'Terminal=false',
-          'Exec=/home/DUMMY/file.ext -f --version',
+          'Exec="/home/DUMMY/file.ext" -f --version',
+          'Name=file'
+        ].join('\n'));
+    });
+
+    test('Arguments with file path space', () => {
+      options.linux.filePath = '/home/DUMMY/foo bar/file.ext';
+      options.linux.arguments = '-f --version';
+
+      expect(library.generateLinuxFileData(options))
+        .toEqual([
+          '#!/user/bin/env xdg-open',
+          '[Desktop Entry]',
+          'Version=1.0',
+          'Type=Application',
+          'Terminal=false',
+          'Exec="/home/DUMMY/foo bar/file.ext" -f --version',
           'Name=file'
         ].join('\n'));
     });
@@ -199,7 +215,7 @@ describe('library', () => {
             'Version=1.0',
             'Type=Application',
             'Terminal=false',
-            'Exec=/home/DUMMY/file.ext',
+            'Exec="/home/DUMMY/file.ext"',
             'Name=file'
           ].join('\n')
         );
@@ -222,7 +238,7 @@ describe('library', () => {
             'Version=1.0',
             'Type=Application',
             'Terminal=false',
-            'Exec=/home/DUMMY/file.ext',
+            'Exec="/home/DUMMY/file.ext"',
             'Name=file'
           ].join('\n'),
           'Successfully errored'
@@ -246,7 +262,7 @@ describe('library', () => {
             'Version=1.0',
             'Type=Application',
             'Terminal=false',
-            'Exec=/home/DUMMY/file.ext',
+            'Exec="/home/DUMMY/file.ext"',
             'Name=file'
           ].join('\n')
         );
@@ -279,7 +295,7 @@ describe('library', () => {
             'Version=1.0',
             'Type=Application',
             'Terminal=false',
-            'Exec=/home/DUMMY/file.ext',
+            'Exec="/home/DUMMY/file.ext"',
             'Name=file'
           ].join('\n')
         );
@@ -411,6 +427,35 @@ describe('library', () => {
         );
     });
 
+    test('Windows arguments', () => {
+      options.windows.arguments = '--force';
+
+      expect(library.makeWindowsShortcut(options))
+        .toEqual(true);
+
+      expect(customLogger)
+        .not.toHaveBeenCalled();
+
+      expect(childProcess.execSync)
+        .not.toHaveBeenCalled();
+
+      expect(childProcess.spawnSync)
+        .toHaveBeenLastCalledWith(
+          'wscript',
+          [
+            library.produceWindowsVBSPath(),
+            'C:/Users/DUMMY/Desktop/file.lnk',
+            'C:/file.ext',
+            '--force',
+            '',
+            '',
+            'C:/file.ext',
+            1,
+            ''
+          ]
+        );
+    });
+
     test('Windows.vbs not found', () => {
       const fsExistsSync = fs.existsSync;
       fs.existsSync = jest.fn(() => {
@@ -669,7 +714,7 @@ describe('library', () => {
             'Version=1.0',
             'Type=Application',
             'Terminal=false',
-            'Exec=/home/DUMMY/file.ext',
+            'Exec="/home/DUMMY/file.ext"',
             'Name=file'
           ].join('\n')
         );
@@ -767,7 +812,7 @@ describe('library', () => {
             'Version=1.0',
             'Type=Application',
             'Terminal=false',
-            'Exec=/home/DUMMY/file.ext',
+            'Exec="/home/DUMMY/file.ext"',
             'Name=file'
           ].join('\n')
         );
@@ -844,7 +889,7 @@ describe('library', () => {
             'Version=1.0',
             'Type=Application',
             'Terminal=false',
-            'Exec=/home/DUMMY/file.ext',
+            'Exec="/home/DUMMY/file.ext"',
             'Name=file'
           ].join('\n')
         );

diff --git a/tests/testHelpers.js b/tests/testHelpers.js
@@ -186,6 +186,9 @@ const testHelpers = {
         'icon.bmp': 'text',
         Desktop: {},
         folder: {}
+      },
+      '/home/DUMMY/foo bar': {
+        'file.ext': 'text'
       }
     };
     if (os.platform() === 'win32') {