@glion/lint-profile-field-repetition 0.23.0 → 0.24.0

package/README.md

@@ -1,10 +1,10 @@
 # @glion/lint-profile-field-repetition
 
-Lint rule that flags non-repeatable fields with multiple repetitions.
+Lint rule that reports a field with more repetitions than HL7v2 allows.
 
 ## What it does
 
-Flags fields that contain more than one repetition (delimited by `~`) when the HL7v2 profile for the message's version declares `repeatable: false` for that field. The rule reads profile context attached by `@glion/annotate-profile-context`. A single repetition is always valid regardless of the `repeatable` flag; only 2+ repetitions on a non-repeatable field are reported. Segments without a known profile are silently skipped.
+Flags a field with more repetitions (separated by `~`) than the HL7v2 standard for the message's version allows: one for a field that does not repeat, or a set number such as 2 for `OBR-17` in v2.6. Fields with no limit on repetitions are never reported. It needs the plugins `@glion/annotate-profile-context` and `@glion/annotate-profile-fields` to run before it; `@glion/preset-lint-profile-recommended` includes them.
 
 ## Install
 
@@ -16,21 +16,24 @@ npm install @glion/lint-profile-field-repetition
 
 ```ts
 import { hl7v2AnnotateProfileContext } from "@glion/annotate-profile-context";
-import { hl7v2Parser } from "@glion/parser";
+import { hl7v2AnnotateProfileFields } from "@glion/annotate-profile-fields";
 import hl7v2LintFieldRepetition from "@glion/lint-profile-field-repetition";
+import { parseHL7v2 } from "@glion/parser";
 import { unified } from "unified";
+import { VFile } from "vfile";
 import { reporter } from "vfile-reporter";
 
 const message = [
   "MSH|^~\\&|SENDER|FAC|RECV|RFAC|20250601120000||ADT^A01^ADT_A01|MSG00001|P|2.5",
-  "PID|1||PATID1234^^^HOSP^MR||DOE^JANE||19800101|F",
+  "PID|1||PATID1234^^^HOSP^MR||DOE^JANE||19800101~19800102|F",
 ].join("\r");
 
-const file = await unified()
-  .use(hl7v2Parser)
+const file = new VFile();
+await unified()
   .use(hl7v2AnnotateProfileContext)
+  .use(hl7v2AnnotateProfileFields)
   .use(hl7v2LintFieldRepetition)
-  .process(message);
+  .run(parseHL7v2(message), file);
 
 console.error(reporter([file]));
 ```
@@ -39,9 +42,7 @@ console.error(reporter([file]));
 
 ### `unified().use(hl7v2LintFieldRepetition)`
 
-A `unified` lint rule plugin. Takes no options.
-
-Reads `file.data.profile`. For each field under a segment with a known profile it looks up the field entry by sequence. If the field's profile sets `repeatable: false` and the AST has more than one repetition, the rule emits one message for that field.
+A `unified` lint rule plugin. Takes no options. Reports one message for each field with too many repetitions.
 
 ```ts
 import type { Plugin } from "unified";
@@ -53,11 +54,11 @@ export default hl7v2LintFieldRepetition;
 
 ## What it checks
 
-This rule flags fields with multiple `~`-delimited repetitions when the profile marks the field as non-repeatable. For example, `PID-7` (Date of Birth) is not repeatable in v2.5.
+A field has at most as many repetitions as its repetition limit in the message's version. For example, `PID-7` (Date/Time of Birth) does not repeat in v2.5.
 
 ### Valid
 
-`PID-7` carries a single Date of Birth:
+`PID-7` has one value:
 
 ```hl7
 MSH|^~\&|SENDER|FAC|RECV|RFAC|20250601120000||ADT^A01^ADT_A01|MSG00001|P|2.5
@@ -66,7 +67,7 @@ PID|1||PATID1234^^^HOSP^MR||DOE^JANE||19800101|F
 
 ### Invalid
 
-`PID-7` carries two `~`-separated values, which violates the v2.5 profile for the `PID-7` field:
+`PID-7` has two values:
 
 ```hl7
 MSH|^~\&|SENDER|FAC|RECV|RFAC|20250601120000||ADT^A01^ADT_A01|MSG00001|P|2.5
@@ -76,11 +77,9 @@ PID|1||PATID1234^^^HOSP^MR||DOE^JANE||19800101~19800102|F
 Reported message:
 
 ```
-Field PID-7 (Date/Time of Birth) is not repeatable but has 2 repetitions
+Field `PID-7` (Date/Time of Birth) has 2 repetitions; it allows at most 1 repetition.
 ```
 
-When the field name is available in the profile it appears in parentheses after the position. The reported count equals the number of repetitions present in the field.
-
 ## Part of Glion
 
 `@glion/lint-profile-field-repetition` is part of **[Glion]**, the application framework for HL7v2. See the [Glion README] for the full package catalog and architecture.

package/dist/index.d.ts

@@ -1,17 +1,17 @@
 import type { Root } from "@glion/ast";
 /**
- * Lint rule that flags fields with multiple repetitions when the profile
- * declares `repeatable: false`.
+ * Lint rule that reports a field with more repetitions than its RP/# allows.
  *
- * A field with a single repetition is always valid regardless of the
- * `repeatable` flag. Only fields with 2+ repetitions on a non-repeatable
- * field are reported.
- *
- * Segments without a known profile (e.g., Z-segments) are silently skipped.
+ * Reads `repetitions` from `field.data`, so `@glion/annotate-profile-fields`
+ * MUST run before it. A field whose `repetitions` is `"unbounded"` is never
+ * reported.
  *
  * @example
  *   ```typescript
