@glion/lint-profile-extra-fields 0.23.0 → 0.25.0

package/README.md

@@ -1,10 +1,10 @@
 # @glion/lint-profile-extra-fields
 
-Lint rule that warns when a segment contains fields beyond the maximum sequence defined in its profile.
+Lint rule that warns when a segment has more fields than its profile defines.
 
 ## What it does
 
-Flags fields whose sequence number exceeds the highest field position defined in the HL7v2 profile for that segment at the message's version. The rule reads profile context attached by `@glion/annotate-profile-context`, computes the maximum defined sequence per segment, and reports each field past that boundary. Segments without a known profile (for example Z-segments) are silently skipped.
+Flags a segment with more fields than the HL7v2 standard defines for it in the message's version. The rule reads profile context attached by `@glion/annotate-profile-context`. Segments without a known profile (for example Z-segments) are skipped.
 
 ## Install
 
@@ -41,7 +41,7 @@ console.error(reporter([file]));
 
 A `unified` lint rule plugin. Takes no options.
 
-Reads `file.data.profile`. For each segment it looks up the field definition set and takes the largest key (a 1-based HL7 sequence number) as the maximum. It then walks the segment's fields and reports each field whose sequence is greater than that maximum.
+Reports one message for each segment with too many fields, with the number of fields in `actual`.
 
 ```ts
 import type { Plugin } from "unified";
@@ -53,7 +53,7 @@ export default hl7v2LintExtraFields;
 
 ## What it checks
 
-This rule flags fields past the defined range for a segment. `MSH` in v2.5 ends at `MSH-21`, so any field at sequence 22 or higher is unexpected for that segment and version.
+A segment has at most as many fields as its profile defines. `MSH` in v2.5 ends at `MSH-21`, so it allows 21 fields.
 
 ### Valid
 
@@ -66,7 +66,7 @@ PID|1||PATID1234^^^HOSP^MR||DOE^JANE||19800101|F
 
 ### Invalid
 
-`MSH` carries a field at sequence 22, which is past the v2.5 maximum of `MSH-21`:
+`MSH` has 22 fields, one more than v2.5 defines:
 
 ```hl7
 MSH|^~\&|SENDER|FAC|RECV|RFAC|20250601120000||ADT^A01^ADT_A01|MSG00001|P|2.5||||||||||EXTRA
@@ -76,10 +76,10 @@ PID|1||PATID1234^^^HOSP^MR||DOE^JANE||19800101|F
 Reported message:
 
 ```
-Field MSH-22 is beyond the defined fields for MSH (max: 21 in v2.5)
+Segment `MSH` has 22 fields; it allows at most 21 fields.
 ```
 
-The reported max comes from the profile's highest sequence number and the version is taken from the annotated profile context. One message is reported per extra field.
+The version is taken from the annotated profile context. A segment is reported once, however many fields it has past its last.
 
 ## Part of Glion
 

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import type { Root } from "@glion/ast";
 /**
- * Lint rule that warns when a segment contains fields beyond the maximum
- * sequence number defined in its profile.
+ * Lint rule that reports a segment with more fields than its profile
+ * defines.
  *
  * Segments without a known profile (e.g., Z-segments) are silently skipped.
  *

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAIvC;;;;;;;;;;GAUG;AACH,QAAA,MAAM,oBAAoB,mDAoCzB,CAAC;AAaF,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAUvC;;;;;;;;;;GAUG;AACH,QAAA,MAAM,oBAAoB,mDAiCzB,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/index.js

@@ -1,9 +1,11 @@
 import { SKIP, visit } from "@glion/util-visit";
+import pluralize from "pluralize";
 import { lintRule } from "unified-lint-rule";
 //#region src/index.ts
+const messages = { tooManyFields: (segmentId, count, max) => `Segment \`${segmentId}\` has ${pluralize("field", count, true)}; it allows at most ${pluralize("field", max, true)}.` };
 /**
-* Lint rule that warns when a segment contains fields beyond the maximum
-* sequence number defined in its profile.
+* Lint rule that reports a segment with more fields than its profile
+* defines.
 *
 * Segments without a known profile (e.g., Z-segments) are silently skipped.
 *
@@ -12,34 +14,27 @@ import { lintRule } from "unified-lint-rule";
 *   unified().use(hl7v2LintExtraFields);
 *   ```;
 */
