philipjscott / key-controller Goto Github PK

The library is broken 😢

What happened:

The following snippet does not work:

const controls = {
  inc: 'alt+b'
}

What you expected to happen:

Virtual keys should be able to map to compound keybindings

• Mention that this library only works with ES6 transpilers ATM
• Update example to use import syntax
• Demonstrate how to handle "capital" letters (we may need to fork keycode)

See https://github.com/ScottyFillups/key-controller/blob/master/lib/rotate.js#L5

Webpack 4 seems like a good candidate for building

Users should not need to need to manually check e.shiftKey; they should be able to put case-sensitive characters in the controls.

Describe the bug

The karma configuration is overly complicated (need to do a babel transform, then a browserify transform, then hook it up to istanbul). Not only that, but there's some buggy behaviour when running the tests in headless chrome (eg. https://github.com/ScottyFillups/key-controller/blob/master/test/controller.test.js#L28).

However, the most jarring problem is that the coverage reports returned from karma don't make any sense; why is it complaining that comments aren't being hit (https://coveralls.io/builds/19758335/source?filename=lib/controller.js)? Perhaps it would make more sense to just mock out the DOM and use Ava?

Users should be able to two or more real keys to a single virtual key. Perhaps by passing in an array such as left: ['left', 'a'].

Describe the bug
The README concepts section is too wordy, and the usage section's example is too large in scope.

Expected behavior
The usage and concepts section should be simple, and you should go more in-depth in an API section.

Consider:

const virtuals = (obj1, obj2, e) => ({
  next () {
    obj1.foo()
  },
  bar: {
    keyup () {
      obj2.bar()
    },
    keydown () {
      obj1.eee(e)
    }
  }
})

export default virtuals

If a virtual is a function rather than an object containing keyup and/or keydown, then it's assumed that the function should be applied on keydown (a shorthand). Multiple models will be allowed, and the keyboard event will be passed as the last parameter.

https://github.com/ScottyFillups/key-controller/blob/master/lib/controller.js#L74