qmk-cli 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 915b0f8e03509b8c776660b1a9f335441707e1b4
+  data.tar.gz: f4541bde947171682ffa95db7b2d92084d458a5a
+SHA512:
+  metadata.gz: 9aa6510c0fbad4586d251fab54ae968ee74542c83c596b87cf32e9480d54e3b68a44a017531a878afa19e0efa866b4ce6a57f8308ae679b2e86bf0dbb0229567
+  data.tar.gz: 1d0050383637fc83085fd80fd91a7e9f32049695df559abc0e14d5bed3e7a0d42dcc2f3269e3dc78891dc712e07436b8ae33b63e56917b4e380ae007fef31e35

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE.txt

@@ -0,0 +1,5 @@
+Copyright 2018 Nic Haynes
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/Makefile

@@ -0,0 +1,15 @@
+.PHONY: build
+build: clean
+	@gem build qmk_cli.gemspec
+
+.PHONY: install
+install:
+	@gem install *.gem
+
+.PHONY: publish
+publish: build
+	@gem push *.gem
+
+.PHONY: clean
+clean:
+	@rm -f *.gem

data/README.md

@@ -0,0 +1,48 @@
+# qmk-cli
+
+A thin wrapper around QMK's `make` to make common tasks easier.
+
+## Why use this?
+
+- Flashing is more intuitive (Example: `qmk flash planck`)
+- Automatic programmer detection (No more "Does this board use dfu-programmer/avrdude/teensy/other?")
+- Supports standalone keymaps
+
+## Usage
+
+    Usage:
+      qmk COMMAND [options]
+
+    Commands:
+      flash KEYBOARD    Flash a keyboard
+      build KEYBOARD    Compile a keyboard
+      clean [KEYBOARD]  Cleans up output folders so things compile from scratch
+      setup             Clone QMK firmware and checkout latest tag
+      update            Update QMK firmware to latest tag
+
+    Options:
+      -k, --keymap KEYMAP              Your keymap name (default: `whoami`)
+      -h, --help                       Show this help message
+
+## Standalone keymaps
+
+- Add a `.qmk` file in your keymaps directory to designate this a standalone keymaps directory.
+- Keyboard directories should be at the root with the keymap files inside. Since these are *your* keymaps there's no need to add additional namespacing.
+
+View [nicinabox/keymaps](https://github.com/nicinabox/keymaps) for a complete example on how standalone keymaps should be organized.
+
+## Platforms
+
+- [x] macOS
+- [x] linux, probably
+- [ ] windows
+
+## Requirements
+
+- Ruby >= 2
+- Git
+- [build tools](https://docs.qmk.fm/getting_started_build_tools.html)
+
+## License
+
+ISC

data/bin/qmk

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'cli'
+
+QMK::CLI.new(ARGV)

data/lib/cli.rb

@@ -0,0 +1,89 @@
+require 'optparse'
+require 'firmware'
+
+USAGE = <<-USAGE
+  Usage:
+    qmk COMMAND [options]
+
+  Commands:
+    flash KEYBOARD    Flash a keyboard
+    build KEYBOARD    Compile a keyboard
+    clean [KEYBOARD]  Cleans up output folders so things compile from scratch
+    keyboards         List available keyboards (scope with --keymap)
+    setup             Clone QMK firmware and checkout latest tag
+    update            Update QMK firmware to latest tag
+
+  Options:
+USAGE
+
+module QMK
+  class CLI
+    def initialize(args)
+      @options = parser(args)
+      command, keyboard = args
+      @firmware = Firmware.new(keyboard, @options[:keymap], keymaps_only?)
+
+      self.send(parse_command(command || 'help'))
+    end
+
+    def setup
+      @firmware.setup
+    end
+
+    def update
+      @firmware.update
+      @firmware.update_submodules
+    end
+
+    def build
+      @firmware.make
+    end
+
+    def flash
+      @firmware.make @firmware.programmer
+    end
+
+    def clean
+      @firmware.make 'clean'
+    end
+
+    def keyboards
+      puts @firmware.keyboards
+    end
+
+    def help
+      puts @options[:help]
+    end
+
+    private
+    def parser(args)
+      options = {}
+
+      OptionParser.new do |parser|
+        parser.banner = USAGE
+
+        options[:keymap] = keymaps_only? ? `whoami`.strip : nil
+        parser.on("-k", "--keymap KEYMAP", "Your keymap name (default: #{options[:keymap]})") do |v|
+          options[:keymap] = v
+        end
+
+        options[:help] = parser
+        parser.on("-h", "--help", "Show this help message")
+      end.parse!
+
+      options
+    end
+
+    def parse_command(cmd)
+      cmd.gsub(/\-/, '_').downcase
+    end
+
+    def keymaps_only?
+      File.exists? '.qmk'
+    end
+
+    def method_missing(*args)
+      help
+    end
+  end
+end

data/lib/firmware.rb

@@ -0,0 +1,136 @@
+require 'fileutils'
+require 'open3'
+require 'programmer'
+require 'git'
+
+LIB_PATH = "/usr/local/lib/qmk_firmware"
+
+module QMK
+  class Firmware
+    def initialize(keyboard, keymap, keymaps_only)
+      @keyboard = keyboard
+      @keymap = keymap
+      @repo = Git.new(LIB_PATH)
+      @keymaps_only = keymaps_only
+    end
+
+    def make(target = nil)
+      if @keymaps_only
+        prepare_firmware
+      end
+
+      in_repo do
+        run "make #{make_target(target)}"
+      end
+    end
+
+    def setup
+      @repo.clone 'https://github.com/qmk/qmk_firmware.git'
+
+      in_repo do
+        @repo.checkout_latest_tag
+      end
+    end
+
+    def update_submodules
+      in_repo do
+        run "make git-submodule"
+      end
+    end
+
+    def checkout_stable
+      in_repo do
+        @repo.fetch_origin
+        @repo.checkout_latest_tag
+      end
+    end
+
+    def update
+      in_repo do
+        @repo.clean
+        checkout_stable
+      end
+    end
+
+    def keyboards
+      if @keymaps_only
+        standalone_keyboards
+      else
+        qmk_keyboards @keymap
+      end
+    end
+
+    def standalone_keyboards
+      Dir["**/keymap.c"]
+        .map {|path| File.dirname(path) }
+        .sort
+    end
+
+    def qmk_keyboards(keymap=nil)
+      Dir["#{keyboards_path}/**/#{keymap}/keymap.c"]
+        .map {|path|
+          File.dirname(path)
+            .gsub(keyboards_path, '')
+            .split('/')
+            .reject(&:empty?)
+            .first
+        }
+        .uniq
+        .sort
+    end
+
+    def keyboard_name
+      @keyboard.gsub(/\/rev.*/, '')
+    end
+
+    def programmer
+      Programmer.new(keyboard_path).flasher
+    end
+
+    private
+    def in_repo(&block)
+      @repo.in_repo &block
+    end
+
+    def run(cmd)
+      Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+        while line = stdout.gets
+          puts line
+        end
+      end
+    end
+
+    def prepare_firmware
+      keyboard_path = File.expand_path "./#{keyboard_name}"
+      files = Dir.glob "#{keyboard_path}/*"
+
+      FileUtils.mkdir_p keymap_path
+      FileUtils.cp_r files, keymap_path
+    end
+
+    def make_target(target = nil)
+      return target unless @keyboard
+      [@keyboard, @keymap, target].compact.join(':')
+    end
+
+    def keyboards_path
+      "#{@repo.path}/keyboards"
+    end
+
+    def keyboard_path
+      "#{keyboards_path}/#{keyboard_name}"
+    end
+
+    def keymap_path
+      if handwired?
+        keyboard_path
+      else
+        "#{keyboard_path}/keymaps/#{@keymap}"
+      end
+    end
+
+    def handwired?
+      @keyboard =~ /handwired/
+    end
+  end
+end

data/lib/git.rb

@@ -0,0 +1,41 @@
+module QMK
+  class Git
+    def initialize(repo_path)
+      @repo_path = repo_path
+    end
+
+    def path
+      @repo_path
+    end
+
+    def ensure_path_exists
+      `mkdir -p #{@repo_path}`
+    end
+
+    def clone(repo)
+      ensure_path_exists
+      `git clone #{repo} #{@repo_path}`
+    end
+
+    def fetch_origin
+      `git fetch origin master`
+    end
+
+    def checkout_latest_tag
+      `git checkout #{latest_tag}`
+    end
+
+    def latest_tag
+      `git describe --tags $(git rev-list --tags --max-count=1)`
+    end
+
+    def clean
+      `git checkout .`
+      `git clean -df`
+    end
+
+    def in_repo(&block)
+      Dir.chdir @repo_path, &block
+    end
+  end
+end

data/lib/makefile.rb

@@ -0,0 +1,40 @@
+require 'tempfile'
+
+class Makefile
+  def initialize(include_makefile)
+    @include_makefile = include_makefile
+    @file = Tempfile.new('makefile')
+
+    write
+  end
+
+  def write
+    @file.write contents
+    @file.close
+  end
+
+  def run(variable)
+    `make -f #{@file.path} -f #{@include_makefile} print-#{variable.upcase}`
+  end
+
+  def value(variable)
+    output = run variable
+    _, value = parse output
+    value
+  end
+
+  def parse(output)
+    match = output.match /^(\w+)=(.+)/
+    if match
+      [match[1], match[2]]
+    end
+  end
+
+  def contents
+    <<-contents
+.PHONY: print-%
+print-%:
+\t@echo '$*=$($*)'
+    contents
+  end
+end

data/lib/programmer.rb

@@ -0,0 +1,50 @@
+require 'makefile'
+
+FLASHERS = {
+  'dfu': ['lufa-dfu', 'qmk-dfu', 'atmel-dfu'],
+  'avrdude': ['caterina', 'usbasploader'],
+  'teensy': 'halfkay',
+}
+
+BOOTLOADERS = {
+  'halfkay': ['512', '1024'],
+  'atmel-dfu': '4096',
+  'usbasploader': '2048',
+}
+
+class Programmer
+  def initialize(keyboard_path)
+    @keyboard_path = keyboard_path
+  end
+
+  def bootloader
+    filename = "#{@keyboard_path}/rules.mk"
+    parse_bootloader_name(filename) if File.exists? filename
+  end
+
+  def flasher
+    bootloader and FLASHERS.each do |k, v|
+      break k if v.include? bootloader.downcase
+    end
+  end
+
+  private
+  def bootloader_from_size(size)
+    size and BOOTLOADERS.each do |k, v|
+      break k.to_s if v.include? size
+    end
+  end
+
+  def parse_bootloader_name(filename)
+    make = Makefile.new(filename)
+    name = make.value 'BOOTLOADER'
+    return name if name
+
+    size = make.value 'BOOTLOADER_SIZE'
+    return bootloader_from_size(size) if size
+
+    opt_defs = make.value 'OPT_DEFS'
+    match = opt_defs.match /BOOTLOADER_SIZE=(\w+)/
+    return bootloader_from_size(match[1]) if match
+  end
+end

data/qmk_cli.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = "qmk-cli"
+  s.version     = "0.2.0"
+  s.date        = "2018-02-27"
+  s.summary     = "A cli wrapper for QMK Firmware"
+  s.authors     = ["Nic Haynes"]
+  s.email       = "nic@nicinabox.com"
+  s.files       = `git ls-files -z`.split("\x0")
+  s.homepage    = "https://github.com/nicinabox/qmk-cli"
+  s.license     = "MIT"
+
+  s.executables << "qmk"
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: qmk-cli
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nic Haynes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: nic@nicinabox.com
+executables:
+- qmk
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- Makefile
+- README.md
+- bin/qmk
+- lib/cli.rb
+- lib/firmware.rb
+- lib/git.rb
+- lib/makefile.rb
+- lib/programmer.rb
+- qmk_cli.gemspec
+homepage: https://github.com/nicinabox/qmk-cli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A cli wrapper for QMK Firmware
+test_files: []