@reecelucas/react-use-hotkeys - npm Package Compare versions

Comparing version 1.3.4 to 1.3.5

esm/helpers/arraysAreEqual.d.ts

@@ -8,3 +8,3 @@ /**
  */
-declare const _default: (arr1: any[], arr2: any[]) => boolean;
+declare const _default: (arr1: string[], arr2: string[]) => boolean;
 export default _default;

esm/helpers/getActiveModifierKeys.js

 export default (function (event) {
     var modifiers = [];
     if (event.ctrlKey) {
-        modifiers.push('ctrlKey');
+        modifiers.push("ctrlKey");
     }
     if (event.shiftKey) {
-        modifiers.push('shiftKey');
+        modifiers.push("shiftKey");
     }
     if (event.altKey) {
-        modifiers.push('altKey');
+        modifiers.push("altKey");
     }
     if (event.metaKey) {
-        modifiers.push('metaKey');
+        modifiers.push("metaKey");
     }
     return modifiers;
 });

esm/helpers/getHotkeysArray.js

@@ -16,7 +16,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     }
-    if (hkeys.includes('+')) {
+    if (hkeys.includes("+")) {
         // We're dealing with a modifier-key combination. The `/\b\+/g` regex
         // matches the first `+` at the end of each word, allowing combinations including `+`,
         // E.g. `Shift++`. We can't use a negative lookbehind because of lack of support.
-        return hkeys.replace(/\s+/g, '').split(/\b\+/g);
+        return hkeys.replace(/\s+/g, "").split(/\b\+/g);
     }
@@ -29,4 +29,4 @@ /**
     return __spreadArray([], (hkeys.match(/[^\s"']+|"([^"]*)"|'([^']*)'/g) || []), true).map(function (key) {
-        return key.replace(/("|').*?("|')/, ' ');
+        return key.replace(/("|').*?("|')/, " ");
     });
 });

esm/helpers/isSameSet.d.ts

@@ -7,3 +7,3 @@ /**
  */
-declare const _default: (arr1: any[], arr2: any[]) => boolean;
+declare const _default: (arr1: string[], arr2: string[]) => boolean;
 export default _default;

esm/helpers/mapModifierKeys.js

 var modifierKeyMap = {
-    control: 'ctrlKey',
-    shift: 'shiftKey',
-    alt: 'altKey',
-    meta: 'metaKey'
+    control: "ctrlKey",
+    shift: "shiftKey",
+    alt: "altKey",
+    meta: "metaKey",
 };
 export default (function (keys) { return keys.map(function (k) { return modifierKeyMap[k]; }); });

esm/helpers/tail.d.ts

@@ -1,2 +0,2 @@
-declare const _default: (arr: any[]) => any;
+declare const _default: (arr: string[]) => string;
 export default _default;

esm/helpers/takeUntilLast.d.ts

@@ -1,2 +0,2 @@
-declare const _default: (arr: any[]) => any[];
+declare const _default: (arr: string[]) => string[];
 export default _default;

esm/index.d.ts

@@ -1,3 +0,3 @@
-import './vendor/shim-keyboard-event-key';
+import "./vendor/shim-keyboard-event-key";
 declare const useHotkeys: (hotkeys: string | string[], callback: (event: KeyboardEvent) => void, eventListenerOptions?: boolean | AddEventListenerOptions) => void;
 export default useHotkeys;

esm/index.js

@@ -1,13 +0,13 @@
-import { useEffect, useMemo } from 'react';
-import arraysAreEqual from './helpers/arraysAreEqual';
-import getActiveModifierKeys from './helpers/getActiveModifierKeys';
-import getHotkeysArray from './helpers/getHotkeysArray';
-import isSameSet from './helpers/isSameSet';
-import mapModifierKeys from './helpers/mapModifierKeys';
-import modifierKeyPressed from './helpers/modifierKeyPressed';
-import tail from './helpers/tail';
-import takeUntilLast from './helpers/takeUntilLast';
-import './vendor/shim-keyboard-event-key';
+import { useEffect, useMemo } from "react";
+import arraysAreEqual from "./helpers/arraysAreEqual";
+import getActiveModifierKeys from "./helpers/getActiveModifierKeys";
+import getHotkeysArray from "./helpers/getHotkeysArray";
+import isSameSet from "./helpers/isSameSet";
+import mapModifierKeys from "./helpers/mapModifierKeys";
+import modifierKeyPressed from "./helpers/modifierKeyPressed";
+import tail from "./helpers/tail";
+import takeUntilLast from "./helpers/takeUntilLast";
+import "./vendor/shim-keyboard-event-key";
 var KEY_SEQUENCE_TIMEOUT = 1000;
-var ESCAPE_HATCH_KEY = '*';
+var ESCAPE_HATCH_KEY = "*";
 var useHotkeys = function (hotkeys, callback, eventListenerOptions) {
@@ -84,5 +84,5 @@ var hotkeysArray = useMemo(function () {
         };
-        window.addEventListener('keydown', onKeydown, eventListenerOptions);
+        window.addEventListener("keydown", onKeydown, eventListenerOptions);
         return function () {
-            window.removeEventListener('keydown', onKeydown, eventListenerOptions);
+            window.removeEventListener("keydown", onKeydown, eventListenerOptions);
         };
@@ -89,0 +89,0 @@ }, [hotkeysArray, callback, eventListenerOptions]);

lib/helpers/arraysAreEqual.d.ts

@@ -8,3 +8,3 @@ /**
  */
-declare const _default: (arr1: any[], arr2: any[]) => boolean;
+declare const _default: (arr1: string[], arr2: string[]) => boolean;
 export default _default;

lib/helpers/getActiveModifierKeys.js

@@ -6,14 +6,14 @@ "use strict";
     if (event.ctrlKey) {
-        modifiers.push('ctrlKey');
+        modifiers.push("ctrlKey");
     }
     if (event.shiftKey) {
-        modifiers.push('shiftKey');
+        modifiers.push("shiftKey");
     }
     if (event.altKey) {
-        modifiers.push('altKey');
+        modifiers.push("altKey");
     }
     if (event.metaKey) {
-        modifiers.push('metaKey');
+        modifiers.push("metaKey");
     }
     return modifiers;
 });

