playwright-cli 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c70812c6e97a5e0351036b1f32cc533e7833d59ad46c32efb16b6cdc8e167023
-  data.tar.gz: c39ef6a202fed3feeb7015d1f0adbfdfe29fd42f41a4493555e4e67b28f2d5d0
+  metadata.gz: 77a1822555e09c749d2408b29496ca5840553bd45decf3c1f24ee8f87448e8e0
+  data.tar.gz: a97277bfb37d67ad68099f362db4c3fd2c5a8243da676b727723f7b703cda2fa
 SHA512:
-  metadata.gz: bbffdc6bdb10897709564e578ea6b9312dd2a2c0f8a468a5c80b9a7d0e98624c5a5fcc72bfef381ca55492d3bbcfa4b54a24bce7e6e8d50d0bb606ba3c22ac36
-  data.tar.gz: 2c93bab7b6fc00a73d48fc5f3eae2f332ae8ec1cd9468bc8aa9998269381d6a343fbe7d6287156e982d2e4671c6e57e956acbb9a6b4cbf38fa7db3aee787d4e9
+  metadata.gz: 2fc6645dc4cbd4305c35caea58c1c50ca7335f875eb2d7c490428bb6314e03d93b0f3437ed1f4ca0007f2c2affaa3bd741df3d6d39c73db3e042b19862128ca4
+  data.tar.gz: 66ca9d2e2ef45e96e449b0bf41593ecf483b1bbf45084b2ab5a71508df5526d5a3936be6731080a3b212474ae1bf8f9017a8ec441017cb85f48cbc5dfb973cd9

data/README.md

@@ -1,34 +1,197 @@
 # Playwright::CLI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/playwright/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Playwright::CLI is a tool for quickly building (and hopefully soon sharing)
+Ruby command line applications. It's first goal is to provide a solid generator
+for building command line apps in Ruby. It's built on top of [Hanami::CLI](https://github.com/hanami/cli),
+so all of their documentation applies here as well.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install this gem with:
+
+    $ gem install playwright-cli
+
+## Usage
+
+### Check The Version
+
+To check the version:
+```shell
+$ playwright -v #=> 0.1.4
+```
+
+### Create An App
+
+To create a simple command line app:
+
+    $ playwright generate my-script
+
+(aliases for `generate` include `g`, `new`)
+This will give you some boilerplate for your script and an example command that
+you should replace. It will look something like this:
 
 ```ruby
-gem 'playwright-cli'
+#!/usr/bin/env ruby
+
+require 'playwright/cli'
+
+module MyScript
+  module CLI
+    module Commands
+      extend Playwright::CLI::Registry
+
+      class Root < Playwright::CLI::Command
+        desc "Says a greeting to the name given. This is an example."
+
+        argument :name, required: true, desc: 'Whom shall I greet?'
+
+        example [
+          "\"Johnny Boy\" #=> Why, hello Johnny Boy!"
+        ]
+
+        def call(name:, **)
+          puts "Why, hello #{name}!"
+        end
+
+      end
+
+      register_root Root
+
+    end
+  end
+end
+
+Playwright::CLI.new(MyScript::CLI::Commands).call
+
+```
+
+Most of this code is simply wrapping [Hanami::CLI](https://github.com/hanami/cli), so their documentation
+will be the best source of information for you in handling arguments and options.
+
+So far, only `#register_root` here is a playwright feature. It allows you to
+overwrite the root command. In this case that means:
+```shell
+$ my-script tom #=> Why, hello tom!
+```
+
+Hanami::CLI is built for more intricate command line apps, so playwright allows
+you to generate that as well.
+```shell
+$ playwright g my-script --type=expanded
 ```
+This will give you a mostly similar main class:
 
-And then execute:
+```ruby
+#!/usr/bin/env ruby
 
-    $ bundle
+require 'playwright/cli'
+require_relative 'lib/version'
 
-Or install it yourself as:
+module MyScript
+  module CLI
+    module Commands
+      extend Playwright::CLI::Registry
 
-    $ gem install playwright-cli
+      class Greet < Playwright::CLI::Command
+        desc "Says a greeting to the name given. This is an example."
 
-## Usage
+        argument :name, required: true, desc: 'Whom shall I greet?'
+
+        example [
+          "\"Johnny Boy\" #=> Why, hello Johnny Boy!"
+        ]
 
-TODO: Write usage instructions here
+        def call(name:, **)
+          puts "Why, hello #{name}!"
+        end
 
-## Development
+      end
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+      register 'greet', Greet
+      register 'version', Version, aliases: ['v', '-v', '--version']
+
+    end
+  end
+end
+
+Playwright::CLI.new(MyScript::CLI::Commands).call
+```
+It will also give you a new file structure with an example (version) command:
+```
+  my-script
+    |- lib/
+    |   |- version.rb
+    |- my-script.rb
+```
+The main differences are that a new file lib/version is required and registered
+with aliases.
+
+Version class simply looks like this:
+```ruby
+module MyScript
+  module CLI
+
+    VERSION = "0.0.1"
+
+    module Commands
+      extend Playwright::CLI::Registry
+
+      class Version < Playwright::CLI::Command
+        desc "Responds with the version number."
+
+        example ["#=> #{VERSION}"]
+
+        def call(**)
+          puts VERSION
+        end
+
+      end
+
+    end
+  end
+end
+```
+
+This is useful for command line apps that will have multiple functions. This
+example would let you do:
+
+```shell
+$ my-script greet tom #=> Why, hello tom!
+$ my-script version #=> 0.0.1
+```
+
+
+### Edit An App
+
+Playwright::CLI uses your `$EDITOR` environment variable when choosing what
+editor to use when opening one of your playwright scripts.
+
+Use:
+
+`$ echo $EDITOR`
+
+To see what playwright will default to. You can update this in your ~/.bashrc
+(or ~/.zshrc if you are using zsh).
+
+In the future, I plan on allowing that to be a config you can set
+
+To edit an app:
+
+`$ playwright edit my-script`
+
+`e` can be used instead of `edit`.
+
+### Delete An App
+
+Deleting a playwright app is simply:
+
+```shell
+$ playwright destroy my-script
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`delete` or `d` can be used instead of `destroy`
+This works for both simple and expanded apps. It cannot be used to delete or
+uninstall existing terminal commands, only playwright commands
 
 ## Contributing
 

data/lib/playwright/cli/version.rb

@@ -1,5 +1,5 @@
 module Playwright
   class CLI < Hanami::CLI
-    VERSION = "0.1.3"
+    VERSION = "0.1.5"
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playwright-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Mike Gregory