@forge/manifest 4.2.1-next.1 → 4.3.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/manifest
 
+## 4.3.0-next.2
+
+### Minor Changes
+
+- 0871a3b: Added validation for Confluence keyboard shortcuts to disallow multiple non-modifier keys and enforce that modifier keys precede the main key being modified.
+
 ## 4.2.1-next.1
 
 ### Patch Changes

package/out/text/errors.d.ts

@@ -44,8 +44,10 @@ export declare const errors: {
                 emptyAccelerator: () => string;
                 spaceAroundAccelerator: (accelerator: string) => string;
                 invalidPlusSyntax: (accelerator: string) => string;
-                invalidAcceleratorCombination: (accelerator: string) => string;
+                combinationKeysAreNotUnique: (accelerator: string) => string;
                 invalidKey: (accelerator: string, key: string) => string;
+                moreThanOneNonModifierKey: (accelerator: string) => string;
+                modifierKeysShouldPrecedeNonModifierKey: (accelerator: string) => string;
             };
         };
         jiraWorkflowValidator: {

package/out/text/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/text/errors.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,MAAM;8BACS,MAAM,KAAG,MAAM;2BACpB,MAAM;yBAEN,MAAM,GAAG,SAAS,QAAQ,MAAM,EAAE,UAAU,MAAM,GAAG,SAAS,KAAG,MAAM;;uBAO3E,MAAM,EAAE,EAAE,GAAG,SAAS,KAAG,MAAM;4BAI1B,MAAM,EAAE,KAAG,MAAM;mCACV,MAAM,SAAS,MAAM,0CAA4B,MAAM;mDAIvC,MAAM,KAAG,MAAM;;;qCAI7B,MAAM,SAAS,MAAM,KAAG,MAAM;4CAEvB,MAAM,SAAS,MAAM,KAAG,MAAM;wCAElC,MAAM,SAAS,MAAM,EAAE,KAAG,MAAM;;;uCAMjC,MAAM,KAAG,MAAM;oCACpB,MAAM;iCAEP,MAAM,KAAG,MAAM;4CACJ,MAAM,KAAG,MAAM;;;gCAG3B,MAAM,KAAG,MAAM;6BACpB,MAAM;+BACJ,MAAM;iCACF,MAAM,KAAG,MAAM;yCACP,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;6CAEhC,MAAM,KAAG,MAAM;;yCAGrB,MAAM,KAAG,MAAM;iCAEvB,MAAM,KAAG,MAAM;4CACJ,MAAM,gBAAgB,MAAM,KAAG,MAAM;sCAE3C,MAAM,gBAAgB,MAAM,gBAAgB,MAAM,KAAG,MAAM;;;yCAIxD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;2CAIhD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;sDAEvC,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;8DAEvB,MAAM,aAAa,MAAM,cAAc,MAAM,KAAG,MAAM;6EAEvC,MAAM,qBAAqB,MAAM,KAAG,MAAM;yEAE9C,MAAM,qBAAqB,MAAM,KAAG,MAAM;;wCAG/E,MAAM;sDACU,MAAM,KAAG,MAAM;iDAEpB,MAAM,KAAG,MAAM;6DAEH,MAAM,KAAG,MAAM;0CAElC,MAAM,OAAO,MAAM,KAAG,MAAM;;;;mCAKjC,MAAM,KAAG,MAAM;mCAEf,MAAM,KAAG,MAAM;;;qCAIb,MAAM,KAAG,MAAM;;;0CAIV,MAAM,KAAG,MAAM;;;mCAItB,MAAM,EAAE,KAAG,MAAM;;;qCAIf,MAAM,KAAG,MAAM;2CAET,MAAM,KAAG,MAAM;;;oCAGtB,MAAM,KAAG,MAAM;;oCAEjB,MAAM,SAAS,MAAM,KAAG,MAAM;qCAI7B,MAAM,YAAY,MAAM,KAAG,MAAM;;;;;mCAQ/B,MAAM,OAAO,MAAM,KAAG,MAAM;iCAE9B,MAAM,OAAO,MAAM,KAAG,MAAM;oCAEzB,MAAM,OAAO,MAAM,KAAG,MAAM;gDAEhB,MAAM,KAAG,MAAM;uCAExB,MAAM,KAAG,MAAM;;;;;;;;kCAQpB,MAAM,UAAU,MAAM,KAAG,MAAM;gCAEjC,MAAM,KAAG,MAAM;2CAEJ,MAAM,eAAe,MAAM,KAAG,MAAM;;;uCAI1C,MAAM;uCAEJ,MAAM,KAAG,MAAM;qCAEnB,MAAM;;CAGpC,CAAC;AAEF,oBAAY,UAAU;IACpB,eAAe,2BAA2B;IAC1C,eAAe,wBAAwB;IACvC,WAAW,4BAA4B;IACvC,WAAW,+BAA+B;IAC1C,aAAa,8BAA8B;IAC3C,OAAO,0BAA0B;IACjC,cAAc,kCAAkC;IAChD,mBAAmB,0BAA0B;IAC7C,SAAS,4BAA4B;IACrC,SAAS,4BAA4B;IACrC,UAAU,wBAAwB;IAClC,GAAG,8BAA8B;CAClC"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/text/errors.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,MAAM;8BACS,MAAM,KAAG,MAAM;2BACpB,MAAM;yBAEN,MAAM,GAAG,SAAS,QAAQ,MAAM,EAAE,UAAU,MAAM,GAAG,SAAS,KAAG,MAAM;;uBAO3E,MAAM,EAAE,EAAE,GAAG,SAAS,KAAG,MAAM;4BAI1B,MAAM,EAAE,KAAG,MAAM;mCACV,MAAM,SAAS,MAAM,0CAA4B,MAAM;mDAIvC,MAAM,KAAG,MAAM;;;qCAI7B,MAAM,SAAS,MAAM,KAAG,MAAM;4CAEvB,MAAM,SAAS,MAAM,KAAG,MAAM;wCAElC,MAAM,SAAS,MAAM,EAAE,KAAG,MAAM;;;uCAMjC,MAAM,KAAG,MAAM;oCACpB,MAAM;iCAEP,MAAM,KAAG,MAAM;4CACJ,MAAM,KAAG,MAAM;;;gCAG3B,MAAM,KAAG,MAAM;6BACpB,MAAM;+BACJ,MAAM;iCACF,MAAM,KAAG,MAAM;yCACP,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;6CAEhC,MAAM,KAAG,MAAM;;yCAGrB,MAAM,KAAG,MAAM;iCAEvB,MAAM,KAAG,MAAM;4CACJ,MAAM,gBAAgB,MAAM,KAAG,MAAM;sCAE3C,MAAM,gBAAgB,MAAM,gBAAgB,MAAM,KAAG,MAAM;;;yCAIxD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;2CAIhD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;sDAEvC,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;8DAEvB,MAAM,aAAa,MAAM,cAAc,MAAM,KAAG,MAAM;6EAEvC,MAAM,qBAAqB,MAAM,KAAG,MAAM;yEAE9C,MAAM,qBAAqB,MAAM,KAAG,MAAM;;wCAG/E,MAAM;sDACU,MAAM,KAAG,MAAM;iDAEpB,MAAM,KAAG,MAAM;2DAEL,MAAM,KAAG,MAAM;0CAEhC,MAAM,OAAO,MAAM,KAAG,MAAM;yDAEb,MAAM,KAAG,MAAM;uEAED,MAAM,KAAG,MAAM;;;;mCAKjD,MAAM,KAAG,MAAM;mCAEf,MAAM,KAAG,MAAM;;;qCAIb,MAAM,KAAG,MAAM;;;0CAIV,MAAM,KAAG,MAAM;;;mCAItB,MAAM,EAAE,KAAG,MAAM;;;qCAIf,MAAM,KAAG,MAAM;2CAET,MAAM,KAAG,MAAM;;;oCAGtB,MAAM,KAAG,MAAM;;oCAEjB,MAAM,SAAS,MAAM,KAAG,MAAM;qCAI7B,MAAM,YAAY,MAAM,KAAG,MAAM;;;;;mCAQ/B,MAAM,OAAO,MAAM,KAAG,MAAM;iCAE9B,MAAM,OAAO,MAAM,KAAG,MAAM;oCAEzB,MAAM,OAAO,MAAM,KAAG,MAAM;gDAEhB,MAAM,KAAG,MAAM;uCAExB,MAAM,KAAG,MAAM;;;;;;;;kCAQpB,MAAM,UAAU,MAAM,KAAG,MAAM;gCAEjC,MAAM,KAAG,MAAM;2CAEJ,MAAM,eAAe,MAAM,KAAG,MAAM;;;uCAI1C,MAAM;uCAEJ,MAAM,KAAG,MAAM;qCAEnB,MAAM;;CAGpC,CAAC;AAEF,oBAAY,UAAU;IACpB,eAAe,2BAA2B;IAC1C,eAAe,wBAAwB;IACvC,WAAW,4BAA4B;IACvC,WAAW,+BAA+B;IAC1C,aAAa,8BAA8B;IAC3C,OAAO,0BAA0B;IACjC,cAAc,kCAAkC;IAChD,mBAAmB,0BAA0B;IAC7C,SAAS,4BAA4B;IACrC,SAAS,4BAA4B;IACrC,UAAU,wBAAwB;IAClC,GAAG,8BAA8B;CAClC"}