- *   unified().use(hl7v2LintFieldRepetition);
+ *   unified()
+ *     .use(hl7v2AnnotateProfileContext)
+ *     .use(hl7v2AnnotateProfileFields)
+ *     .use(hl7v2LintFieldRepetition);
  *   ```;
  */
 declare const hl7v2LintFieldRepetition: import("unified-lint-rule").Plugin<Root, unknown>;

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;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,wBAAwB,mDAuC7B,CAAC;AAEF,eAAe,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAevC;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,wBAAwB,mDAuB7B,CAAC;AAEF,eAAe,wBAAwB,CAAC"}

package/dist/index.js

@@ -1,44 +1,37 @@
 import { SKIP, visit } from "@glion/util-visit";
+import pluralize from "pluralize";
 import { lintRule } from "unified-lint-rule";
 //#region src/index.ts
+const messages = { tooManyRepetitions: (field, name, count, max) => `Field \`${field}\` (${name}) has ${pluralize("repetition", count, true)}; it allows at most ${pluralize("repetition", max, true)}.` };
 /**
-* Lint rule that flags fields with multiple repetitions when the profile
-* declares `repeatable: false`.
+* Lint rule that reports a field with more repetitions than its RP/# allows.
 *
-* A field with a single repetition is always valid regardless of the
-* `repeatable` flag. Only fields with 2+ repetitions on a non-repeatable
-* field are reported.
-*
-* Segments without a known profile (e.g., Z-segments) are silently skipped.
+* Reads `repetitions` from `field.data`, so `@glion/annotate-profile-fields`
+* MUST run before it. A field whose `repetitions` is `"unbounded"` is never
+* reported.
 *
 * @example
 *   ```typescript
-*   unified().use(hl7v2LintFieldRepetition);
+*   unified()
+*     .use(hl7v2AnnotateProfileContext)
+*     .use(hl7v2AnnotateProfileFields)
+*     .use(hl7v2LintFieldRepetition);
 *   ```;
 */
