@glion/preset-lint-recommended 0.14.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rethink Health
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,81 @@
+# @glion/preset-lint-recommended
+
+**Preset of linting rules for HL7v2**, built on top of the [`unified`][github-unified] ecosystem.
+
+This preset is meant as a recommended baseline for catching common HL7v2 issues, such as segment structure, field length, and delimiter usage.
+
+## What is this?
+
+This package provides a **recommended set of HL7v2 linting rules**. It ensures a consistent baseline of message quality checks when processing HL7v2 messages with [`unified`][github-unified] and [`@glion/parser`][github-hl7v2-parser].
+
+Think of it like ESLint’s "recommended" rules, but for HL7v2.
+
+## When should I use this?
+
+Use this preset if you:
+
+- Want a **sensible default** for linting HL7v2 messages
+- Need a **starting point** for building custom HL7v2 lint configurations
+- Are using the [`hl7v2-parser`][github-hl7v2-parser] and want to catch common mistakes
+
+It is intended as a **minimum recommended set**. You can extend or override rules in your own configs.
+
+## Install
+
+```sh
+npm install @glion/preset-lint-recommended
+```
+
+## Use
+
+```typescript
+import { unified } from "unified";
+import parse from "@glion/parser";
+import lint from "@glion/lint";
+import recommended from "@glion/preset-lint-recommended";
+
+const file = await unified()
+  .use(parse)
+  .use(lint)
+  .use(recommended)
+  .process("MSH|^~\\&|...");
+```
+
+## Presets
+
+This preset bundles a set of **recommended HL7v2 linting rules**.  
+Each rule has a default severity and may expose configuration options.
+
+| Rule                                                                      | Options | Default Severity |
+| ------------------------------------------------------------------------- | ------- | ---------------- |
+| [`hl7v2-lint-segment-header-length`](../hl7v2-lint-segment-header-length) | _none_  | `error`          |
+
+## Security
+
+This plugin only transforms AST nodes and does not execute code. Ensure you trust the source of HL7v2 messages before processing.
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide][github-contributing] for more details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Code of Conduct
+
+To ensure a welcoming and positive environment, we have a [Code of Conduct][github-code-of-conduct] that all contributors and participants are expected to adhere to.
+
+## License
+
+Copyright 2025 Rethink Health, SUARL. All rights reserved.
+
+This program is licensed to you under the terms of the [MIT License](https://opensource.org/licenses/MIT). This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [LICENSE][github-license] file for details.
+
+[github-code-of-conduct]: https://github.com/rethinkhealth/glion/blob/main/CODE_OF_CONDUCT.md
+[github-license]: https://github.com/rethinkhealth/glion/blob/main/LICENSE
+[github-contributing]: https://github.com/rethinkhealth/glion/blob/main/CONTRIBUTING.md
+[github-unified]: https://github.com/unifiedjs/unified
+[github-hl7v2-parser]: https://github.com/rethinkhealth/glion/tree/main/packages/hl7v2-parser

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import type { Preset } from "unified";
+/**
+ * Preset of hl7v2-lint rules to warn for likely problems.
+ *
+ * ## What is this?
+ *
+ * This package is a preset containing `hl7v2-lint` rules.
+ * Lint rules check hl7v2 basic rules.
+ *
+ * ## When should I use this?
+ *
+ * You can use this package to check that hl7v2 follows some best practices.
+ *
+ * ## API
+ *
+ * ### `unified().use(hl7v2PresetLintRecommended)`
+ *
+ * Check that hl7v2 follows some best practices.
+ *
+ * You can reconfigure rules in the preset by using them afterwards with
+ * different options.
+ */
+declare const hl7v2PresetLintRecommended: Preset;
+export default hl7v2PresetLintRecommended;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,QAAA,MAAM,0BAA0B,EAAE,MAQjC,CAAC;AAEF,eAAe,0BAA0B,CAAC"}

package/dist/index.js

@@ -0,0 +1,36 @@
+import hl7v2LintMessageVersion from "@glion/lint-message-version";
+import hl7v2LintNoTrailingEmptyField from "@glion/lint-no-trailing-empty-field";
+import hl7v2LintRequiredMessageHeader from "@glion/lint-required-message-header";
+import hl7v2LintSegmentHeaderLength from "@glion/lint-segment-header-length";
+//#region src/index.ts
+/**
+* Preset of hl7v2-lint rules to warn for likely problems.
+*
+* ## What is this?
+*
+* This package is a preset containing `hl7v2-lint` rules.
+* Lint rules check hl7v2 basic rules.
+*
+* ## When should I use this?
+*
+* You can use this package to check that hl7v2 follows some best practices.
+*
+* ## API
+*
+* ### `unified().use(hl7v2PresetLintRecommended)`
+*
+* Check that hl7v2 follows some best practices.
+*
+* You can reconfigure rules in the preset by using them afterwards with
+* different options.
+*/
+const hl7v2PresetLintRecommended = { plugins: [
+	[hl7v2LintSegmentHeaderLength, ["error"]],
+	[hl7v2LintRequiredMessageHeader, ["error"]],
+	[hl7v2LintMessageVersion, ["error"]],
+	hl7v2LintNoTrailingEmptyField
+] };
+//#endregion
+export { hl7v2PresetLintRecommended as default };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import hl7v2LintMessageVersion from \"@glion/lint-message-version\";\nimport hl7v2LintNoTrailingEmptyField from \"@glion/lint-no-trailing-empty-field\";\nimport hl7v2LintRequiredMessageHeader from \"@glion/lint-required-message-header\";\nimport hl7v2LintSegmentHeaderLength from \"@glion/lint-segment-header-length\";\nimport type { Preset } from \"unified\";\n\n/**\n * Preset of hl7v2-lint rules to warn for likely problems.\n *\n * ## What is this?\n *\n * This package is a preset containing `hl7v2-lint` rules.\n * Lint rules check hl7v2 basic rules.\n *\n * ## When should I use this?\n *\n * You can use this package to check that hl7v2 follows some best practices.\n *\n * ## API\n *\n * ### `unified().use(hl7v2PresetLintRecommended)`\n *\n * Check that hl7v2 follows some best practices.\n *\n * You can reconfigure rules in the preset by using them afterwards with\n * different options.\n */\nconst hl7v2PresetLintRecommended: Preset = {\n  plugins: [\n    // segment linting rules\n    [hl7v2LintSegmentHeaderLength, [\"error\"]],\n    [hl7v2LintRequiredMessageHeader, [\"error\"]],\n    [hl7v2LintMessageVersion, [\"error\"]],\n    hl7v2LintNoTrailingEmptyField,\n  ],\n};\n\nexport default hl7v2PresetLintRecommended;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,MAAM,6BAAqC,EACzC,SAAS;CAEP,CAAC,8BAA8B,CAAC,QAAQ,CAAC;CACzC,CAAC,gCAAgC,CAAC,QAAQ,CAAC;CAC3C,CAAC,yBAAyB,CAAC,QAAQ,CAAC;CACpC;CACD,EACF"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@glion/preset-lint-recommended",
+  "version": "0.14.1",
+  "description": "hl7v2-lint preset with recommended rules",
+  "keywords": [
+    "definition",
+    "hl7",
+    "hl7v2",
+    "hl7v2-lint",
+    "hl7v2-lint-rule",
+    "lint",
+    "nodejs",
+    "rule",
+    "typescript"
+  ],
+  "homepage": "https://glion.dev",
+  "license": "MIT",
+  "author": {
+    "name": "Melek Somai",
+    "email": "melek@rethinkhealth.io"
+  },
+  "repository": "rethinkhealth/glion.git",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "unified": "11.0.5",
+    "unified-lint-rule": "3.0.1",
+    "@glion/lint-required-message-header": "0.14.1",
+    "@glion/lint-message-version": "0.14.1",
+    "@glion/lint-no-trailing-empty-field": "0.14.1",
+    "@glion/lint-segment-header-length": "0.14.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "@types/unist": "^3.0.3",
+    "@vitest/coverage-v8": "4.1.2",
+    "tsdown": "0.21.7",
+    "typescript": "^5.9.3",
+    "vfile": "^6.0.3",
+    "vfile-reporter": "^8.1.1",
+    "vitest": "4.1.2",
+    "@glion/builder": "0.14.1",
+    "@glion/ast": "0.14.1",
+    "@glion/jsonify": "0.14.1",
+    "@glion/testing": "0.0.2",
+    "@glion/parser": "0.14.1",
+    "@glion/tsconfig": "0.0.1"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsdown && tsc --emitDeclarationOnly",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
+  }
+}