Initial commit of the qmk keymap generator

This commit is contained in:
2019-10-10 13:17:57 +02:00
commit c4295039c9
11 changed files with 530 additions and 0 deletions
+50
View File
@@ -0,0 +1,50 @@
import { ILayer, ILayers } from './Layer';
export interface IKeyMap extends IterableIterator<ILayer> {
layers: ILayers;
[index: number]: ILayer;
}
export class KeyMap implements IKeyMap {
layers: ILayers = [];
index: number = 0;
constructor(layers: ILayers) {
this.layers = layers;
this.index = 0;
}
[index: number]: ILayer;
forEach(fn: (k: ILayer, i: number) => any): void {
return this.layers.forEach(fn);
}
map(fn: (k: ILayer, i: number) => ILayer): ILayers {
return this.layers.map(fn);
}
get length(): number {
return this.layers.length;
}
public next(): IteratorResult<ILayer> {
if (this.index < this.layers.length) {
return {
done: false,
value: this.layers[this.index++],
};
}
return {
done: true,
value: null,
};
}
[Symbol.iterator](): IterableIterator<ILayer> {
return this;
}
}
export const keymap = (...layers: ILayers): IKeyMap => new KeyMap(layers);
export default keymap;
+53
View File
@@ -0,0 +1,53 @@
import { IKeyRow, IKeyRows } from './Row';
export interface ILayer extends IterableIterator<IKeyRow> {
rows: IKeyRows;
index: number;
length: number;
forEach(fn: (k: IKeyRow, i: number) => any): void;
map(fn: (k: IKeyRow, i: number) => IKeyRow): IKeyRows;
}
export type ILayers = ILayer[];
class Layer implements ILayer {
rows: IKeyRows = [];
index: number = 0;
constructor(rows: IKeyRows) {
this.rows = rows;
this.index = 0;
}
forEach(fn: (k: IKeyRow, i: number) => any): void {
return this.rows.forEach(fn);
}
map(fn: (k: IKeyRow, i: number) => IKeyRow): IKeyRows {
return this.rows.map(fn);
}
get length(): number {
return this.rows.length;
}
public next(): IteratorResult<IKeyRow> {
if (this.index < this.rows.length) {
return {
done: false,
value: this.rows[this.index++],
};
}
return {
done: true,
value: null,
};
}
[Symbol.iterator](): IterableIterator<IKeyRow> {
return this;
}
}
export const layer = (...rows: IKeyRows): ILayer => new Layer(rows);
export default layer;
+73
View File
@@ -0,0 +1,73 @@
import { IKey, IKeys } from './keys';
export interface IKeyRow extends IterableIterator<IKey> {
keys: IKeys;
index: number;
length: number;
forEach(fn: (k: IKey, i: number) => any): void;
map(fn: (k: IKey, i: number) => IKey): IKeys;
replace(keys: { [name: string]: IKey | IKeys }): IKeyRow;
}
export class KeyRow implements IKeyRow {
keys: IKeys = [];
index: number = 0;
constructor(keys: IKeys) {
this.keys = keys;
this.index = 0;
}
forEach(fn: (k: IKey, i: number) => any): void {
return this.keys.forEach(fn);
}
map(fn: (k: IKey, i: number) => IKey): IKeys {
return this.keys.map(fn);
}
get length(): number {
return this.keys.length;
}
replace(keys: { [name: string]: IKey | IKeys }): IKeyRow {
const updatedKeys: IKeys = [];
for (let i: number = 0; i < this.keys.length; i++) {
const key: IKey | IKeys = this.keys[i];
if (key && keys[key]) {
if (keys[key] instanceof Array) {
(<IKeys>keys[key]).forEach((k) => updatedKeys.push(k));
} else {
updatedKeys.push(<IKey>keys[key]);
}
} else {
updatedKeys.push(key);
}
}
this.keys = updatedKeys;
return this;
}
public next(): IteratorResult<IKey> {
if (this.index < this.keys.length) {
return {
done: false,
value: this.keys[this.index++],
};
}
return {
done: true,
value: null,
};
}
[Symbol.iterator](): IterableIterator<IKey> {
return this;
}
}
export type IKeyRows = IKeyRow[];
export const row = (...keys: IKeys): IKeyRow => new KeyRow(keys);
export default row;
+18
View File
@@ -0,0 +1,18 @@
import { KC, IKeys } from './keys';
export const fKeys: IKeys = [KC.F1, KC.F2, KC.F3, KC.F4, KC.F5, KC.F6, KC.F7, KC.F8, KC.F9, KC.F10, KC.F11, KC.F12];
export const KC_2 = new Array(2).fill(KC.TRNS);
export const KC_3 = new Array(3).fill(KC.TRNS);
export const KC_4 = new Array(4).fill(KC.TRNS);
export const KC_5 = new Array(5).fill(KC.TRNS);
export const KC_6 = new Array(6).fill(KC.TRNS);
export const KC_7 = new Array(7).fill(KC.TRNS);
export const KC_8 = new Array(8).fill(KC.TRNS);
export const KC_9 = new Array(9).fill(KC.TRNS);
export const KC_10 = new Array(10).fill(KC.TRNS);
export const numbers: IKeys = [KC.N1, KC.N2, KC.N3, KC.N4, KC.N5, KC.N6, KC.N7, KC.N8, KC.N9, KC.N0];
export const letterRow1: IKeys = [KC.Q, KC.W, KC.E, KC.R, KC.T, KC.Y, KC.U, KC.I, KC.O, KC.P];
export const letterRow2: IKeys = [KC.A, KC.S, KC.D, KC.F, KC.G, KC.H, KC.J, KC.K, KC.L];
export const letterRow3: IKeys = [KC.Z, KC.X, KC.C, KC.V, KC.B, KC.N, KC.M];
+132
View File
@@ -0,0 +1,132 @@
export enum KC {
ESC = 'KC_ESC',
F1 = 'KC_F1',
F2 = 'KC_F2',
F3 = 'KC_F3',
F4 = 'KC_F4',
F5 = 'KC_F5',
F6 = 'KC_F6',
F7 = 'KC_F7',
F8 = 'KC_F8',
F9 = 'KC_F9',
F10 = 'KC_F10',
F11 = 'KC_F11',
F12 = 'KC_F12',
PSCR = 'KC_PSCR',
SLCK = 'KC_SLCK',
PAUS = 'KC_PAUS',
GRV = 'KC_GRV',
N1 = 'KC_1',
N2 = 'KC_2',
N3 = 'KC_3',
N4 = 'KC_4',
N5 = 'KC_5',
N6 = 'KC_6',
N7 = 'KC_7',
N8 = 'KC_8',
N9 = 'KC_9',
N0 = 'KC_0',
MINS = 'KC_MINS',
EQL = 'KC_EQL',
BSPC = 'KC_BSPC',
BSPACE = 'KC_BSPC',
INS = 'KC_INS',
HOME = 'KC_HOME',
PGUP = 'KC_PGUP',
TAB = 'KC_TAB',
Q = 'KC_Q',
W = 'KC_W',
E = 'KC_E',
R = 'KC_R',
T = 'KC_T',
Y = 'KC_Y',
U = 'KC_U',
I = 'KC_I',
O = 'KC_O',
P = 'KC_P',
LBRC = 'KC_LBRC',
RBRC = 'KC_RBRC',
BSLS = 'KC_BSLS',
NONUS_BSLASH = 'NONUS_BSLASH',
NUBS = 'NONUS_BSLASH',
DEL = 'KC_DEL',
DELETE = 'KC_DEL',
END = 'KC_END',
PGDN = 'KC_PGDN',
A = 'KC_A',
S = 'KC_S',
D = 'KC_D',
F = 'KC_F',
G = 'KC_G',
H = 'KC_H',
J = 'KC_J',
K = 'KC_K',
L = 'KC_L',
SCLN = 'KC_SCLN',
SCOLON = 'KC_SCLN',
QUOT = 'KC_QUOT',
QUOTE = 'KC_QUOT',
ENT = 'KC_ENT',
LSFT = 'KC_LSFT',
Z = 'KC_Z',
X = 'KC_X',
C = 'KC_C',
V = 'KC_V',
B = 'KC_B',
N = 'KC_N',
M = 'KC_M',
COMM = 'KC_COMM',
DOT = 'KC_DOT',
SLSH = 'KC_SLSH',
RSFT = 'KC_RSFT',
UP = 'KC_UP',
LCTL = 'KC_LCTL',
LC = 'KC_LCTL',
LALT = 'KC_LALT',
LGUI = 'KC_LGUI',
SPC = 'KC_SPC',
RGUI = 'KC_RGUI',
APP = 'KC_APP',
RCTL = 'KC_RCTL',
RC = 'KC_RCTL',
LEFT = 'KC_LEFT',
DOWN = 'KC_DOWN',
RGHT = 'KC_RGHT',
TRNS = 'KC_TRNS',
_ = 'KC_TRNS',
BRIGHTNESS_DOWN = 'KC_BRIGHTNESS_DOWN',
BDWN = 'KC_BRIGHTNESS_DOWN',
BRIGHTNESS_UP = 'KC_BRIGHTNESS_UP',
BUP = 'KC_BRIGHTNESS_UP',
MEDIA_PREV_TRACK = 'KC_MEDIA_PREV_TRACK',
MPT = 'KC_MEDIA_PREV_TRACK',
MEDIA_NEXT_TRACK = 'KC_MEDIA_NEXT_TRACK',
MNT = 'KC_MEDIA_NEXT_TRACK',
MEDIA_PLAY_PAUSE = 'KC_MEDIA_PLAY_PAUSE',
MPP = 'KC_MEDIA_PLAY_PAUSE',
MUTE = 'KC_MUTE',
VOLD = 'KC_VOLD',
VOLU = 'KC_VOLU',
}
export const K = KC;
const enum KeyComboType {}
export type KeyCombo = string & KeyComboType;
const enum LayerKeyEnum {}
export type LayerKey = string & LayerKeyEnum;
export type IKey = KC | KeyCombo | LayerKey;
export type IKeys = IKey[];
export const LT = (layer: number, key: IKey): LayerKey => `LT(${layer}, ${key})` as LayerKey;
export const MO = (layer: number): LayerKey => `MO(${layer})` as LayerKey;
export const DF = (layer: number): LayerKey => `DF(${layer})` as LayerKey;
export const LCTL = (key: IKey): KeyCombo => `LCTL(${key})` as KeyCombo;
export const RCTL = (key: IKey): KeyCombo => `RCTL(${key})` as KeyCombo;
export const RC = RCTL;
export const LSFT = (key: IKey): KeyCombo => `LSFT(${key})` as KeyCombo;
export const LS = LSFT;
export const RSFT = (key: IKey): KeyCombo => `RSFT(${key})` as KeyCombo;
export const LALT = (key: IKey): KeyCombo => `LALT(${key})` as KeyCombo;
export const RALT = (key: IKey): KeyCombo => `RALT(${key})` as KeyCombo;
export const LGUI = (key: IKey): KeyCombo => `LGUI(${key})` as KeyCombo;
export const RGUI = (key: IKey): KeyCombo => `RGUI(${key})` as KeyCombo;