@violetflux/eslint-plugin-kerros 0.2.4 → 0.3.0

package/dist/index.cjs

@@ -80,6 +80,7 @@ function getTypeServices(context) {
 //#region src/internal/kerros-types.ts
 const markerNames = {
 	externalStoreProvider: "externalStoreProviderMarker",
+	storeGetter: "storeGetterMarker",
 	storeHook: "storeHookMarker",
 	storeInstanceHook: "storeInstanceHookMarker"
 };
@@ -177,11 +178,11 @@ function createKerrosProgramTools(program) {
 		const returnType = checker.getReturnTypeOfSignature(signature);
 		const hookType = getTupleMemberType(returnType, 0, node);
 		if (!hookType || !hasMarker(hookType, "storeHook")) return void 0;
-		const instanceType = getTupleMemberType(returnType, 2, node);
-		if (name === "createStore" && !instanceType) return "createStore";
-		if (name !== "bindStore" || !instanceType) return void 0;
+		const thirdType = getTupleMemberType(returnType, 2, node);
+		if (name === "createStore") return !thirdType || hasMarker(thirdType, "storeGetter") ? "createStore" : void 0;
+		if (name !== "bindStore" || !thirdType) return void 0;
 		const providerType = getTupleMemberType(returnType, 1, node);
-		return providerType && hasMarker(providerType, "externalStoreProvider") && hasMarker(instanceType, "storeInstanceHook") ? "bindStore" : void 0;
+		return providerType && hasMarker(providerType, "externalStoreProvider") && hasMarker(thirdType, "storeInstanceHook") ? "bindStore" : void 0;
 	};
 	/** Test whether a call invokes a nominal Kerros Store Hook. */
 	const isStoreHookCall = (node) => {
@@ -301,10 +302,11 @@ const bindingNaming = createRule({
 	name: "binding-naming",
 	meta: {
 		type: "problem",
-		docs: { description: "Keep Kerros Hook and Provider binding names aligned." },
+		docs: { description: "Keep Kerros Hook, Provider, and getter binding names aligned." },
 		schema: [],
 		messages: {
 			destructureBinding: "Kerros factory results must be destructured.",
+			getterName: "The Store getter must be named getXxx.",
 			hookName: "The Store Hook must be named useXxx.",
 			providerName: "The Provider name must match the Store Hook.",
 			instanceName: "The instance Hook name must match the Store Hook."
@@ -334,12 +336,12 @@ const bindingNaming = createRule({
 			}
 			const hook = getElement(declarator.id, 0);
 			const provider = getElement(declarator.id, 1);
-			const instance = getElement(declarator.id, 2);
+			const third = getElement(declarator.id, 2);
 			const explicitName = kind === "createStore" ? getCreateStoreName(node) : getBindStoreName(node);
 			const hookMatch = hook && /^use(?<name>[A-Z][A-Za-z0-9]*)$/u.exec(hook.name);
 			const providerMatch = provider && /^(?<name>[A-Z][A-Za-z0-9]*)Provider$/u.exec(provider.name);
-			const instanceMatch = instance && /^use(?<name>[A-Z][A-Za-z0-9]*)Instance$/u.exec(instance.name);
-			const inferredName = hookMatch?.groups?.name ?? providerMatch?.groups?.name ?? instanceMatch?.groups?.name;
+			const thirdMatch = third && (kind === "createStore" ? /^get(?<name>[A-Z][A-Za-z0-9]*)$/u.exec(third.name) : /^use(?<name>[A-Z][A-Za-z0-9]*)Instance$/u.exec(third.name));
+			const inferredName = hookMatch?.groups?.name ?? providerMatch?.groups?.name ?? thirdMatch?.groups?.name;
 			const name = explicitName ?? inferredName;
 			if (hook && (!hookMatch || name && hookMatch.groups?.name !== name)) context.report({
 				node: hook,
@@ -349,9 +351,9 @@ const bindingNaming = createRule({
 				node: provider,
 				messageId: "providerName"
 			});
-			if (instance && (!instanceMatch || name && instanceMatch.groups?.name !== name)) context.report({
-				node: instance,
-				messageId: "instanceName"
+			if (third && (!thirdMatch || name && thirdMatch.groups?.name !== name)) context.report({
+				node: third,
+				messageId: kind === "createStore" ? "getterName" : "instanceName"
 			});
 		} };
 	}
@@ -2449,7 +2451,7 @@ const rules = {
 const plugin = {
 	meta: {
 		name: "@violetflux/eslint-plugin-kerros",
-		version: "0.2.4"
+		version: "0.3.0"
 	},
 	rules
 };

package/dist/index.mjs

@@ -52,6 +52,7 @@ function getTypeServices(context) {
 //#region src/internal/kerros-types.ts
 const markerNames = {
 	externalStoreProvider: "externalStoreProviderMarker",
+	storeGetter: "storeGetterMarker",
 	storeHook: "storeHookMarker",
 	storeInstanceHook: "storeInstanceHookMarker"
 };
@@ -149,11 +150,11 @@ function createKerrosProgramTools(program) {
 		const returnType = checker.getReturnTypeOfSignature(signature);
 		const hookType = getTupleMemberType(returnType, 0, node);
 		if (!hookType || !hasMarker(hookType, "storeHook")) return void 0;
-		const instanceType = getTupleMemberType(returnType, 2, node);
-		if (name === "createStore" && !instanceType) return "createStore";
-		if (name !== "bindStore" || !instanceType) return void 0;
+		const thirdType = getTupleMemberType(returnType, 2, node);
+		if (name === "createStore") return !thirdType || hasMarker(thirdType, "storeGetter") ? "createStore" : void 0;
+		if (name !== "bindStore" || !thirdType) return void 0;
 		const providerType = getTupleMemberType(returnType, 1, node);
-		return providerType && hasMarker(providerType, "externalStoreProvider") && hasMarker(instanceType, "storeInstanceHook") ? "bindStore" : void 0;
+		return providerType && hasMarker(providerType, "externalStoreProvider") && hasMarker(thirdType, "storeInstanceHook") ? "bindStore" : void 0;
 	};
 	/** Test whether a call invokes a nominal Kerros Store Hook. */
 	const isStoreHookCall = (node) => {
@@ -273,10 +274,11 @@ const bindingNaming = createRule({
 	name: "binding-naming",
 	meta: {
 		type: "problem",
-		docs: { description: "Keep Kerros Hook and Provider binding names aligned." },
+		docs: { description: "Keep Kerros Hook, Provider, and getter binding names aligned." },
 		schema: [],
 		messages: {
 			destructureBinding: "Kerros factory results must be destructured.",
+			getterName: "The Store getter must be named getXxx.",
 			hookName: "The Store Hook must be named useXxx.",
 			providerName: "The Provider name must match the Store Hook.",
 			instanceName: "The instance Hook name must match the Store Hook."
@@ -306,12 +308,12 @@ const bindingNaming = createRule({
 			}
 			const hook = getElement(declarator.id, 0);
 			const provider = getElement(declarator.id, 1);
-			const instance = getElement(declarator.id, 2);
+			const third = getElement(declarator.id, 2);
 			const explicitName = kind === "createStore" ? getCreateStoreName(node) : getBindStoreName(node);
 			const hookMatch = hook && /^use(?<name>[A-Z][A-Za-z0-9]*)$/u.exec(hook.name);
 			const providerMatch = provider && /^(?<name>[A-Z][A-Za-z0-9]*)Provider$/u.exec(provider.name);
-			const instanceMatch = instance && /^use(?<name>[A-Z][A-Za-z0-9]*)Instance$/u.exec(instance.name);
-			const inferredName = hookMatch?.groups?.name ?? providerMatch?.groups?.name ?? instanceMatch?.groups?.name;
+			const thirdMatch = third && (kind === "createStore" ? /^get(?<name>[A-Z][A-Za-z0-9]*)$/u.exec(third.name) : /^use(?<name>[A-Z][A-Za-z0-9]*)Instance$/u.exec(third.name));
+			const inferredName = hookMatch?.groups?.name ?? providerMatch?.groups?.name ?? thirdMatch?.groups?.name;
 			const name = explicitName ?? inferredName;
 			if (hook && (!hookMatch || name && hookMatch.groups?.name !== name)) context.report({
 				node: hook,
@@ -321,9 +323,9 @@ const bindingNaming = createRule({
 				node: provider,
 				messageId: "providerName"
 			});
-			if (instance && (!instanceMatch || name && instanceMatch.groups?.name !== name)) context.report({
-				node: instance,
-				messageId: "instanceName"
+			if (third && (!thirdMatch || name && thirdMatch.groups?.name !== name)) context.report({
+				node: third,
+				messageId: kind === "createStore" ? "getterName" : "instanceName"
 			});
 		} };
 	}
@@ -2421,7 +2423,7 @@ const rules = {
 const plugin = {
 	meta: {
 		name: "@violetflux/eslint-plugin-kerros",
-		version: "0.2.4"
+		version: "0.3.0"
 	},
 	rules
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@violetflux/eslint-plugin-kerros",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Type-aware ESLint rules for Kerros stores.",
   "repository": {
     "type": "git",
@@ -35,7 +35,7 @@
   },
   "peerDependencies": {
     "@typescript-eslint/parser": "^8.0.0",
-    "@violetflux/kerros": "^0.2.4",
+    "@violetflux/kerros": "^0.3.0",
     "eslint": "^9.0.0 || ^10.0.0",
     "typescript": "^5.0.0 || >=6.0.0 <6.1.0"
   },