-const hl7v2LintExtraFields = lintRule({ origin: "hl7v2-lint:extra-fields" }, (tree, file) => {
+const hl7v2LintExtraFields = lintRule({
+	origin: "hl7v2-lint:extra-fields",
+	url: "https://github.com/rethinkhealth/glion/tree/main/packages/lint-profile-extra-fields#readme"
+}, (tree, file) => {
 	const ctx = file.data.profile;
 	if (!ctx) return;
 	visit(tree, "segment", (segment, segmentAncestors) => {
-		const fieldDef = ctx.fields.get(segment.name);
-		if (!fieldDef) return SKIP;
-		const maxSequence = maxKey(fieldDef.bySequence);
-		if (maxSequence === 0) return SKIP;
-		visit(segment, "field", (fieldNode, _fieldAncestors, info) => {
-			if (info.sequence > maxSequence) file.message(`Field ${segment.name}-${info.sequence} is beyond the defined fields for ${segment.name} (max: ${maxSequence} in v${ctx.version})`, {
-				ancestors: [
-					...segmentAncestors,
-					segment,
-					fieldNode
-				],
-				place: fieldNode.position
+		const fields = ctx.fields.get(segment.name);
+		if (!fields) return SKIP;
+		const max = Math.max(0, ...fields.bySequence.keys());
+		const count = segment.children.length;
+		if (count > max) {
+			const message = file.message(messages.tooManyFields(segment.name, count, max), {
+				ancestors: [...segmentAncestors, segment],
+				place: segment.position
 			});
-			return SKIP;
-		});
+			message.actual = String(count);
+		}
 		return SKIP;
 	});
 });
-/** Return the highest numeric key in a Map, or 0 if empty. */
-function maxKey(map) {
-	let max = 0;
-	for (const key of map.keys()) if (key > max) max = key;
-	return max;
-}
 //#endregion
 export { hl7v2LintExtraFields as default };
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["// oxlint-disable-next-line no-unused-vars -- triggers VFile DataMap augmentation\nimport type { ProfileContext } from \"@glion/annotate-profile-context\";\nimport type { Root } from \"@glion/ast\";\nimport { SKIP, visit } from \"@glion/util-visit\";\nimport { lintRule } from \"unified-lint-rule\";\n\n/**\n * Lint rule that warns when a segment contains fields beyond the maximum\n * sequence number defined in its profile.\n *\n * Segments without a known profile (e.g., Z-segments) are silently skipped.\n *\n * @example\n *   ```typescript\n *   unified().use(hl7v2LintExtraFields);\n *   ```;\n */\nconst hl7v2LintExtraFields = lintRule<Root>(\n  { origin: \"hl7v2-lint:extra-fields\" },\n  (tree, file) => {\n    const ctx = file.data.profile;\n    if (!ctx) {\n      return;\n    }\n\n    visit(tree, \"segment\", (segment, segmentAncestors) => {\n      const fieldDef = ctx.fields.get(segment.name);\n      if (!fieldDef) {\n        return SKIP;\n      }\n\n      const maxSequence = maxKey(fieldDef.bySequence);\n      if (maxSequence === 0) {\n        return SKIP;\n      }\n\n      visit(segment, \"field\", (fieldNode, _fieldAncestors, info) => {\n        if (info.sequence > maxSequence) {\n          file.message(\n            `Field ${segment.name}-${info.sequence} is beyond the defined fields for ${segment.name} (max: ${maxSequence} in v${ctx.version})`,\n            {\n              ancestors: [...segmentAncestors, segment, fieldNode],\n              place: fieldNode.position,\n            }\n          );\n        }\n\n        return SKIP;\n      });\n\n      return SKIP;\n    });\n  }\n);\n\n/** Return the highest numeric key in a Map, or 0 if empty. */\nfunction maxKey(map: ReadonlyMap<number, unknown>): number {\n  let max = 0;\n  for (const key of map.keys()) {\n    if (key > max) {\n      max = key;\n    }\n  }\n  return max;\n}\n\nexport default hl7v2LintExtraFields;\n"],"mappings":";;;;;;;;;;;;;;AAiBA,MAAM,uBAAuB,SAC3B,EAAE,QAAQ,2BAA2B,GACpC,MAAM,SAAS;CACd,MAAM,MAAM,KAAK,KAAK;AACtB,KAAI,CAAC,IACH;AAGF,OAAM,MAAM,YAAY,SAAS,qBAAqB;EACpD,MAAM,WAAW,IAAI,OAAO,IAAI,QAAQ,KAAK;AAC7C,MAAI,CAAC,SACH,QAAO;EAGT,MAAM,cAAc,OAAO,SAAS,WAAW;AAC/C,MAAI,gBAAgB,EAClB,QAAO;AAGT,QAAM,SAAS,UAAU,WAAW,iBAAiB,SAAS;AAC5D,OAAI,KAAK,WAAW,YAClB,MAAK,QACH,SAAS,QAAQ,KAAK,GAAG,KAAK,SAAS,oCAAoC,QAAQ,KAAK,SAAS,YAAY,OAAO,IAAI,QAAQ,IAChI;IACE,WAAW;KAAC,GAAG;KAAkB;KAAS;KAAU;IACpD,OAAO,UAAU;IAClB,CACF;AAGH,UAAO;IACP;AAEF,SAAO;GACP;EAEL;;AAGD,SAAS,OAAO,KAA2C;CACzD,IAAI,MAAM;AACV,MAAK,MAAM,OAAO,IAAI,MAAM,CAC1B,KAAI,MAAM,IACR,OAAM;AAGV,QAAO"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["// oxlint-disable-next-line no-unused-vars -- triggers VFile DataMap augmentation\nimport type { ProfileContext } from \"@glion/annotate-profile-context\";\nimport type { Root } from \"@glion/ast\";\nimport { SKIP, visit } from \"@glion/util-visit\";\nimport pluralize from \"pluralize\";\nimport { lintRule } from \"unified-lint-rule\";\n\nconst messages = {\n  tooManyFields: (segmentId: string, count: number, max: number) =>\n    `Segment \\`${segmentId}\\` has ${pluralize(\"field\", count, true)}; it allows at most ${pluralize(\"field\", max, true)}.`,\n} as const;\n\n/**\n * Lint rule that reports a segment with more fields than its profile\n * defines.\n *\n * Segments without a known profile (e.g., Z-segments) are silently skipped.\n *\n * @example\n *   ```typescript\n *   unified().use(hl7v2LintExtraFields);\n *   ```;\n */\nconst hl7v2LintExtraFields = lintRule<Root>(\n  {\n    origin: \"hl7v2-lint:extra-fields\",\n    url: \"https://github.com/rethinkhealth/glion/tree/main/packages/lint-profile-extra-fields#readme\",\n  },\n  (tree, file) => {\n    const ctx = file.data.profile;\n    if (!ctx) {\n      return;\n    }\n\n    visit(tree, \"segment\", (segment, segmentAncestors) => {\n      const fields = ctx.fields.get(segment.name);\n      if (!fields) {\n        return SKIP;\n      }\n\n      const max = Math.max(0, ...fields.bySequence.keys());\n      const count = segment.children.length;\n      if (count > max) {\n        const message = file.message(\n          messages.tooManyFields(segment.name, count, max),\n          {\n            ancestors: [...segmentAncestors, segment],\n            place: segment.position,\n          }\n        );\n        message.actual = String(count);\n      }\n\n      return SKIP;\n    });\n  }\n);\n\nexport default hl7v2LintExtraFields;\n"],"mappings":";;;;AAOA,MAAM,WAAW,EACf,gBAAgB,WAAmB,OAAe,QAChD,aAAa,UAAU,SAAS,UAAU,SAAS,OAAO,KAAK,CAAC,sBAAsB,UAAU,SAAS,KAAK,KAAK,CAAC,IACvH;;;;;;;;;;;;AAaD,MAAM,uBAAuB,SAC3B;CACE,QAAQ;CACR,KAAK;CACN,GACA,MAAM,SAAS;CACd,MAAM,MAAM,KAAK,KAAK;AACtB,KAAI,CAAC,IACH;AAGF,OAAM,MAAM,YAAY,SAAS,qBAAqB;EACpD,MAAM,SAAS,IAAI,OAAO,IAAI,QAAQ,KAAK;AAC3C,MAAI,CAAC,OACH,QAAO;EAGT,MAAM,MAAM,KAAK,IAAI,GAAG,GAAG,OAAO,WAAW,MAAM,CAAC;EACpD,MAAM,QAAQ,QAAQ,SAAS;AAC/B,MAAI,QAAQ,KAAK;GACf,MAAM,UAAU,KAAK,QACnB,SAAS,cAAc,QAAQ,MAAM,OAAO,IAAI,EAChD;IACE,WAAW,CAAC,GAAG,kBAAkB,QAAQ;IACzC,OAAO,QAAQ;IAChB,CACF;AACD,WAAQ,SAAS,OAAO,MAAM;;AAGhC,SAAO;GACP;EAEL"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glion/lint-profile-extra-fields",
-  "version": "0.23.0",
+  "version": "0.25.0",
   "description": "Lint rule that warns when a segment contains fields beyond the maximum sequence defined in its profile",
   "keywords": [
     "health",
@@ -33,12 +33,14 @@
     "access": "public"
   },
   "dependencies": {
+    "pluralize": "8.0.0",
     "unified-lint-rule": "3.0.1",
-    "@glion/ast": "0.23.0",
-    "@glion/util-visit": "0.23.0"
+    "@glion/ast": "0.25.0",
+    "@glion/util-visit": "0.25.0"
   },
   "devDependencies": {
     "@types/node": "25.6.0",
+    "@types/pluralize": "^0.0.33",
     "@vitest/coverage-v8": "4.1.11",
     "publint": "0.3.18",
     "tsdown": "0.21.10",
@@ -46,10 +48,10 @@
     "unified": "^11.0.5",
     "vfile": "^6.0.3",
     "vitest": "4.1.11",
-    "@glion/annotate-profile-context": "0.23.0",
-    "@glion/builder": "0.23.0",
-    "@glion/testing": "0.18.0",
+    "@glion/annotate-profile-context": "0.25.0",
+    "@glion/builder": "0.25.0",
     "@glion/check-readme": "0.18.0",
+    "@glion/testing": "0.18.0",
     "@glion/tsconfig": "0.18.0"
   },
   "engines": {