@violetflux/eslint-plugin-kerros 0.3.1 → 0.3.3

package/dist/index.cjs

@@ -718,7 +718,7 @@ const objectEnumerationMethods = /* @__PURE__ */ new Set([
 	"keys",
 	"values"
 ]);
-/** Read the snapshot argument from a complete enumeration or serialization call. */
+/** Read the tracked value argument from a broad enumeration or serialization call. */
 function getBroadArgument(node) {
 	const [argument] = node.arguments;
 	if (!argument || argument.type === "SpreadElement") return false;
@@ -733,48 +733,96 @@ const noBroadStoreAccess = createRule({
 	name: "no-broad-store-access",
 	meta: {
 		type: "problem",
-		docs: { description: "Prevent complete Store enumeration and serialization." },
-		schema: [],
-		messages: { broadAccess: "Do not enumerate or spread the complete Store snapshot." }
+		docs: { description: "Prevent broad enumeration and serialization of complete Store snapshots." },
+		schema: [{
+			type: "object",
+			properties: {
+				includeObjectFields: { type: "boolean" },
+				includeStoreModels: { type: "boolean" }
+			},
+			additionalProperties: false
+		}],
+		messages: {
+			broadAccess: "Do not enumerate, serialize, or spread a complete selector-free Store snapshot.",
+			broadObjectField: "Do not enumerate, serialize, or spread an object field from a selector-free Store snapshot."
+		}
 	},
-	defaultOptions: [],
-	create(context) {
-		const { getIdentifierSymbol, getType, isStoreHookCall } = createKerrosTypeTools(context);
+	defaultOptions: [{
+		includeObjectFields: false,
+		includeStoreModels: false
+	}],
+	create(context, [options]) {
+		const { getFactoryKind, getIdentifierSymbol, getType, isStoreHookCall } = createKerrosTypeTools(context);
 		const origins = createReferenceOriginTracker(context.sourceCode.ast);
-		/** Test whether an expression originates from a selector-free Store snapshot. */
-		const isSnapshotDerived = (input, seen = /* @__PURE__ */ new Set()) => {
+		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);
 			if (node.type === "CallExpression") {
 				const selector = node.arguments[0];
-				return (node.arguments.length === 0 || node.arguments.length === 1 && selector?.type !== "SpreadElement" && (getType(selector).flags & typescript.default.TypeFlags.Undefined) !== 0) && isStoreHookCall(node);
+				return (node.arguments.length === 0 || node.arguments.length === 1 && selector?.type !== "SpreadElement" && (getType(selector).flags & typescript.default.TypeFlags.Undefined) !== 0) && isStoreHookCall(node) ? "snapshot" : void 0;
 			}
-			if (node.type === "AssignmentExpression") return isSnapshotDerived(node.right, seen);
-			if (node.type === "MemberExpression") return isSnapshotDerived(node.object, seen);
-			if (node.type !== "Identifier") return false;
+			if (node.type === "AssignmentExpression") return readStoreOrigin(node.right, seen);
+			if (node.type === "MemberExpression") return readStoreOrigin(node.object, seen) ? "objectField" : void 0;
+			if (node.type !== "Identifier") return;
 			const symbol = getIdentifierSymbol(node);
-			if (!symbol || seen.has(symbol)) return false;
+			if (!symbol || seen.has(symbol)) return;
 			seen.add(symbol);
-			const derived = origins.resolve(symbol, node).some((source) => isSnapshotDerived(source, seen));
+			let result;
+			for (const source of origins.resolve(symbol, node)) {
+				const origin = readStoreOrigin(source.expression, seen);
+				if (!origin) continue;
+				if (!source.objectField && origin === "snapshot") {
+					result = "snapshot";
+					break;
+				}
+				result = "objectField";
+			}
 			seen.delete(symbol);
-			return derived;
+			return result;
 		};
 		/** Report one operation that subscribes to every enumerable field. */
 		const reportBroadAccess = (expression) => {
-			if (isSnapshotDerived(expression)) context.report({
-				node: expression,
+			const origin = readStoreOrigin(expression);
+			if (origin === "snapshot") pendingReports.push({
+				expression,
 				messageId: "broadAccess"
 			});
+			else if (origin === "objectField" && options.includeObjectFields) pendingReports.push({
+				expression,
+				messageId: "broadObjectField"
+			});
 		};
 		/** Track object-valued bindings destructured from a snapshot. */
-		const recordObjectBindings = (pattern, source, write) => {
+		const recordObjectBindings = (pattern, source, write, objectField = false) => {
 			if (pattern.type === "Identifier") {
 				if ((getType(pattern).flags & typescript.default.TypeFlags.Object) === 0) return;
 				const symbol = getIdentifierSymbol(pattern);
-				if (symbol) origins.record(symbol, source, write);
+				if (symbol) origins.record(symbol, {
+					expression: source,
+					objectField
+				}, write);
 				return;
 			}
 			if (pattern.type === "AssignmentPattern") {
-				recordObjectBindings(pattern.left, source, write);
+				recordObjectBindings(pattern.left, source, write, objectField);
 				return;
 			}
 			if (pattern.type === "RestElement") return;
@@ -782,12 +830,19 @@ const noBroadStoreAccess = createRule({
 			const entries = pattern.type === "ObjectPattern" ? pattern.properties : pattern.elements;
 			for (const entry of entries) {
 				if (!entry) continue;
-				if (entry.type === "Property") recordObjectBindings(entry.value, source, write);
-				else recordObjectBindings(entry, source, write);
+				if (entry.type === "Property") recordObjectBindings(entry.value, source, write, true);
+				else recordObjectBindings(entry, source, write, true);
 			}
 		};
 		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);
 			},
@@ -798,7 +853,10 @@ const noBroadStoreAccess = createRule({
 				if (!node.init) return;
 				if (node.id.type === "Identifier") {
 					const symbol = getIdentifierSymbol(node.id);
-					if (symbol) origins.record(symbol, node.init, node);
+					if (symbol) origins.record(symbol, {
+						expression: node.init,
+						objectField: false
+					}, node);
 					return;
 				}
 				if (node.id.type === "ObjectPattern" && node.id.properties.some((property) => property.type === "RestElement")) reportBroadAccess(node.init);
@@ -807,7 +865,19 @@ const noBroadStoreAccess = createRule({
 			AssignmentExpression(node) {
 				if (node.left.type !== "Identifier") return;
 				const symbol = getIdentifierSymbol(node.left);
-				if (symbol) origins.record(symbol, node.right, node);
+				if (symbol) origins.record(symbol, {
+					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
+					});
+				}
 			}
 		};
 	}
@@ -2471,7 +2541,7 @@ const rules = {
 const plugin = {
 	meta: {
 		name: "@violetflux/eslint-plugin-kerros",
-		version: "0.3.1"
+		version: "0.3.3"
 	},
 	rules
 };

package/dist/index.mjs

@@ -690,7 +690,7 @@ const objectEnumerationMethods = /* @__PURE__ */ new Set([
 	"keys",
 	"values"
 ]);
-/** Read the snapshot argument from a complete enumeration or serialization call. */
+/** Read the tracked value argument from a broad enumeration or serialization call. */
 function getBroadArgument(node) {
 	const [argument] = node.arguments;
 	if (!argument || argument.type === "SpreadElement") return false;
@@ -705,48 +705,96 @@ const noBroadStoreAccess = createRule({
 	name: "no-broad-store-access",
 	meta: {
 		type: "problem",
-		docs: { description: "Prevent complete Store enumeration and serialization." },
-		schema: [],
-		messages: { broadAccess: "Do not enumerate or spread the complete Store snapshot." }
+		docs: { description: "Prevent broad enumeration and serialization of complete Store snapshots." },
+		schema: [{
+			type: "object",
+			properties: {
+				includeObjectFields: { type: "boolean" },
+				includeStoreModels: { type: "boolean" }
+			},
+			additionalProperties: false
+		}],
+		messages: {
+			broadAccess: "Do not enumerate, serialize, or spread a complete selector-free Store snapshot.",
+			broadObjectField: "Do not enumerate, serialize, or spread an object field from a selector-free Store snapshot."
+		}
 	},
-	defaultOptions: [],
-	create(context) {
-		const { getIdentifierSymbol, getType, isStoreHookCall } = createKerrosTypeTools(context);
+	defaultOptions: [{
+		includeObjectFields: false,
+		includeStoreModels: false
+	}],
+	create(context, [options]) {
+		const { getFactoryKind, getIdentifierSymbol, getType, isStoreHookCall } = createKerrosTypeTools(context);
 		const origins = createReferenceOriginTracker(context.sourceCode.ast);
-		/** Test whether an expression originates from a selector-free Store snapshot. */
-		const isSnapshotDerived = (input, seen = /* @__PURE__ */ new Set()) => {
+		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);
 			if (node.type === "CallExpression") {
 				const selector = node.arguments[0];
-				return (node.arguments.length === 0 || node.arguments.length === 1 && selector?.type !== "SpreadElement" && (getType(selector).flags & ts.TypeFlags.Undefined) !== 0) && isStoreHookCall(node);
+				return (node.arguments.length === 0 || node.arguments.length === 1 && selector?.type !== "SpreadElement" && (getType(selector).flags & ts.TypeFlags.Undefined) !== 0) && isStoreHookCall(node) ? "snapshot" : void 0;
 			}
-			if (node.type === "AssignmentExpression") return isSnapshotDerived(node.right, seen);
-			if (node.type === "MemberExpression") return isSnapshotDerived(node.object, seen);
-			if (node.type !== "Identifier") return false;
+			if (node.type === "AssignmentExpression") return readStoreOrigin(node.right, seen);
+			if (node.type === "MemberExpression") return readStoreOrigin(node.object, seen) ? "objectField" : void 0;
+			if (node.type !== "Identifier") return;
 			const symbol = getIdentifierSymbol(node);
-			if (!symbol || seen.has(symbol)) return false;
+			if (!symbol || seen.has(symbol)) return;
 			seen.add(symbol);
-			const derived = origins.resolve(symbol, node).some((source) => isSnapshotDerived(source, seen));
+			let result;
+			for (const source of origins.resolve(symbol, node)) {
+				const origin = readStoreOrigin(source.expression, seen);
+				if (!origin) continue;
+				if (!source.objectField && origin === "snapshot") {
+					result = "snapshot";
+					break;
+				}
+				result = "objectField";
+			}
 			seen.delete(symbol);
-			return derived;
+			return result;
 		};
 		/** Report one operation that subscribes to every enumerable field. */
 		const reportBroadAccess = (expression) => {
-			if (isSnapshotDerived(expression)) context.report({
-				node: expression,
+			const origin = readStoreOrigin(expression);
+			if (origin === "snapshot") pendingReports.push({
+				expression,
 				messageId: "broadAccess"
 			});
+			else if (origin === "objectField" && options.includeObjectFields) pendingReports.push({
+				expression,
+				messageId: "broadObjectField"
+			});
 		};
 		/** Track object-valued bindings destructured from a snapshot. */
-		const recordObjectBindings = (pattern, source, write) => {
+		const recordObjectBindings = (pattern, source, write, objectField = false) => {
 			if (pattern.type === "Identifier") {
 				if ((getType(pattern).flags & ts.TypeFlags.Object) === 0) return;
 				const symbol = getIdentifierSymbol(pattern);
-				if (symbol) origins.record(symbol, source, write);
+				if (symbol) origins.record(symbol, {
+					expression: source,
+					objectField
+				}, write);
 				return;
 			}
 			if (pattern.type === "AssignmentPattern") {
-				recordObjectBindings(pattern.left, source, write);
+				recordObjectBindings(pattern.left, source, write, objectField);
 				return;
 			}
 			if (pattern.type === "RestElement") return;
@@ -754,12 +802,19 @@ const noBroadStoreAccess = createRule({
 			const entries = pattern.type === "ObjectPattern" ? pattern.properties : pattern.elements;
 			for (const entry of entries) {
 				if (!entry) continue;
-				if (entry.type === "Property") recordObjectBindings(entry.value, source, write);
-				else recordObjectBindings(entry, source, write);
+				if (entry.type === "Property") recordObjectBindings(entry.value, source, write, true);
+				else recordObjectBindings(entry, source, write, true);
 			}
 		};
 		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);
 			},
@@ -770,7 +825,10 @@ const noBroadStoreAccess = createRule({
 				if (!node.init) return;
 				if (node.id.type === "Identifier") {
 					const symbol = getIdentifierSymbol(node.id);
-					if (symbol) origins.record(symbol, node.init, node);
+					if (symbol) origins.record(symbol, {
+						expression: node.init,
+						objectField: false
+					}, node);
 					return;
 				}
 				if (node.id.type === "ObjectPattern" && node.id.properties.some((property) => property.type === "RestElement")) reportBroadAccess(node.init);
@@ -779,7 +837,19 @@ const noBroadStoreAccess = createRule({
 			AssignmentExpression(node) {
 				if (node.left.type !== "Identifier") return;
 				const symbol = getIdentifierSymbol(node.left);
-				if (symbol) origins.record(symbol, node.right, node);
+				if (symbol) origins.record(symbol, {
+					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
+					});
+				}
 			}
 		};
 	}
@@ -2443,7 +2513,7 @@ const rules = {
 const plugin = {
 	meta: {
 		name: "@violetflux/eslint-plugin-kerros",
-		version: "0.3.1"
+		version: "0.3.3"
 	},
 	rules
 };

package/package.json

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