Keypress: Lint and rename to keypress.js (#18357)

Add an optional extended description…

types/keypress.js/index.d.ts

@@ -0,0 +1,51 @@
+// Type definitions for Keypress 2.0
+// Project: https://github.com/dmauro/Keypress/
+// Definitions by: Roger Chen <https://github.com/rcchen>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+// A keyboard input capturing utility in which any key can be a modifier key.
+
+export as namespace keypress;
+
+export interface ListenerDefaults {
+    keys: string;
+    prevent_default: boolean;
+    prevent_repeat: boolean;
+    is_unordered: boolean;
+    is_counting: boolean;
+    is_exclusive: boolean;
+    is_solitary: boolean;
+    is_sequence: boolean;
+}
+
+export interface Combo {
+    keys: string;
+    on_keydown(event?: KeyboardEvent, count?: number): any;
+    on_keyup(event?: KeyboardEvent): any;
+    on_release(event?: KeyboardEvent): any;
+    this: Element;
+    prevent_default: boolean;
+    prevent_repeat: boolean;
+    is_unordered: boolean;
+    is_counting: boolean;
+    is_exclusive: boolean;
+    is_sequence: boolean;
+    is_solitary: boolean;
+}
+
+export class Listener {
+    constructor(element?: Element, defaults?: ListenerDefaults);
+
+    simple_combo(keys: string, on_keydown_callback: (event?: KeyboardEvent, count?: number) => any): void;
+    counting_combo(keys: string, on_count_callback: (event?: KeyboardEvent, count?: number) => any): void;
+    sequence_combo(keys: string, callback: (event?: KeyboardEvent, count?: number) => any): void;
+    register_combo(combo: Combo): void;
+    unregister_combo(combo: Combo | string): void;
+    register_many(combos: Combo[]): void;
+    unregister_many(combos: Combo[] | string[]): void;
+    get_registered_combos(): Combo[];
+    destroy(): void;
+    reset(): void;
+    listen(): void;
+    stop_listening(): void;
+}

types/keypress.js/keypress.js-tests.ts

@@ -1,7 +1,7 @@
-namespace KeypressComboTests {
-    var listener = new window.keypress.Listener();
+function KeypressComboTests() {
+    const listener = new keypress.Listener();
 
-    var copyCombo = <Keypress.Combo>{
+    const copyCombo = <keypress.Combo> {
         keys: "cmd c",
         on_keydown: () => {
             console.log("Key down");
@@ -21,7 +21,7 @@ namespace KeypressComboTests {
         is_solitary: true
     };
 
-    var pasteCombo = <Keypress.Combo>{
+    const pasteCombo = <keypress.Combo> {
         keys: "ctrl v",
         on_keydown: () => {
             console.log("Paste");
@@ -42,9 +42,9 @@ namespace KeypressComboTests {
     listener.reset();
 }
 
-namespace KeypressBindingTests {
-    var element = document.createElement('div');
-    var defaults = <Keypress.ListenerDefaults>{
+function KeypressBindingTests() {
+    const element = document.createElement('div');
+    const defaults = <keypress.ListenerDefaults> {
         prevent_default: true,
         prevent_repeat: true,
         is_unordered: true,
@@ -53,7 +53,7 @@ namespace KeypressBindingTests {
         is_solitary: false,
         is_sequence: false
     };
-    var listener = new window.keypress.Listener(element);
-    listener = new window.keypress.Listener(element, defaults);
+    let listener = new keypress.Listener(element);
+    listener = new keypress.Listener(element, defaults);
     listener.reset();
 }

types/keypress.js/tsconfig.json

@@ -18,6 +18,6 @@
     },
     "files": [
         "index.d.ts",
-        "keypress-tests.ts"
+        "keypress.js-tests.ts"
     ]
 }

types/keypress.js/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }

types/keypress/index.d.ts

@@ -1,69 +0,0 @@
-// Type definitions for Keypress v2.0.3
-// Project: https://github.com/dmauro/Keypress/
-// Definitions by: Roger Chen <https://github.com/rcchen>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
-declare var __keypress: Keypress.Keypress;
-
-// Support AMD require
-declare module 'keypress.js' {
-    export = __keypress;
-}
-
-// A keyboard input capturing utility in which any key can be a modifier key.
-declare namespace Keypress {
-
-    interface ListenerDefaults {
-        keys: string;
-        prevent_default: boolean;
-        prevent_repeat: boolean;
-        is_unordered: boolean;
-        is_counting: boolean;
-        is_exclusive: boolean;
-        is_solitary: boolean;
-        is_sequence: boolean;
-    }
-
-    interface Combo {
-        keys: string;
-        on_keydown: (event?: KeyboardEvent, count?: number) => any;
-        on_keyup: (event?: KeyboardEvent) => any;
-        on_release: (event?: KeyboardEvent) => any;
-        this: Element;
-        prevent_default: boolean;
-        prevent_repeat: boolean;
-        is_unordered: boolean;
-        is_counting: boolean;
-        is_exclusive: boolean;
-        is_sequence: boolean;
-        is_solitary: boolean;
-    }
-
-    interface Listener {
-        new(element: Element, defaults: ListenerDefaults): Listener;
-        new(element: Element): Listener;
-        new(): Listener;
-        simple_combo(keys: string, on_keydown_callback: (event?: KeyboardEvent, count?: number) => any): void;
-        counting_combo(keys: string, on_count_callback: (event?: KeyboardEvent, count?: number) => any): void;
-        sequence_combo(keys: string, callback: (event?: KeyboardEvent, count?: number) => any): void;
-        register_combo(combo: Combo): void;
-        unregister_combo(combo: Combo): void;
-        unregister_combo(keys: string): void;
-        register_many(combos: Combo[]): void;
-        unregister_many(combos: Combo[]): void;
-        unregister_many(keys: string[]): void;
-        get_registered_combos(): Combo[];
-        destroy(): void;
-        reset(): void;
-        listen(): void;
-        stop_listening(): void;
-    }
-
-    interface Keypress {
-        Listener: Listener;
-    }
-}
-
-interface Window {
-    keypress: Keypress.Keypress;
-}