@violetflux/eslint-plugin-kerros 0.3.2 → 0.3.3

package/dist/index.cjs

@@ -736,7 +736,10 @@ const noBroadStoreAccess = createRule({
 		docs: { description: "Prevent broad enumeration and serialization of complete Store snapshots." },
 		schema: [{
 			type: "object",
-			properties: { includeObjectFields: { type: "boolean" } },
+			properties: {
+				includeObjectFields: { type: "boolean" },
+				includeStoreModels: { type: "boolean" }
+			},
 			additionalProperties: false
 		}],
 		messages: {
@@ -744,10 +747,31 @@ const noBroadStoreAccess = createRule({
 			broadObjectField: "Do not enumerate, serialize, or spread an object field from a selector-free Store snapshot."
 		}
 	},
-	defaultOptions: [{ includeObjectFields: false }],
+	defaultOptions: [{
+		includeObjectFields: false,
+		includeStoreModels: false
+	}],
 	create(context, [options]) {
-		const { getIdentifierSymbol, getType, isStoreHookCall } = createKerrosTypeTools(context);
+		const { getFactoryKind, getIdentifierSymbol, getType, isStoreHookCall } = createKerrosTypeTools(context);
 		const origins = createReferenceOriginTracker(context.sourceCode.ast);
+		const storeModels = /* @__PURE__ */ new Set();
+		const pendingReports = [];
+		/** Test whether an expression belongs to a function registered as a createStore model. */
+		const isInsideStoreModel = (expression) => {
+			let node = expression.parent;
+			while (node) {
+				if (node.type === "FunctionDeclaration" && node.id) {
+					const symbol = getIdentifierSymbol(node.id);
+					return symbol ? storeModels.has(symbol) : false;
+				}
+				if ((node.type === "ArrowFunctionExpression" || node.type === "FunctionExpression") && node.parent.type === "VariableDeclarator" && node.parent.id.type === "Identifier") {
+					const symbol = getIdentifierSymbol(node.parent.id);
+					return symbol ? storeModels.has(symbol) : false;
+				}
+				node = node.parent;
+			}
+			return false;
+		};
 		/** Classify whether an expression is a complete Store snapshot or one object field from it. */
 		const readStoreOrigin = (input, seen = /* @__PURE__ */ new Set()) => {
 			const node = unwrapExpression(input);
@@ -777,12 +801,12 @@ const noBroadStoreAccess = createRule({
 		/** Report one operation that subscribes to every enumerable field. */
 		const reportBroadAccess = (expression) => {
 			const origin = readStoreOrigin(expression);
-			if (origin === "snapshot") context.report({
-				node: expression,
+			if (origin === "snapshot") pendingReports.push({
+				expression,
 				messageId: "broadAccess"
 			});
-			else if (origin === "objectField" && options.includeObjectFields) context.report({
-				node: expression,
+			else if (origin === "objectField" && options.includeObjectFields) pendingReports.push({
+				expression,
 				messageId: "broadObjectField"
 			});
 		};
@@ -812,6 +836,13 @@ const noBroadStoreAccess = createRule({
 		};
 		return {
 			CallExpression(node) {
+				if (getFactoryKind(node) === "createStore") {
+					const model = node.arguments[0];
+					if (model?.type === "Identifier") {
+						const symbol = getIdentifierSymbol(model);
+						if (symbol) storeModels.add(symbol);
+					}
+				}
 				const argument = getBroadArgument(node);
 				if (argument) reportBroadAccess(argument);
 			},
@@ -838,6 +869,15 @@ const noBroadStoreAccess = createRule({
 					expression: node.right,
 					objectField: false
 				}, node);
+			},
+			"Program:exit"() {
+				for (const { expression, messageId } of pendingReports) {
+					if (!options.includeStoreModels && isInsideStoreModel(expression)) continue;
+					context.report({
+						node: expression,
+						messageId
+					});
+				}
 			}
 		};
 	}
@@ -2501,7 +2541,7 @@ const rules = {
 const plugin = {
 	meta: {
 		name: "@violetflux/eslint-plugin-kerros",
-		version: "0.3.2"
+		version: "0.3.3"
 	},
 	rules
 };

package/dist/index.mjs

@@ -708,7 +708,10 @@ const noBroadStoreAccess = createRule({
 		docs: { description: "Prevent broad enumeration and serialization of complete Store snapshots." },
 		schema: [{
 			type: "object",
-			properties: { includeObjectFields: { type: "boolean" } },
+			properties: {
+				includeObjectFields: { type: "boolean" },
+				includeStoreModels: { type: "boolean" }
+			},
 			additionalProperties: false
 		}],
 		messages: {
@@ -716,10 +719,31 @@ const noBroadStoreAccess = createRule({
 			broadObjectField: "Do not enumerate, serialize, or spread an object field from a selector-free Store snapshot."
 		}
 	},
-	defaultOptions: [{ includeObjectFields: false }],
+	defaultOptions: [{
+		includeObjectFields: false,
+		includeStoreModels: false
+	}],
 	create(context, [options]) {
-		const { getIdentifierSymbol, getType, isStoreHookCall } = createKerrosTypeTools(context);
+		const { getFactoryKind, getIdentifierSymbol, getType, isStoreHookCall } = createKerrosTypeTools(context);
 		const origins = createReferenceOriginTracker(context.sourceCode.ast);
+		const storeModels = /* @__PURE__ */ new Set();
+		const pendingReports = [];
+		/** Test whether an expression belongs to a function registered as a createStore model. */
+		const isInsideStoreModel = (expression) => {
+			let node = expression.parent;
+			while (node) {
+				if (node.type === "FunctionDeclaration" && node.id) {
+					const symbol = getIdentifierSymbol(node.id);
+					return symbol ? storeModels.has(symbol) : false;
+				}
+				if ((node.type === "ArrowFunctionExpression" || node.type === "FunctionExpression") && node.parent.type === "VariableDeclarator" && node.parent.id.type === "Identifier") {
+					const symbol = getIdentifierSymbol(node.parent.id);
+					return symbol ? storeModels.has(symbol) : false;
+				}
+				node = node.parent;
+			}
+			return false;
+		};
 		/** Classify whether an expression is a complete Store snapshot or one object field from it. */
 		const readStoreOrigin = (input, seen = /* @__PURE__ */ new Set()) => {
 			const node = unwrapExpression(input);
@@ -749,12 +773,12 @@ const noBroadStoreAccess = createRule({
 		/** Report one operation that subscribes to every enumerable field. */
 		const reportBroadAccess = (expression) => {
 			const origin = readStoreOrigin(expression);
-			if (origin === "snapshot") context.report({
-				node: expression,
+			if (origin === "snapshot") pendingReports.push({
+				expression,
 				messageId: "broadAccess"
 			});
-			else if (origin === "objectField" && options.includeObjectFields) context.report({
-				node: expression,
+			else if (origin === "objectField" && options.includeObjectFields) pendingReports.push({
+				expression,
 				messageId: "broadObjectField"
 			});
 		};
@@ -784,6 +808,13 @@ const noBroadStoreAccess = createRule({
 		};
 		return {
 			CallExpression(node) {
+				if (getFactoryKind(node) === "createStore") {
+					const model = node.arguments[0];
+					if (model?.type === "Identifier") {
+						const symbol = getIdentifierSymbol(model);
+						if (symbol) storeModels.add(symbol);
+					}
+				}
 				const argument = getBroadArgument(node);
 				if (argument) reportBroadAccess(argument);
 			},
@@ -810,6 +841,15 @@ const noBroadStoreAccess = createRule({
 					expression: node.right,
 					objectField: false
 				}, node);
+			},
+			"Program:exit"() {
+				for (const { expression, messageId } of pendingReports) {
+					if (!options.includeStoreModels && isInsideStoreModel(expression)) continue;
+					context.report({
+						node: expression,
+						messageId
+					});
+				}
 			}
 		};
 	}
@@ -2473,7 +2513,7 @@ const rules = {
 const plugin = {
 	meta: {
 		name: "@violetflux/eslint-plugin-kerros",
-		version: "0.3.2"
+		version: "0.3.3"
 	},
 	rules
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@violetflux/eslint-plugin-kerros",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Type-aware ESLint rules for Kerros stores.",
   "repository": {
     "type": "git",