lib/helpers/getHotkeysArray.js

@@ -18,7 +18,7 @@ "use strict";
     }
-    if (hkeys.includes('+')) {
+    if (hkeys.includes("+")) {
         // We're dealing with a modifier-key combination. The `/\b\+/g` regex
         // matches the first `+` at the end of each word, allowing combinations including `+`,
         // E.g. `Shift++`. We can't use a negative lookbehind because of lack of support.
-        return hkeys.replace(/\s+/g, '').split(/\b\+/g);
+        return hkeys.replace(/\s+/g, "").split(/\b\+/g);
     }
@@ -31,4 +31,4 @@ /**
     return __spreadArray([], (hkeys.match(/[^\s"']+|"([^"]*)"|'([^']*)'/g) || []), true).map(function (key) {
-        return key.replace(/("|').*?("|')/, ' ');
+        return key.replace(/("|').*?("|')/, " ");
     });
 });

lib/helpers/isSameSet.d.ts

@@ -7,3 +7,3 @@ /**
  */
-declare const _default: (arr1: any[], arr2: any[]) => boolean;
+declare const _default: (arr1: string[], arr2: string[]) => boolean;
 export default _default;

lib/helpers/mapModifierKeys.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var modifierKeyMap = {
-    control: 'ctrlKey',
-    shift: 'shiftKey',
-    alt: 'altKey',
-    meta: 'metaKey'
+    control: "ctrlKey",
+    shift: "shiftKey",
+    alt: "altKey",
+    meta: "metaKey",
 };
 exports.default = (function (keys) { return keys.map(function (k) { return modifierKeyMap[k]; }); });

lib/helpers/tail.d.ts

@@ -1,2 +0,2 @@
-declare const _default: (arr: any[]) => any;
+declare const _default: (arr: string[]) => string;
 export default _default;

lib/helpers/takeUntilLast.d.ts

@@ -1,2 +0,2 @@
-declare const _default: (arr: any[]) => any[];
+declare const _default: (arr: string[]) => string[];
 export default _default;

lib/index.d.ts

@@ -1,3 +0,3 @@
-import './vendor/shim-keyboard-event-key';
+import "./vendor/shim-keyboard-event-key";
 declare const useHotkeys: (hotkeys: string | string[], callback: (event: KeyboardEvent) => void, eventListenerOptions?: boolean | AddEventListenerOptions) => void;
 export default useHotkeys;

lib/index.js

@@ -14,3 +14,3 @@ "use strict";
 var KEY_SEQUENCE_TIMEOUT = 1000;
-var ESCAPE_HATCH_KEY = '*';
+var ESCAPE_HATCH_KEY = "*";
 var useHotkeys = function (hotkeys, callback, eventListenerOptions) {
@@ -87,5 +87,5 @@ var hotkeysArray = (0, react_1.useMemo)(function () {
         };
-        window.addEventListener('keydown', onKeydown, eventListenerOptions);
+        window.addEventListener("keydown", onKeydown, eventListenerOptions);
         return function () {
-            window.removeEventListener('keydown', onKeydown, eventListenerOptions);
+            window.removeEventListener("keydown", onKeydown, eventListenerOptions);
         };
@@ -92,0 +92,0 @@ }, [hotkeysArray, callback, eventListenerOptions]);

package.json

 {
   "name": "@reecelucas/react-use-hotkeys",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "React hook to create keyboard shortcuts",
@@ -12,8 +12,7 @@ "main": "lib/index.js",
   "scripts": {
-    "start": "yarn storybook",
-    "storybook": "start-storybook -p 8000",
-    "test": "jest src/__tests__/ --testPathIgnorePatterns src/__tests__/helpers",
-    "test:cover": "yarn test --coverage --collectCoverageFrom=\"src/index.ts\"",
+    "start": "start-storybook -p 6006",
+    "test": "jest",
+    "test:cover": "jest --coverage",
     "coveralls": "cat coverage/lcov.info | node node_modules/.bin/coveralls",
-    "lint": "tslint \"src/**/*.{ts,tsx}\"",
+    "lint": "eslint \"src/**/*.{ts,tsx}\" && prettier --check \"src/**/*.{ts,tsx}\"",
     "format": "prettier --write \"src/**/*.{ts,tsx}\"",
@@ -23,3 +22,4 @@ "build:cjs": "tsc",
     "build": "yarn build:cjs && yarn build:esm",
-    "prepublishOnly": "yarn lint && yarn test && yarn build"
+    "prepublishOnly": "yarn lint && yarn test && yarn build",
+    "prepare": "husky install"
   },
@@ -50,30 +50,29 @@ "repository": {
   "devDependencies": {
-    "@babel/core": "^7.4.3",
-    "@babel/preset-env": "^7.4.3",
-    "@babel/preset-react": "^7.0.0",
-    "@babel/preset-typescript": "^7.3.3",
-    "@storybook/addon-knobs": "^5.0.6",
-    "@storybook/addons": "^5.0.6",
-    "@storybook/react": "^5.0.6",
-    "@types/jest": "^24.0.11",
-    "@types/react": "^16.8.12",
-    "@types/storybook__addon-knobs": "^4.0.5",
-    "@types/storybook__react": "^4.0.1",
-    "babel-jest": "^24.7.1",
-    "babel-loader": "^8.0.5",
-    "coveralls": "^3.0.3",
-    "husky": "^1.3.1",
-    "jest": "^24.7.1",
-    "prettier": "^1.16.4",
-    "react-testing-library": "^6.0.4",
-    "tslint": "^5.15.0",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-react": "^4.0.0",
+    "@babel/core": "^7.18.13",
+    "@babel/preset-env": "^7.18.10",
+    "@babel/preset-react": "^7.18.6",
+    "@babel/preset-typescript": "^7.18.6",
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
+    "@storybook/builder-webpack4": "^6.5.10",
+    "@storybook/manager-webpack4": "^6.5.10",
+    "@storybook/react": "^6.5.10",
+    "@testing-library/react": "^13.3.0",
+    "@types/jest": "^29.0.0",
+    "@types/react": "^18.0.18",
+    "@typescript-eslint/eslint-plugin": "^5.36.1",
+    "@typescript-eslint/parser": "^5.36.1",
+    "babel-jest": "^29.0.1",
+    "babel-loader": "^8.2.5",
+    "coveralls": "^3.1.1",
+    "eslint": "^8.23.0",
+    "eslint-config-prettier": "^8.5.0",
+    "husky": "^8.0.1",
+    "jest": "^29.0.1",
+    "jest-environment-jsdom": "^29.0.1",
+    "prettier": "^2.7.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "typescript": "^4.8.2"
-  },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn lint && yarn format && yarn test"
-    }
   }
 }

No alert changes

Worsened metrics

Total package byte prevSize

24761

decreased by-3.69%

Dev dependency count

26

increased by18.18%

Number of package files

43

decreased by-4.44%

Lines of code

486

decreased by-7.43%

No dependency changes