watchly-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8ba362e4fd559aab05ea2ccedf8b60a68fa0f394621b6b69abf0c470ee25170
+  data.tar.gz: 16344f7295f4d3803260a6fb10ed0d98906eabc8e6949fe73b2266058dc90cbd
+SHA512:
+  metadata.gz: 6c8acb838e6d54b3fc1d34870e2082ad73c3eb020e1dddf22d9aa31540f8e3fc3ee8c3c5289db9913d1f3d55b1871c226c85a1ce8269e069ffa2bfcf7120b754
+  data.tar.gz: 2b6e914589926b03cea07b5948ff3e8d9b71f61fb8c542540e8320df63ac6231776fca06d065ceaea09c373a36140a8a3ed2c56b1ee28a4b25437f4ce3e4b081

data/README.md

@@ -0,0 +1,82 @@
+# Watchly CLI
+
+[Watchly][watchly] is a lightweight, dependency-free, polling-based file watcher for Ruby.
+It watches one or more glob patterns and reports changes.
+
+This is its command line interface.
+
+## Installation
+
+```bash
+gem install watchly-cli
+```
+
+## Usage
+
+<!-- START USAGE -->
+```console
+$ watchly --help
+watchly — run a command when files change
+
+Watches files matching one or more glob patterns and runs a command when
+they change.
+
+When the command runs, environment variables are set with the list of
+changed files (see below).
+
+Usage:
+  watchly COMMAND [options] [GLOB...]
+
+Options:
+  -i, --interval N
+    Loop interval in seconds [default: 1]
+
+  -q, --quiet
+    Print less to screen
+
+  -e, --each
+    Run the command once per added or changed file
+
+  -m, --immediate
+    Execute the command before watching
+
+  -h --help
+    Show this help
+
+Parameters:
+  COMMAND
+    Command to run on change
+
+  GLOB
+    One or more glob patterns [default: *.*]
+
+Environment Variables:
+  WATCHLY_FILES
+    Added and modified files, one per line
+
+  WATCHLY_ADDED
+    Added files, one per line
+
+  WATCHLY_MODIFIED
+    Modified files, one per line
+
+  WATCHLY_REMOVED
+    Removed files, one per line
+
+  WATCHLY_FILE
+    The file currently being processed (only with --each)
+
+Examples:
+  watchly 'echo "$WATCHLY_FILES"' 'spec/**/*.rb' 'lib/**/*.*'
+
+```
+<!-- END USAGE -->
+
+
+## Contributing / Support
+
+If you experience any issue, have a question, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+[watchly]: https://github.com/dannyben/watchly
+[issues]: https://github.com/dannyben/watchly-cli/issues

data/bin/watchly

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'colsole'
+require 'watchly/cli'
+
+include Colsole
+
+router = Watchly::CLI::CommandLine.router
+
+begin
+  exit router.run ARGV
+rescue => e
+  puts e.backtrace.reverse if ENV['DEBUG']
+  say! "r`#{e.class}: #{e.message}`"
+  exit 1
+end

data/lib/watchly/cli/command.rb

@@ -0,0 +1,95 @@
+require 'mister_bin'
+
+module Watchly
+  module CLI
+    class Command < MisterBin::Command
+      summary 'watchly — run a command when files change'
+      version "#{VERSION} (watchly #{Watchly::VERSION})"
+
+      help <<~HELP
+        Watches files matching one or more glob patterns and runs a command when
+        they change.
+
+        When the command runs, environment variables are set with the list of
+        changed files (see below).
+      HELP
+
+      usage 'watchly COMMAND [options] [GLOB...]'
+      usage 'watchly --version | --help'
+
+      param 'COMMAND', 'Command to run on change'
+      param 'GLOB', 'One or more glob patterns [default: *.*]'
+
+      option '-i --interval N', 'Loop interval in seconds [default: 1]'
+      option '-q --quiet', 'Print less to screen'
+      option '-e --each', 'Run the command once per added or changed file'
+      option '-m --immediate', 'Execute the command before watching'
+
+      environment 'WATCHLY_FILES', 'Added and modified files, one per line'
+      environment 'WATCHLY_ADDED', 'Added files, one per line'
+      environment 'WATCHLY_MODIFIED', 'Modified files, one per line'
+      environment 'WATCHLY_REMOVED', 'Removed files, one per line'
+      environment 'WATCHLY_FILE', 'The file currently being processed (only with --each)'
+
+      example %[watchly 'echo "$WATCHLY_FILES"' 'spec/**/*.rb' 'lib/**/*.*']
+
+      def run
+        run_command if immediate?
+        watch
+      rescue Interrupt
+        say "\ngoodbye"
+      end
+
+    private
+
+      def watch
+        say 'watching...'
+        watcher.on_change do |changes|
+          show_changes changes unless quiet?
+
+          if each?
+            run_each(changes)
+          else
+            run_command env_from_changes(changes)
+          end
+        end
+      end
+
+      def env_from_changes(changes)
+        {
+          'WATCHLY_FILES'    => changes.files.join("\n"),
+          'WATCHLY_ADDED'    => changes.added.join("\n"),
+          'WATCHLY_MODIFIED' => changes.modified.join("\n"),
+          'WATCHLY_REMOVED'  => changes.removed.join("\n"),
+        }
+      end
+
+      def show_changes(changes)
+        changes.added.each    { say "gb`+ #{it}`" }
+        changes.modified.each { say "bb`* #{it}`" }
+        changes.removed.each  { say "rb`- #{it}`" }
+      end
+
+      def run_command(env = {})
+        success = system env, command
+        { status: success ? 0 : 1 }
+      end
+
+      def run_each(changes)
+        changes.files.each do |file|
+          env = env_from_changes(changes).merge('WATCHLY_FILE' => file)
+          run_command(env)
+        end
+      end
+
+      def watcher = @watcher ||= Watchly::Watcher.new(globs, interval:)
+
+      def command = args['COMMAND']
+      def globs = args['GLOB'] || '*.*'
+      def interval = args['--interval'].to_i
+      def quiet? = args['--quiet']
+      def each? = args['--each']
+      def immediate? = args['--immediate']
+    end
+  end
+end

data/lib/watchly/cli/command_line.rb

@@ -0,0 +1,9 @@
+module Watchly
+  module CLI
+    class CommandLine
+      def self.router
+        MisterBin::Runner.new handler: Command
+      end
+    end
+  end
+end

data/lib/watchly/cli/version.rb

@@ -0,0 +1,5 @@
+module Watchly
+  module CLI
+    VERSION = '0.1.0'
+  end
+end

data/lib/watchly/cli.rb

@@ -0,0 +1,7 @@
+require 'mister_bin'
+
+require 'watchly'
+require 'watchly/version'
+require 'watchly/cli/version'
+require 'watchly/cli/command'
+require 'watchly/cli/command_line'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: watchly-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mister_bin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: watchly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: A small, dependency-free, polling-based executable that watches one or
+  more glob patterns and reports on change
+email: db@dannyben.com
+executables:
+- watchly
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/watchly
+- lib/watchly/cli.rb
+- lib/watchly/cli/command.rb
+- lib/watchly/cli/command_line.rb
+- lib/watchly/cli/version.rb
+homepage: https://github.com/dannyben/watchly-cli
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/dannyben/watchly-cli/issues
+  changelog_uri: https://github.com/dannyben/watchly-cli/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/dannyben/watchly-cli
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Lightweight, polling-based file system watcher CLI
+test_files: []