extensionator 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3780dd6f297b930567d87ad3db41b44f43702759
-  data.tar.gz: 9ac68018622dff9e312be10be2cfe97522ec35e2
+  metadata.gz: 6f228953265e76ab390c3ebeb2fe6d9e18c27fbd
+  data.tar.gz: b354884cce12724b56979fe5975ed9b0933d0c43
 SHA512:
-  metadata.gz: 7806db009edfc01d8e56a9aced37d2e287b2b37293464977d49b1e748cfedef0e5da1665bd7f709cd8dffcf91cea4e6234c12b982eadabd1bcbaac8ff2368bfa
-  data.tar.gz: 61eb7af4225a22e2397baf1427507ece88a658c630c22d00c6cd5d53bb7ff22e28d7cbdfaba5f5e4bcd40c120661dbfe196de15eccfd69ee82500966f8c47a6c
+  metadata.gz: 27be9ac6fdc50941a5c7f206a20867df9a24ec403d6f54f8b37e3493e13ae3b402190fc312a6836a2aa0839ee245e64902d5a59a4bdd202c695199b27fe05f4d
+  data.tar.gz: 7090dec70551fab36c7f7196ef00c7b1053c1643ddfd399c981ef9c8a05b5c053ab4c7b548ea8efd25b428f677eac6e1dbaab4b13f3bbabb04dcdb1a0ccdb636

data/README.md

@@ -1,6 +1,6 @@
 # Extensionator
 
-Package Chrome extensions. Inspired by [crxmake][crxmake-url], but with an eye towards simplicity and supportability. Use the CLI or the Ruby API.
+Package Chrome extensions. Zip files or CRXs. Some convenience options. Use the command line or Ruby API.
 
 [![Gem Version][gem-image]][gem-url]
 [![MIT License][license-image]][license]
@@ -15,15 +15,15 @@ Package Chrome extensions. Inspired by [crxmake][crxmake-url], but with an eye t
 gem install extensionator
 ```
 
-## What you need
+## Keys
 
-You need a private key so sign the extension with, and this is a BYOK (bring your own key) library. So first, you need a PEM file. If you have one, cool. If not, do this:
+If you plan on generating a CRX (as opposed to just a zip file to upload somewhere), you need a private key so sign the extension with, and this is a BYOK (bring your own key) library. So first, you need a PEM file. If you have one, cool. If not, do this:
 
 ```
 openssl genrsa -out key.pem 2048
 ```
 
-You'll also need a directory to package up. Extensionator doesn't pay any attention to the contents; it just repackages them. So if you're misssing a `manifest.json` or your files are encoded wrong or whatever, you won't find out until you try to load the packed extension into Chrome.
+That's the file you'll use as `key.pem` below.
 
 ## Command line
 
@@ -31,23 +31,30 @@ You'll also need a directory to package up. Extensionator doesn't pay any attent
 extensionator -d directory/with/extension -i key.pem -o output.crx
 ```
 
-You can also exclude files with a regex, which will be applied to each level of the path (so if you have `foo/bar/baz.stuff`, we compare the regex to "foo", "foo/bar", and "foo/bar/baz.stuff"):
+Useful options! There are single-letter versions of most of these:
 
-```
-extensionator -d directory/with/extension -i key.pem -o output.crx -e "\.md$"
-```
+  * `-e` `--exclude`. Specify a regex of things to exclude. Matches on the whole path. `-e "\.md$"
+
+  * `-f` `--format`. "zip" or "crx". Zip is what the Chrome store has you upload, since it does its own signing. You won't need the `-i` option unless you do something weird with the other options.
+
+  * `--inject-key`. If you have an extension in the store, you know you can't have a "key" property in your manifest file. But if you do local developmentand want to keep your extension ID the same, you need that property in there. This is because Google hates you and wants to make your life hard. Fortunately, Extensionator can take your pem file, generate the public key, and put it in the manifest file before zipping up the extension. Yay!
+
+ * `--inject-version`. Use this to override the "version" property in your manifest.
 
-If you're one of *those* people, here's this thing:
+Here's the whole shebang:
 
 ```
--> extensionator -h
+-> extensionator --help
 usage: /Users/isaac/.gem/ruby/2.1.5/bin/extensionator [options]
-    -d, --directory  Directory containing the extension. (Default: .)
-    -i, --identity   Location of the pem file to sign with. (Required)
-    -o, --output     Location of the output file. (Default: 'extension.crx')
-    -e, --exclude    Regular expression for filenames to exclude. (Default: \.crx$)
-    -v, --version    Extensionator version info.
-    -h, --help       Print this message.
+    -d, --directory   Directory containing the extension. (Default: .)
+    -i, --identity    Location of the pem file to sign with.
+    -o, --output      Location of the output file. (Default: 'extension.[zip|crx]')
+    -e, --exclude     Regular expression for filenames to exclude. (Default: .crx$)
+    -f, --format      Type of file to produce, either zip or crx. Defaults to crx
+    --inject-version  Inject a version number into the manifest file.
+    --inject-key      Inject a key parameter into the manifest file.
+    -v, --version     Extensionator version info.
+    -h, --help        Print this message.
 ```
 
 ## Programmatically
@@ -56,13 +63,21 @@ Same as above, but:
 
 ```rb
 require "extensionator"
-Extensionator.create("directory/with/extension", "key.pem", "output_file.crx")
+Extensionator.crx("directory/with/extension", "key.pem", "output_file.crx")
+```
+
+Or to create a zip:
+
+```rb
+Extensionator.zip("directory/with/extension", "output_file.zip")
 ```
 
-Or with an `exclude` option:
+Options go at the end of either method call, and just look just like the CLI ones, but as Ruby symbols:
 
 ```rb
-Extensionator.create("dir", "key.pem", "output_file.crx", exclude: /\.md$/)
+Extensionator.crx("dir", "key", "output.crx", inject_version: "4.5.1",
+                                              inject_key: true,
+                                              exclude: /\.md$/)
 ```
 
 ## License

data/lib/extensionator/cli.rb

@@ -9,9 +9,9 @@ module Extensionator
         o.string "-i", "--identity", "Location of the pem file to sign with."
         o.string "-o", "--output", "Location of the output file. (Default: 'extension.[zip|crx]')"
         o.string "-e", "--exclude", "Regular expression for filenames to exclude. (Default: \.crx$)"
-        o.string "-f", "--format", "Type of file to produce, either zip or crx. Defaults to crx"
-        o.string "--inject-version", "Inject a version number into the manifest file."
-        o.bool "--inject-key", "Inject a key parameter into the manifest file."
+        o.string "-f", "--format", "Type of file to produce, either zip or crx. (Default: crx)"
+        o.string "--inject-version", "Inject a version number into the manifest file. (Default: none)"
+        o.bool "--inject-key", "Inject a key parameter into the manifest file. (Default: no)"
         #o.string "--skip-validation", "Don't try to validate this extension."
         o.on "-v", "--version", "Extensionator version info." do
           puts Extensionator::VERSION

data/lib/extensionator/version.rb

@@ -1,3 +1,3 @@
 module Extensionator
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: extensionator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Isaac Cambron