@witchcraft/spellcraft 0.2.0 → 0.2.1

package/dist/core/createManager.js

@@ -51,7 +51,7 @@ export function createManager(rawManager, additionalOpts = {}) {
   if (!shortcuts || isArray(shortcuts)) {
     castType(shortcuts);
     const shortcutsList = [];
-    const m2 = { ...m, commands, keys };
+    const m2 = { ...m, commands, keys, context: rawManager.context };
     if (shortcuts) {
       for (const shortcut of shortcuts) {
         const res2 = createShortcut(shortcut, m2);
@@ -62,7 +62,8 @@ export function createManager(rawManager, additionalOpts = {}) {
     const res = createShortcuts(shortcutsList, {
       keys,
       commands,
-      options
+      options,
+      context: rawManager.context
     }, additionalOpts?.shortcuts);
     if (res.isError) return res;
     shortcuts = res.value;

package/dist/core/createShortcuts.d.ts

@@ -6,7 +6,7 @@ import type { CanHookErrors, Manager, MultipleErrors, PickManager, Shortcut, Sho
  * Creates a set of shortcuts.
  *
  */
-export declare function createShortcuts<THooks extends Manager["hooks"], TRawShortcuts extends Shortcut[], TCheck extends boolean | "only" = true>(shortcutsList: TRawShortcuts, manager: Pick<Manager, "keys" | "commands"> & PickManager<"options", "evaluateCondition" | "conditionEquals" | "stringifier" | "sorter" | "shortcutEqualityStrategy"> & {
+export declare function createShortcuts<THooks extends Manager["hooks"], TRawShortcuts extends Shortcut[], TCheck extends boolean | "only" = true>(shortcutsList: TRawShortcuts, manager: Pick<Manager, "keys" | "commands" | "context"> & PickManager<"options", "evaluateCondition" | "conditionEquals" | "stringifier" | "sorter" | "shortcutEqualityStrategy"> & {
     hooks?: THooks;
 }, opts?: Partial<Pick<Shortcuts, "ignoreModifierConflicts" | "ignoreChainConflicts">>, { check }?: {
     check?: boolean | "only";

package/dist/helpers/doesShortcutConflict.js

@@ -16,15 +16,27 @@ export function doesShortcutConflict(shortcutA, shortcutB, manager) {
   if (equalsShortcut(shortcutA, shortcutB, manager)) return true;
   const evaluateCondition = manager.options.evaluateCondition;
   const conditionEquals = manager.options.conditionEquals;
+  const commandA = shortcutA.command ? manager.commands.entries[shortcutA.command] : void 0;
+  const commandB = shortcutB.command ? manager.commands.entries[shortcutB.command] : void 0;
+  if ((shortcutA.condition || shortcutB.condition || commandA?.condition || commandB?.condition) && context === void 0) {
+    console.warn("Condition comparisons will not work without a context (the base conditionComparer is still used).");
+  }
   if (context) {
     if (shortcutA.condition && shortcutB.condition) {
       const shortcutCondition = evaluateCondition(shortcutA.condition, context);
       const otherCondition = evaluateCondition(shortcutB.condition, context);
-      if (shortcutCondition !== otherCondition) return false;
-      if (!shortcutCondition) return false;
+      if (!shortcutCondition || shortcutCondition !== otherCondition) return false;
+    }
+    if (commandA?.condition && commandB?.condition) {
+      const commandCondition = evaluateCondition(commandA.condition, context);
+      const otherCondition = evaluateCondition(commandB.condition, context);
+      if (!commandCondition || commandCondition !== otherCondition) return false;
     }
   } else {
     if (!conditionEquals(shortcutA.condition, shortcutB.condition, "shortcut")) return false;
+    if (commandA?.condition && commandB?.condition) {
+      if (!conditionEquals(commandA?.condition, commandB?.condition, "command")) return false;
+    }
   }
   const { keys } = manager;
   if (shortcutA.chain.length === 0 || shortcutB.chain.length === 0) {

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "witchcraftSpellcraft",
   "configKey": "witchcraftSpellcraft",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/runtime/utils/shortcutToId.d.ts

@@ -2,4 +2,4 @@ import type { PickManager } from "../../types/general.js";
 import type { Manager } from "../../types/manager.js";
 import type { Shortcut } from "../../types/shortcuts.js";
 /** Turns a shortcut into an id to use in a v-for loop. */
-export declare const shortcutToId: (shortcut: Shortcut, manager: PickManager<"options", "stringifier"> & Pick<Manager, "keys">) => string;
+export declare function shortcutToId(shortcut: Shortcut, manager: PickManager<"options", "stringifier"> & Pick<Manager, "keys">): string;

package/dist/runtime/utils/shortcutToId.js

@@ -1,6 +1,8 @@
-export const shortcutToId = (shortcut, manager) => [
-  shortcut.enabled,
-  manager.options.stringifier.stringify(shortcut.chain, manager),
-  shortcut.command ?? "",
-  shortcut.condition.text
-].join("--");
+export function shortcutToId(shortcut, manager) {
+  return [
+    shortcut.enabled,
+    manager.options.stringifier.stringify(shortcut.chain, manager),
+    shortcut.command ?? "",
+    shortcut.condition.text
+  ].join("--");
+}

package/dist/types/manager.d.ts

@@ -124,8 +124,9 @@ export type Manager<THooks extends Partial<Hooks> = Partial<Hooks>, TKeys extend
          *
          * - `ignoreCommand` (default) will ignore both shortcuts' commands. If everything else is equal, they are considered equal.
          * - `ignoreCommandWithDifferentCondition` will ignore both commands' names and only compare their conditions. If everything else is equal, they are considered equal. Use it if you allow command conditions to equal eachother. See {@link ConditionComparer} for details.
-         * - `all` will compare everything.
+         * - `all` will compare everything. Useful for finding an exact shortcut match. Should not be used when comparing shortcuts to find conflicts as it will allow shortcuts with the same chain but different commands to not be equal.
          *
+         * Note that regardless of this setting shortcut conflicts can arise for other reasons due to `doesShortcutConflict` which checks other conditions.
          */
         shortcutEqualityStrategy: "ignoreCommand" | "ignoreCommandWithDifferentCondition" | "all";
         /** Determines how conditions are evaluated. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@witchcraft/spellcraft",
   "description": "A shortcut manager library for handling ALL the shortcut needs of an application.",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "type": "module",
   "main": "./dist/core/index.js",
   "sideEffects": false,
@@ -40,7 +40,7 @@
   },
   "peerDependencies": {
     "@witchcraft/expressit": "^0.4.2",
-    "@witchcraft/ui": "^0.3.20"
+    "@witchcraft/ui": "^0.3.24"
   },
   "peerDependenciesMeta": {
     "@witchcraft/ui": {
@@ -53,7 +53,7 @@
   "dependencies": {
     "@alanscodelog/utils": "^6.0.2",
     "@witchcraft/expressit": "^0.4.2",
-    "@witchcraft/ui": "^0.3.20",
+    "@witchcraft/ui": "^0.3.24",
     "reka-ui": "^2.8.0",
     "vue": "^3.5.27"
   },

package/src/core/createManager.ts

@@ -175,7 +175,7 @@ export function createManager<
 	if (!shortcuts || isArray(shortcuts)) {
 		castType<RawShortcut[]>(shortcuts)
 		const shortcutsList: Shortcut[] = []
-		const m2 = { ...m, commands: commands as Commands, keys: keys as Keys }
+		const m2 = { ...m, commands: commands as Commands, keys: keys as Keys, context: rawManager.context! }
 		if (shortcuts) {
 			for (const shortcut of shortcuts) {
 				const res = createShortcut(shortcut, m2)
@@ -187,7 +187,8 @@ export function createManager<
 		const res = createShortcuts(shortcutsList, {
 			keys: keys! as Keys,
 			commands: commands! as Commands,
-			options
+			options,
+			context: rawManager.context!
 		}, additionalOpts?.shortcuts)
 		if (res.isError) return res as any
 		shortcuts = res.value satisfies Shortcuts as any

package/src/core/createShortcuts.ts

@@ -16,7 +16,7 @@ export function createShortcuts<
 	TCheck extends boolean | "only" = true
 >(
 	shortcutsList: TRawShortcuts,
-	manager: Pick<Manager, "keys" | "commands">
+	manager: Pick<Manager, "keys" | "commands" | "context">
 		& PickManager<"options", | "evaluateCondition" | "conditionEquals" | "stringifier" | "sorter" | "shortcutEqualityStrategy">
 		& { hooks?: THooks },
 	opts?: Partial<Pick<Shortcuts, "ignoreModifierConflicts" | "ignoreChainConflicts">>,

package/src/helpers/doesShortcutConflict.ts

@@ -39,15 +39,30 @@ export function doesShortcutConflict<TShortcut extends Shortcut>(
 	if (equalsShortcut(shortcutA, shortcutB, manager)) return true
 	const evaluateCondition = manager.options.evaluateCondition
 	const conditionEquals = manager.options.conditionEquals
+
+	const commandA = shortcutA.command ? manager.commands.entries[shortcutA.command] : undefined
+	const commandB = shortcutB.command ? manager.commands.entries[shortcutB.command] : undefined
+
+	if ((shortcutA.condition || shortcutB.condition || commandA?.condition || commandB?.condition) && context === undefined) {
+		// eslint-disable-next-line no-console
+		console.warn("Condition comparisons will not work without a context (the base conditionComparer is still used).")
+	}
 	if (context) {
 		if (shortcutA.condition && shortcutB.condition) {
 			const shortcutCondition = evaluateCondition(shortcutA.condition, context)
 			const otherCondition = evaluateCondition(shortcutB.condition, context)
-			if (shortcutCondition !== otherCondition) return false
-			if (!shortcutCondition) return false
+			if (!shortcutCondition || shortcutCondition !== otherCondition) return false
+		}
+		if (commandA?.condition && commandB?.condition) {
+			const commandCondition = evaluateCondition(commandA.condition, context)
+			const otherCondition = evaluateCondition(commandB.condition, context)
+			if (!commandCondition || commandCondition !== otherCondition) return false
 		}
 	} else {
 		if	(!conditionEquals(shortcutA.condition, shortcutB.condition, "shortcut")) return false
+		if (commandA?.condition && commandB?.condition) {
+			if (!conditionEquals(commandA?.condition, commandB?.condition, "command")) return false
+		}
 	}
 	const { keys } = manager
 	// an empty chain is always in conflict ?

package/src/runtime/utils/shortcutToId.ts

@@ -3,12 +3,14 @@ import type { Manager } from "../../types/manager.js"
 import type { Shortcut } from "../../types/shortcuts.js"
 
 /** Turns a shortcut into an id to use in a v-for loop. */
-export const shortcutToId = (
+export function shortcutToId(
 	shortcut: Shortcut,
 	manager: PickManager<"options", "stringifier"> & Pick<Manager, "keys">
-): string => [
-	shortcut.enabled,
-	manager.options.stringifier.stringify(shortcut.chain, manager),
-	shortcut.command ?? "",
-	shortcut.condition.text
-].join("--")
+): string {
+	return [
+		shortcut.enabled,
+		manager.options.stringifier.stringify(shortcut.chain, manager),
+		shortcut.command ?? "",
+		shortcut.condition.text
+	].join("--")
+}

package/src/types/manager.ts

@@ -222,8 +222,9 @@ export type Manager<
 		 *
 		 * - `ignoreCommand` (default) will ignore both shortcuts' commands. If everything else is equal, they are considered equal.
 		 * - `ignoreCommandWithDifferentCondition` will ignore both commands' names and only compare their conditions. If everything else is equal, they are considered equal. Use it if you allow command conditions to equal eachother. See {@link ConditionComparer} for details.
-		 * - `all` will compare everything.
+		 * - `all` will compare everything. Useful for finding an exact shortcut match. Should not be used when comparing shortcuts to find conflicts as it will allow shortcuts with the same chain but different commands to not be equal.
 		 *
+		 * Note that regardless of this setting shortcut conflicts can arise for other reasons due to `doesShortcutConflict` which checks other conditions.
 		 */
 		shortcutEqualityStrategy: "ignoreCommand" | "ignoreCommandWithDifferentCondition" | "all"