-const hl7v2LintFieldRepetition = lintRule({ origin: "hl7v2-lint:field-repetition" }, (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;
-		visit(segment, "field", (fieldNode, _fieldAncestors, info) => {
-			const profile = fieldDef.bySequence.get(info.sequence);
-			if (!profile || profile.repeatable) return SKIP;
-			const count = fieldNode.children.length;
-			if (count > 1) {
-				const name = profile.name ? ` (${profile.name})` : "";
-				file.message(`Field ${segment.name}-${info.sequence}${name} is not repeatable but has ${count} repetitions`, {
-					ancestors: [
-						...segmentAncestors,
-						segment,
-						fieldNode
-					],
-					place: fieldNode.position
-				});
-			}
-			return SKIP;
+const hl7v2LintFieldRepetition = lintRule({
+	origin: "hl7v2-lint:field-repetition",
+	url: "https://github.com/rethinkhealth/glion/tree/main/packages/lint-profile-field-repetition#readme"
+}, (tree, file) => {
+	visit(tree, "field", (field, ancestors) => {
+		const id = field.data?.id;
+		const limit = field.data?.repetitions;
+		const count = field.children.length;
+		if (id === void 0 || typeof limit !== "number" || count <= limit) return SKIP;
+		const message = file.message(messages.tooManyRepetitions(id, field.data?.name ?? "", count, limit), {
+			ancestors: [...ancestors, field],
+			place: field.position
 		});
+		message.actual = String(count);
 		return SKIP;
 	});
 });

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 flags fields with multiple repetitions when the profile\n * declares `repeatable: false`.\n *\n * A field with a single repetition is always valid regardless of the\n * `repeatable` flag. Only fields with 2+ repetitions on a non-repeatable\n * field are reported.\n *\n * Segments without a known profile (e.g., Z-segments) are silently skipped.\n *\n * @example\n *   ```typescript\n *   unified().use(hl7v2LintFieldRepetition);\n *   ```;\n */\nconst hl7v2LintFieldRepetition = lintRule<Root>(\n  { origin: \"hl7v2-lint:field-repetition\" },\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      visit(segment, \"field\", (fieldNode, _fieldAncestors, info) => {\n        const profile = fieldDef.bySequence.get(info.sequence);\n\n        if (!profile || profile.repeatable) {\n          return SKIP;\n        }\n\n        const count = fieldNode.children.length;\n        if (count > 1) {\n          const name = profile.name ? ` (${profile.name})` : \"\";\n          file.message(\n            `Field ${segment.name}-${info.sequence}${name} is not repeatable but has ${count} repetitions`,\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\nexport default hl7v2LintFieldRepetition;\n"],"mappings":";;;;;;;;;;;;;;;;;;AAqBA,MAAM,2BAA2B,SAC/B,EAAE,QAAQ,+BAA+B,GACxC,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;AAGT,QAAM,SAAS,UAAU,WAAW,iBAAiB,SAAS;GAC5D,MAAM,UAAU,SAAS,WAAW,IAAI,KAAK,SAAS;AAEtD,OAAI,CAAC,WAAW,QAAQ,WACtB,QAAO;GAGT,MAAM,QAAQ,UAAU,SAAS;AACjC,OAAI,QAAQ,GAAG;IACb,MAAM,OAAO,QAAQ,OAAO,KAAK,QAAQ,KAAK,KAAK;AACnD,SAAK,QACH,SAAS,QAAQ,KAAK,GAAG,KAAK,WAAW,KAAK,6BAA6B,MAAM,eACjF;KACE,WAAW;MAAC,GAAG;MAAkB;MAAS;MAAU;KACpD,OAAO,UAAU;KAClB,CACF;;AAGH,UAAO;IACP;AAEF,SAAO;GACP;EAEL"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["// oxlint-disable-next-line no-unused-vars -- triggers FieldData augmentation\nimport type { hl7v2AnnotateProfileFields } from \"@glion/annotate-profile-fields\";\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  tooManyRepetitions: (\n    field: string,\n    name: string,\n    count: number,\n    max: number\n  ) =>\n    `Field \\`${field}\\` (${name}) has ${pluralize(\"repetition\", count, true)}; it allows at most ${pluralize(\"repetition\", max, true)}.`,\n} as const;\n\n/**\n * Lint rule that reports a field with more repetitions than its RP/# allows.\n *\n * Reads `repetitions` from `field.data`, so `@glion/annotate-profile-fields`\n * MUST run before it. A field whose `repetitions` is `\"unbounded\"` is never\n * reported.\n *\n * @example\n *   ```typescript\n *   unified()\n *     .use(hl7v2AnnotateProfileContext)\n *     .use(hl7v2AnnotateProfileFields)\n *     .use(hl7v2LintFieldRepetition);\n *   ```;\n */\nconst hl7v2LintFieldRepetition = lintRule<Root>(\n  {\n    origin: \"hl7v2-lint:field-repetition\",\n    url: \"https://github.com/rethinkhealth/glion/tree/main/packages/lint-profile-field-repetition#readme\",\n  },\n  (tree, file) => {\n    visit(tree, \"field\", (field, ancestors) => {\n      const id = field.data?.id;\n      const limit = field.data?.repetitions;\n      const count = field.children.length;\n      // A limit of \"unbounded\" is never exceeded.\n      if (id === undefined || typeof limit !== \"number\" || count <= limit) {\n        return SKIP;\n      }\n\n      const message = file.message(\n        messages.tooManyRepetitions(id, field.data?.name ?? \"\", count, limit),\n        { ancestors: [...ancestors, field], place: field.position }\n      );\n      message.actual = String(count);\n      return SKIP;\n    });\n  }\n);\n\nexport default hl7v2LintFieldRepetition;\n"],"mappings":";;;;AAOA,MAAM,WAAW,EACf,qBACE,OACA,MACA,OACA,QAEA,WAAW,MAAM,MAAM,KAAK,QAAQ,UAAU,cAAc,OAAO,KAAK,CAAC,sBAAsB,UAAU,cAAc,KAAK,KAAK,CAAC,IACrI;;;;;;;;;;;;;;;;AAiBD,MAAM,2BAA2B,SAC/B;CACE,QAAQ;CACR,KAAK;CACN,GACA,MAAM,SAAS;AACd,OAAM,MAAM,UAAU,OAAO,cAAc;EACzC,MAAM,KAAK,MAAM,MAAM;EACvB,MAAM,QAAQ,MAAM,MAAM;EAC1B,MAAM,QAAQ,MAAM,SAAS;AAE7B,MAAI,OAAO,KAAA,KAAa,OAAO,UAAU,YAAY,SAAS,MAC5D,QAAO;EAGT,MAAM,UAAU,KAAK,QACnB,SAAS,mBAAmB,IAAI,MAAM,MAAM,QAAQ,IAAI,OAAO,MAAM,EACrE;GAAE,WAAW,CAAC,GAAG,WAAW,MAAM;GAAE,OAAO,MAAM;GAAU,CAC5D;AACD,UAAQ,SAAS,OAAO,MAAM;AAC9B,SAAO;GACP;EAEL"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glion/lint-profile-field-repetition",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Lint rule that flags non-repeatable fields with multiple repetitions",
   "keywords": [
     "health",
@@ -33,12 +33,15 @@
     "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/annotate-profile-fields": "0.24.0",
+    "@glion/ast": "0.24.0",
+    "@glion/util-visit": "0.24.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,9 +49,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/annotate-profile-context": "0.24.0",
+    "@glion/builder": "0.24.0",
     "@glion/check-readme": "0.18.0",
+    "@glion/parser": "0.24.0",
     "@glion/testing": "0.18.0",
     "@glion/tsconfig": "0.18.0"
   },