@glion/lint-segment-header-length 0.22.0 → 0.23.0

package/README.md

@@ -37,7 +37,7 @@ console.error(reporter([file]));
 
 A `unified` lint rule plugin. Takes no options.
 
-Visits every `segment` node and reports one message per segment whose `name.length !== 3`. The reported text names how many characters to add or remove to reach the three-character target.
+Visits every `segment` node and reports one message per segment whose Segment ID is not three characters long, with `actual` set to the Segment ID.
 
 ```ts
 import type { Plugin } from "unified";
@@ -72,7 +72,7 @@ PID1|1||PATID1234^^^HOSP^MR||DOE^JANE||19800101|F
 Reported message:
 
 ```
-Unexpected 4 header length, expected 3 characters, remove 1 character
+The Segment ID `PID1` is 4 characters long; a Segment ID must be exactly 3 characters.
 ```
 
 A two-character segment name:
@@ -84,10 +84,16 @@ MS|^~\&|...
 Reported message:
 
 ```
-Unexpected 2 header length, expected 3 characters, add 1 character
+The Segment ID `MS` is 2 characters long; a Segment ID must be exactly 3 characters.
 ```
 
-The delta between the actual length and three is interpolated with pluralization (`remove 1 character`, `add 2 characters`). One message is reported per offending segment.
+A segment with an empty Segment ID, such as a line that starts with the field separator, is reported as:
+
+```
+The segment has an empty Segment ID; a Segment ID must be exactly 3 characters.
+```
+
+One message is reported per offending segment.
 
 ## Part of Glion
 

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAKvC;;GAEG;AACH,QAAA,MAAM,4BAA4B,qDAuBjC,CAAC;AAEF,eAAe,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAYvC;;GAEG;AACH,QAAA,MAAM,4BAA4B,qDA2BjC,CAAC;AAEF,eAAe,4BAA4B,CAAC"}

package/dist/index.js

@@ -2,20 +2,32 @@ import pluralize from "pluralize";
 import { lintRule } from "unified-lint-rule";
 import { SKIP, visitParents } from "unist-util-visit-parents";
 //#region src/index.ts
+const messages = {
+	emptySegmentId: "The segment has an empty Segment ID; a Segment ID must be exactly 3 characters.",
+	segmentIdLength: (segmentId) => `The Segment ID \`${segmentId}\` is ${pluralize("character", segmentId.length, true)} long; a Segment ID must be exactly 3 characters.`
+};
 /**
 * Hl7v2-lint rule to warn when segment header length is invalid.
 */
 const hl7v2LintSegmentHeaderLength = lintRule({
 	origin: "hl7v2-lint:segment-header-length",
-	url: "https://github.com/rethinkhealth/hl7v2/tree/main/packages/hl7v2-lint-segment-header-length#readme"
+	url: "https://github.com/rethinkhealth/glion/tree/main/packages/lint-segment-header-length#readme"
 }, (tree, file) => {
 	visitParents(tree, "segment", (node, parents) => {
-		const size = node.name.length;
-		if (size === 3) return SKIP;
-		file.message(`Unexpected ${size} header length, expected 3 characters, ${size > 3 ? `remove ${size - 3} ${pluralize("character", size - 3)}` : `add ${3 - size} ${pluralize("character", 3 - size)}`}`, {
+		if (node.name.length === 3) return SKIP;
+		if (node.name === "") {
+			const message = file.message(messages.emptySegmentId, {
+				ancestors: [...parents, node],
+				place: node.position
+			});
+			message.actual = "";
+			return SKIP;
+		}
+		const message = file.message(messages.segmentIdLength(node.name), {
 			ancestors: [...parents, node],
 			place: node.position
 		});
+		message.actual = node.name;
 	});
 });
 //#endregion

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { Root } from \"@glion/ast\";\nimport pluralize from \"pluralize\";\nimport { lintRule } from \"unified-lint-rule\";\nimport { SKIP, visitParents } from \"unist-util-visit-parents\";\n\n/**\n * Hl7v2-lint rule to warn when segment header length is invalid.\n */\nconst hl7v2LintSegmentHeaderLength = lintRule<Root, undefined>(\n  {\n    origin: \"hl7v2-lint:segment-header-length\",\n    url: \"https://github.com/rethinkhealth/hl7v2/tree/main/packages/hl7v2-lint-segment-header-length#readme\",\n  },\n  (tree, file) => {\n    visitParents<Root, \"segment\">(tree, \"segment\", (node, parents) => {\n      const size = node.name.length;\n\n      if (size === 3) {\n        return SKIP;\n      }\n\n      file.message(\n        `Unexpected ${size} header length, expected 3 characters, ${\n          size > 3\n            ? `remove ${size - 3} ${pluralize(\"character\", size - 3)}`\n            : `add ${3 - size} ${pluralize(\"character\", 3 - size)}`\n        }`,\n        { ancestors: [...parents, node], place: node.position }\n      );\n    });\n  }\n);\n\nexport default hl7v2LintSegmentHeaderLength;\n"],"mappings":";;;;;;;AAQA,MAAM,+BAA+B,SACnC;CACE,QAAQ;CACR,KAAK;CACN,GACA,MAAM,SAAS;AACd,cAA8B,MAAM,YAAY,MAAM,YAAY;EAChE,MAAM,OAAO,KAAK,KAAK;AAEvB,MAAI,SAAS,EACX,QAAO;AAGT,OAAK,QACH,cAAc,KAAK,yCACjB,OAAO,IACH,UAAU,OAAO,EAAE,GAAG,UAAU,aAAa,OAAO,EAAE,KACtD,OAAO,IAAI,KAAK,GAAG,UAAU,aAAa,IAAI,KAAK,MAEzD;GAAE,WAAW,CAAC,GAAG,SAAS,KAAK;GAAE,OAAO,KAAK;GAAU,CACxD;GACD;EAEL"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { Root } from \"@glion/ast\";\nimport pluralize from \"pluralize\";\nimport { lintRule } from \"unified-lint-rule\";\nimport { SKIP, visitParents } from \"unist-util-visit-parents\";\n\nconst messages = {\n  emptySegmentId:\n    \"The segment has an empty Segment ID; a Segment ID must be exactly 3 characters.\",\n  segmentIdLength: (segmentId: string) =>\n    `The Segment ID \\`${segmentId}\\` is ${pluralize(\"character\", segmentId.length, true)} long; a Segment ID must be exactly 3 characters.`,\n} as const;\n\n/**\n * Hl7v2-lint rule to warn when segment header length is invalid.\n */\nconst hl7v2LintSegmentHeaderLength = lintRule<Root, undefined>(\n  {\n    origin: \"hl7v2-lint:segment-header-length\",\n    url: \"https://github.com/rethinkhealth/glion/tree/main/packages/lint-segment-header-length#readme\",\n  },\n  (tree, file) => {\n    visitParents<Root, \"segment\">(tree, \"segment\", (node, parents) => {\n      if (node.name.length === 3) {\n        return SKIP;\n      }\n\n      if (node.name === \"\") {\n        const message = file.message(messages.emptySegmentId, {\n          ancestors: [...parents, node],\n          place: node.position,\n        });\n        message.actual = \"\";\n        return SKIP;\n      }\n\n      const message = file.message(messages.segmentIdLength(node.name), {\n        ancestors: [...parents, node],\n        place: node.position,\n      });\n      message.actual = node.name;\n    });\n  }\n);\n\nexport default hl7v2LintSegmentHeaderLength;\n"],"mappings":";;;;AAKA,MAAM,WAAW;CACf,gBACE;CACF,kBAAkB,cAChB,oBAAoB,UAAU,QAAQ,UAAU,aAAa,UAAU,QAAQ,KAAK,CAAC;CACxF;;;;AAKD,MAAM,+BAA+B,SACnC;CACE,QAAQ;CACR,KAAK;CACN,GACA,MAAM,SAAS;AACd,cAA8B,MAAM,YAAY,MAAM,YAAY;AAChE,MAAI,KAAK,KAAK,WAAW,EACvB,QAAO;AAGT,MAAI,KAAK,SAAS,IAAI;GACpB,MAAM,UAAU,KAAK,QAAQ,SAAS,gBAAgB;IACpD,WAAW,CAAC,GAAG,SAAS,KAAK;IAC7B,OAAO,KAAK;IACb,CAAC;AACF,WAAQ,SAAS;AACjB,UAAO;;EAGT,MAAM,UAAU,KAAK,QAAQ,SAAS,gBAAgB,KAAK,KAAK,EAAE;GAChE,WAAW,CAAC,GAAG,SAAS,KAAK;GAC7B,OAAO,KAAK;GACb,CAAC;AACF,UAAQ,SAAS,KAAK;GACtB;EAEL"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glion/lint-segment-header-length",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "hl7v2-lint rule to warn when segment header length is invalid",
   "keywords": [
     "definition",
@@ -51,8 +51,8 @@
     "typescript": "6.0.3",
     "vfile": "^6.0.3",
     "vitest": "4.1.11",
-    "@glion/builder": "0.22.0",
-    "@glion/ast": "0.22.0",
+    "@glion/ast": "0.23.0",
+    "@glion/builder": "0.23.0",
     "@glion/check-readme": "0.18.0",
     "@glion/testing": "0.18.0",
     "@glion/tsconfig": "0.18.0"