Giter Site home page Giter Site logo

eduarbo / renibarak Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 38 KB

CLI and library with a bunch of helpers in Javascript which allows you to generate Karabiner-Elements config files

License: MIT License

TypeScript 99.70% JavaScript 0.30%
karabiner-elements karabiner javascript cli nodejs command-line

renibarak's Introduction

[WIP] 🚧️ Renibarak 🚧️

Renibarak (or Karabiner spelled backwards, how original!) is a CLI and library with a bunch of helpers in Javascript which allows you to generate Karabiner-Elements config files.

Tired of dealing with very large and inflexible JSON files so often I decided to make a tool that would allow me to manage, read and maintain my karabiner.json and Complex Modifications files with ease giving it the power and flexibility that a programming language can offer.

Install

npm install -g renibarak

Command Line Interface

It takes a directory as first argument that contains a set of js files to be transpiled to Karabiner-Elements compatible JSON files into the default config directory ~/.config/karabiner/ unless a second directory is passed as argument for a different destination.

If a karabiner.js file is found within the source directory it will be transpiled to karabiner.json. The rest of *.js files will be treated as Complex Modifications and therefore transpiled to JSON into the directory assets/complex_modifications/. You are free to import the library in any of these files and use any of the available helpers as you please.

Usage

$ renibarak [options] <source_dir> [destination_dir]

Options

-w, --watch                Watch a directory or file
-i, --ignore-main          Write only complex_modifications files
-v, --version              Prints version info
-h, --help                 Print usage info

Examples

Watch changes in current directory

renibarak -w .

Only transpile Complex Modifications from dotfiles directory

renibarak -i ~/.dotfiles/karabiner

Transpile files from dotfiles directory to a custom destination

renibarak ~/.dotfiles/karabiner ~/.dotfiles/karabiner/json

Config examples

For an example of Complex Modifications and main config file look at the examples/ directory.

License

MIT © Eduardo Ruiz

renibarak's People

Contributors

eduarbo avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.