Linux arguments

Author: TheJaredWilcurt

README.md

@@ -99,7 +99,9 @@ const shortcutsCreated = createDesktopShortcut({
     // OPTIONAL: defaults to false
     terminal: false,
     // OPTIONAL: defaults to true
-    chmod: true
+    chmod: true,
+    // OPTIONAL
+    arguments: '--my-argument -f'
   },
   osx: {
     // REQUIRED: Path must exist
@@ -157,6 +159,7 @@ Key          | Type    | Allowed                                  | Default
 `type`       | String  | `'Application'`, `'Link'`, `'Directory'` | Based on `filePath`          | Type of shortcut. Defaults to `'Link'` if `filePath` starts with `'http://'` or `'https://'`. Defaults to `'Directory'` if filePath exists and is a folder. Defaults to Application otherwise.
 `terminal`   | Boolean | `true`, `false`                          | `false`                      | If true, will run in a terminal.
 `chmod`      | Boolean | `true`, `false`                          | `true`                       | If true, will apply a `chmod +x` (755) to the shortcut after creation to allow execution permission.
+`arguments`  | String  | Any string                               | None                         | Additional arguments passed in to the end of your target `filePath`
 
 
 ### OSX Settings

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "create-desktop-shortcuts",
   "main": "index.js",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Easy API to create desktop shortcuts with Node",
   "author": "The Jared Wilcurt",
   "keywords": [
@@ -26,10 +26,10 @@
   },
   "devDependencies": {
     "babel-eslint": "^10.1.0",
-    "eslint": "^7.18.0",
+    "eslint": "^7.20.0",
     "eslint-config-tjw-base": "^1.0.0",
     "eslint-config-tjw-jest": "^1.0.0",
-    "eslint-plugin-jsdoc": "^31.3.3",
+    "eslint-plugin-jsdoc": "^31.6.1",
     "fs-extra": "^9.1.0",
     "jest": "24.9.0",
     "mock-fs": "^4.13.0"

package.json

@@ -53,6 +53,9 @@ const library = {
     if (options.linux.icon) {
       icon = 'Icon=' + options.linux.icon;
     }
+    if (options.linux.arguments) {
+      exec = exec + ' ' + options.linux.arguments;
+    }
 
     // File format details:
     // https://wiki.archlinux.org/index.php/Desktop_entries

src/library.js

@@ -339,6 +339,7 @@ const validation = {
     options = this.defaultBoolean(options, 'linux', 'terminal', false);
     options = this.defaultBoolean(options, 'linux', 'chmod', true);
     options = this.validateOptionalString(options, 'linux', 'comment');
+    options = this.validateOptionalString(options, 'linux', 'arguments');
 
     return options;
   },

src/validation.js

@@ -147,6 +147,21 @@ describe('library', () => {
           'Icon=/home/DUMMY/icon.png'
         ].join('\n'));
     });
+
+    test('Arguments', () => {
+      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/file.ext -f --version',
+          'Name=file'
+        ].join('\n'));
+    });
   });
 
   describe('makeLinuxShortcut', () => {