package/out/text/errors.js

@@ -56,8 +56,10 @@ exports.errors = {
                 emptyAccelerator: () => 'Keyboard shortcut accelerator must be defined and not be an empty string.',
                 spaceAroundAccelerator: (accelerator) => `Keyboard shortcut accelerator must not have surrounding empty spaces. Accelerator issue found: [${accelerator}]`,
                 invalidPlusSyntax: (accelerator) => `Keyboard shortcut accelerator must not be single "+" character or have empty spaces on left or right of "+" character. Accelerator issue found: [${accelerator}]`,
-                invalidAcceleratorCombination: (accelerator) => `Keyboard shortcut accelerator combinations must have unique keys when joined with "+". Accelerator issue found: [${accelerator}]`,
-                invalidKey: (accelerator, key) => `Keyboard shortcut accelerator key must be a valid named key, i.e. ctrl, command, or a single key. Accelerator issue found: [${accelerator}] with invalid key: [${key}]`
+                combinationKeysAreNotUnique: (accelerator) => `Keyboard shortcut accelerator combinations must have unique keys when joined with "+". Accelerator issue found: [${accelerator}]`,
+                invalidKey: (accelerator, key) => `Keyboard shortcut accelerator key must be a valid named key, i.e. ctrl, command, or a single key. Accelerator issue found: [${accelerator}] with invalid key: [${key}]`,
+                moreThanOneNonModifierKey: (accelerator) => `Keyboard shortcut accelerator combination is invalid. A valid accelerator combination should have a single key or a single key preceeded with one or more modifiers, i.e. ctrl, shift, command. Accelerator issue found: [${accelerator}]`,
+                modifierKeysShouldPrecedeNonModifierKey: (accelerator) => `Keyboard shortcut accelerator modifier keys should precede the key being modified. Instead of "a+ctrl", one should specify the accelerator as "ctrl+a". Accelerator issue found: [${accelerator}]`
             }
         },
         jiraWorkflowValidator: {

package/out/validators/modules-validators/confluence/validateKeyboardShortcuts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validateKeyboardShortcuts.d.ts","sourceRoot":"","sources":["../../../../src/validators/modules-validators/confluence/validateKeyboardShortcuts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGjD,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAwHnD,eAAO,MAAM,yBAAyB,eAAgB,OAAO,+CAAiC,eAAe,EAwB5G,CAAC"}
+{"version":3,"file":"validateKeyboardShortcuts.d.ts","sourceRoot":"","sources":["../../../../src/validators/modules-validators/confluence/validateKeyboardShortcuts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGjD,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAuJnD,eAAO,MAAM,yBAAyB,eAAgB,OAAO,+CAAiC,eAAe,EAwB5G,CAAC"}

package/out/validators/modules-validators/confluence/validateKeyboardShortcuts.js

@@ -5,7 +5,8 @@ const text_1 = require("../../../text");
 const utils_1 = require("../../../utils");
 const VALID_SINGLE_KEY = new RegExp(/^[^+ ]$/);
 const INVALID_COMBINATION_SYNTAX = new RegExp(/(^\+$| \+|\+ )/);
-const VALID_NAMED_KEYS = new Set([
+const MODIFIER_KEYS = new Set(['shift', 'ctrl', 'alt', 'option', 'meta', 'command', 'mod']);
+const SPECIAL_KEYS = new Set([
     'f1',
     'f2',
     'f3',
@@ -18,13 +19,6 @@ const VALID_NAMED_KEYS = new Set([
     'f10',
     'f11',
     'f12',
-    'shift',
-    'ctrl',
-    'alt',
-    'option',
-    'meta',
-    'command',
-    'mod',
     'backspace',
     'tab',
     'enter',
@@ -45,51 +39,68 @@ const VALID_NAMED_KEYS = new Set([
     'space',
     'plus'
 ]);
+const VALID_NAMED_KEYS = new Set([...MODIFIER_KEYS, ...SPECIAL_KEYS]);
+const errorMessages = text_1.errors.modules.confluence.keyboardShortcuts;
 const isValidKey = (key) => VALID_NAMED_KEYS.has(key) || !!key.match(VALID_SINGLE_KEY);
-const validateShortcut = (moduleKey, accelerator) => {
-    const keyboardShortcutErrors = [];
+const mapToKeyboardShortcutError = (validationErrors, moduleKey) => validationErrors.map((message) => ({ moduleKey, message }));
+const validateWhitespaceAndSyntax = (accelerator) => {
+    const validationErrors = [];
     if (!accelerator || accelerator.trim() === '') {
-        keyboardShortcutErrors.push({
-            moduleKey,
-            message: text_1.errors.modules.confluence.keyboardShortcuts.emptyAccelerator()
-        });
-        return keyboardShortcutErrors;
+        validationErrors.push(errorMessages.emptyAccelerator());
     }
     else if (accelerator.startsWith(' ') || accelerator.endsWith(' ')) {
-        keyboardShortcutErrors.push({
-            moduleKey,
-            message: text_1.errors.modules.confluence.keyboardShortcuts.spaceAroundAccelerator(accelerator)
-        });
-        return keyboardShortcutErrors;
+        validationErrors.push(errorMessages.spaceAroundAccelerator(accelerator));
     }
     else if (accelerator.match(INVALID_COMBINATION_SYNTAX)) {
-        keyboardShortcutErrors.push({
-            moduleKey,
-            message: text_1.errors.modules.confluence.keyboardShortcuts.invalidPlusSyntax(accelerator)
-        });
-        return keyboardShortcutErrors;
+        validationErrors.push(errorMessages.invalidPlusSyntax(accelerator));
+    }
+    return validationErrors;
+};
+const modifierKeysPrecedeNonModifierKey = (modifierKeys, nonModifierKeys, keys) => {
+    if (modifierKeys.length && nonModifierKeys.length) {
+        const indexOfNonModifierKey = keys.indexOf(nonModifierKeys[0]);
+        const indexOfLastKey = keys.length - 1;
+        return indexOfNonModifierKey === indexOfLastKey;
+    }
+    return true;
+};
+const validateModifierKeys = (accelerator, keys) => {
+    const validationErrors = [];
+    const nonModifierKeys = keys.filter((key) => !MODIFIER_KEYS.has(key));
+    if (nonModifierKeys.length > 1) {
+        validationErrors.push(errorMessages.moreThanOneNonModifierKey(accelerator));
     }
+    const modifierKeys = keys.filter((key) => MODIFIER_KEYS.has(key));
+    if (!modifierKeysPrecedeNonModifierKey(modifierKeys, nonModifierKeys, keys)) {
+        validationErrors.push(errorMessages.modifierKeysShouldPrecedeNonModifierKey(accelerator));
+    }
+    return validationErrors;
+};
+const validateKeyCombinationsAndSequences = (accelerator) => {
+    const validationErrors = [];
     const sequence = accelerator.split(' ');
     for (const combination of sequence) {
         const keys = combination.split('+');
         const uniqueKeys = new Set(keys);
         const allDifferent = keys.length === uniqueKeys.size;
         if (!allDifferent) {
-            keyboardShortcutErrors.push({
-                moduleKey,
-                message: text_1.errors.modules.confluence.keyboardShortcuts.invalidAcceleratorCombination(accelerator)
-            });
+            validationErrors.push(errorMessages.combinationKeysAreNotUnique(accelerator));
         }
+        validationErrors.push(...validateModifierKeys(accelerator, [...uniqueKeys]));
         for (const key of keys) {
             if (!isValidKey(key)) {
-                keyboardShortcutErrors.push({
-                    moduleKey,
-                    message: text_1.errors.modules.confluence.keyboardShortcuts.invalidKey(accelerator, key)
-                });
+                validationErrors.push(errorMessages.invalidKey(accelerator, key));
             }
         }
     }
-    return keyboardShortcutErrors;
+    return validationErrors;
+};
+const validateShortcut = (moduleKey, accelerator) => {
+    const whitespaceAndSyntaxErrors = validateWhitespaceAndSyntax(accelerator);
+    if (whitespaceAndSyntaxErrors.length) {
+        return mapToKeyboardShortcutError(whitespaceAndSyntaxErrors, moduleKey);
+    }
+    return mapToKeyboardShortcutError(validateKeyCombinationsAndSequences(accelerator), moduleKey);
 };
 exports.validateKeyboardShortcuts = (allModules, yamlContentByLine) => {
     const validationErrors = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/manifest",
-  "version": "4.2.1-next.1",
+  "version": "4.3.0-next.2",
   "description": "Definitions and validations of the Forge manifest",
   "main": "out/index.js",
   "scripts": {