firefox-profile - npm Package Compare versions

Comparing version 0.3.10 to 0.3.11

CHANGELOG.md

@@ -0,1 +1,5 @@
+# 0.3.11
+
+* added a cli to create or copy profile
+
 # 0.3.10
@@ -2,0 +6,0 @@

lib/firefox_profile.js

@@ -100,8 +100,12 @@ /**
  *
- * @param {Object|String|null} options optional. if it is an object, it can contain the following option: 
- *                                  * profileDirectory: the profile to copy. Not recommended: use FirefoxProfile.copy instead
- *                                  * destinationDirectory: where the profile will be stored. If not provided, 
- *                                          a tmp direcoty will be used WARNING: if it will be emptied!!
- *                             if it is a string it will copy the directory synchronously.
- *                                    (not recommended at all, kept for backward compatibility)
+ * @param {Object|String|null} options optional. 
+ *
+ *
+ * If it is an object, it can contain the following option: 
+ * * profileDirectory: the profile to copy. Not recommended: use FirefoxProfile.copy instead
+ * * destinationDirectory: where the profile will be stored. If not provided, 
+ *    a tmp directory will be used WARNING: if the tmp directory will be deleted when the process will terminate.
+ * 
+ * if it is a string it will copy the directory synchronously
+ *   (not recommended at all, kept for backward compatibility).
  */
@@ -171,6 +175,8 @@ function FirefoxProfile(options) {
  *
- * @param {Object|String|null} options if it is an object: 
- *                                  * profileDirectory - required - the profile to copy.
- *                                  * destinationDirectory: where the profile will be stored. If not provided, 
- *                                          a tmp direcoty will be used. WARNING: if it will be emptied!!
+ * @param {Object|String|null} options
+ *
+ * if it is an object, the following properties are available: 
+ * * profileDirectory - required - the profile to copy.
+ * * destinationDirectory: where the profile will be stored. If not provided, 
+ *    a tmp directory will be used. WARNING: if the tmp directory will be deleted when the process exits.
  */
@@ -177,0 +183,0 @@

package.json

 {
   "name": "firefox-profile",
-  "version": "0.3.10",
+  "version": "0.3.11",
   "description": "firefox profile for selenium WebDriverJs, admc/wd or any other node selenium driver that supports capabilities",
@@ -17,2 +17,3 @@ "main": "lib/firefox_profile",
   },
+  "bin" : { "firefox-profile" : "./lib/cli.js" },
   "repository": {
@@ -34,24 +35,32 @@ "type": "git",
   },
-  "contributors": [{
-    "name": "testingbot",
-    "url": "http://www.testingbot.com"
-  }, {
-    "name": "David Sturley",
-    "url": "https://github.com/circusbred"
-  }, {
-    "name": "Jordan Santell",
-    "url": "http://jsantell.com"
-  }, {
-    "name": "Piotr Kuczynski",
-    "url": "https://github.com/pkuczynski"
-  }, {
-    "name": "halo2376",
-    "url": "https://github.com/halo2376"
-  }, {
-    "name": "XrXr",
-    "url": "https://github.com/XrXr"
-  }, {
-    "name": "Christoph Dorn",
-    "url": "http://www.christophdorn.com/"
-  }],
+  "contributors": [
+    {
+      "name": "testingbot",
+      "url": "http://www.testingbot.com"
+    },
+    {
+      "name": "David Sturley",
+      "url": "https://github.com/circusbred"
+    },
+    {
+      "name": "Jordan Santell",
+      "url": "http://jsantell.com"
+    },
+    {
+      "name": "Piotr Kuczynski",
+      "url": "https://github.com/pkuczynski"
+    },
+    {
+      "name": "halo2376",
+      "url": "https://github.com/halo2376"
+    },
+    {
+      "name": "XrXr",
+      "url": "https://github.com/XrXr"
+    },
+    {
+      "name": "Christoph Dorn",
+      "url": "http://www.christophdorn.com/"
+    }
+  ],
   "devDependencies": {
@@ -74,3 +83,2 @@ "blanket": "~1.1.x",
   "dependencies": {
-    "jetpack-id": "0.0.4",
     "adm-zip": "~0.4.x",
@@ -80,9 +88,11 @@ "archiver": "~0.14.3",
     "fs-extra": "~0.16.x",
+    "ini": "~1.3.3",
+    "jetpack-id": "0.0.4",
     "lazystream": "~0.1.0",
     "lodash": "~3.5.0",
+    "minimist": "^1.1.1",
     "node-uuid": "~1.4.1",
     "wrench": "~1.5.8",
-    "xml2js": "~0.4.4",
-    "ini": "~1.3.3"
+    "xml2js": "~0.4.4"
   }
-}
+}

README.md

@@ -24,2 +24,4 @@ # firefox-profile-js
 
+It also contains a [command line interface](#command-line-interface) that allows to copy or create profiles.
+
 ## Installation
@@ -52,3 +54,3 @@
      * and make http://saadtazi.com the url that is opened on new tabs
-    /******************************************************************
+    /******************************************************************/
     var webdriver = require('selenium-webdriver');
@@ -88,3 +90,3 @@
     /* installs firebug, and make it active by default
-    /**************************************************
+    /**************************************************/
 
@@ -123,2 +125,20 @@ var FirefoxProfile = require('firefox-profile'),
 
+## Command Line Interface
+
+It allows to copy (from profile name or profile directory) or create firefox profiles with installed extensions. Note that it does not allow to load user preferences... yet.
+
+Run `node_modules/bin/firefox-profile -h` to get the help message:
+
+```
+usage: firefox-profile [-v] [-p profilename || -c profile_dir] [-e extension_path1 [-e extension_path2]] [-o destination_dir || --ouput destination_dir || -b [file_path] || --base64 [file_path]]
+
+-v: verbose mode (same as --verbose)
+-h: show this message (same as --help)
+-p profilename: profile to copy (same as --profile)
+-c profile_dir: profile folder path to copy (same as --copy)
+-e extension_path: file path to extension to add to the profile. Can be present multiple times (same as --extension)
+-o destination_dir (or --output destination_dir): folder where the profile will be created.
+-b [file_path](or --base64): write the encoded firefox profile to stdout or to file_path if specified.
+```
+
 ## API Documentation
@@ -125,0 +145,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

39791

increased by14.46%

Number of package files

8

increased by14.29%

Lines of code

841

increased by16.32%

Number of lines in readme file

175

increased by12.9%

Worsened metrics

Dependency count

12

increased by9.09%

Number of low supply chain risk alerts

7

increased by16.67%

Dependency changes

• + Addedminimist@^1.1.1

• + Addedminimist@1.2.8(transitive)