hana-linter 1.0.3 → 1.2.0

package/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+### 1.1.0
+
+- Console output is now grouped by file, then by failed rule, reducing noise when multiple violations exist in the same file
+- Added line numbers to content-lint violations (fields, input/output parameters) so users can jump directly to the offending identifier in their editor
+- All four Chevrotain visitors (`hdbtable`, `hdbview`, `hdbprocedure`, `hdbfunction`) now capture `token.startLine` from the parsed token and propagate it through `ExtractedSubject` and `LintIssue`
+
+---
+
 ### 1.0.3
 
 - Fixed build: `src/assets/.hana-linter.json` is now correctly copied to `dist/assets/` during `pnpm build` via `copyfiles`, ensuring the default config template is bundled in the published package

package/README.md

@@ -9,7 +9,7 @@ Naming-convention lint for SAP HANA artifacts in CAP projects.
 
 > **⚠️ Work in progress.** This project is under active development. APIs, configuration options, and supported artifact types may change between releases. See [Parser Status](#parser-status) for the current state of content extraction support.
 
-[NPM package](https://www.npmjs.com/package/hana-linter) • [Report issue](https://github.com/qualiture/hana-linter/issues) • [Releases](https://github.com/qualiture/hana-linter/releases)
+[NPM package](https://www.npmjs.com/package/hana-linter) • [Report issue](https://github.com/qualiture/hana-linter/issues)
 
 Lint SAP HANA artifact file names and content identifiers in CAP projects using configurable regex-based naming rules.
 
@@ -40,7 +40,7 @@ Rule groups per extension:
 
 You can define `extension: "*"` as a shared rule set. Its rules are applied to every file extension and are merged with any extension-specific rule set.
 
-Content-based linting uses [Chevrotain](https://chevrotain.io)-powered lexers and CST parsers to reliably extract identifiers from HANA artifact files. This approach correctly handles block and line comments, multi-line definitions, quoted identifiers, and HANA-specific DDL constructs — without the false positives and false negatives that ad-hoc regex scanning produces.
+Content-based linting uses purpose-built parsers to reliably extract identifiers from HANA artifact files. SQL DDL artifact types (`.hdbtable`, `.hdbview`, `.hdbprocedure`, `.hdbfunction`, `.hdbtabletype`, `.hdbrole`) use [Chevrotain](https://chevrotain.io)-powered lexers and CST parsers that correctly handle block and line comments, multi-line definitions, quoted identifiers, and HANA-specific DDL constructs. The XML-based `.hdbcalculationview` format uses [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) to navigate the logical model tree — without the false positives and false negatives that ad-hoc regex scanning produces.
 
 ## Parser Status
 
@@ -52,16 +52,17 @@ Content-based linting uses [Chevrotain](https://chevrotain.io)-powered lexers an
 | `.hdbview`                | Chevrotain lexer + CST | ✅ Migrated            |
 | `.hdbprocedure`           | Chevrotain lexer + CST | ✅ Migrated            |
 | `.hdbfunction`            | Chevrotain lexer + CST | ✅ Migrated            |
-| `.hdbtabletype`           | —                      | ❌ Not yet implemented |
-| `.hdbcalculationview`     | —                      | ❌ Not yet implemented |
+| `.hdbtabletype`           | Chevrotain lexer + CST | ✅ Migrated            |
+| `.hdbrole`                | Chevrotain lexer + CST | ✅ Migrated            |
+| `.hdbcalculationview`     | fast-xml-parser (XML)  | ✅ Migrated            |
 | `.hdbanalyticalprivilege` | —                      | ❌ Not yet implemented |
-| `.hdbrole`                | —                      | ❌ Not yet implemented |
 | `.hdbsequence`            | —                      | ❌ Not yet implemented |
 | `.hdbconstraint`          | —                      | ❌ Not yet implemented |
 | `.hdbschedulerjob`        | —                      | ❌ Not yet implemented |
 | `.hdbindex`               | —                      | ❌ Not yet implemented |
 | `.hdbtrigger`             | —                      | ❌ Not yet implemented |
 
+- The regex **file name** validations for all of the above listed extensions **are implemented**. The **content extractor** hasn't been implemented everywhere yet.
 - **Not implemented**: `contentRuleSets` targeting these extensions will silently return no results — no identifiers are extracted and no content issues are raised.
 
 ## Install
@@ -177,13 +178,18 @@ Each `contentRuleSets` item contains:
 
 Supported extractors in this version:
 
-| `target`          | Supported extensions | Extracted identifiers                          |
-| ----------------- | -------------------- | ---------------------------------------------- |
-| `field`           | `.hdbtable`          | Column names                                   |
-| `field`           | `.hdbview`           | Column aliases (explicit list or `AS` aliases) |
-| `inputParameter`  | `.hdbprocedure`      | `IN` and `INOUT` parameters                    |
-| `inputParameter`  | `.hdbfunction`       | `IN` parameters (functions accept `IN` only)   |
-| `outputParameter` | `.hdbprocedure`      | `OUT` and `INOUT` parameters                   |
+| `target`          | Supported extensions  | Extracted identifiers                                                         |
+| ----------------- | --------------------- | ----------------------------------------------------------------------------- |
+| `field`           | `.hdbtable`           | Column names                                                                  |
+| `field`           | `.hdbview`            | Column aliases (explicit list or `AS` aliases)                                |
+| `field`           | `.hdbtabletype`       | Column names                                                                  |
+| `inputParameter`  | `.hdbprocedure`       | `IN` and `INOUT` parameters                                                   |
+| `inputParameter`  | `.hdbfunction`        | `IN` parameters (functions accept `IN` only)                                  |
+| `outputParameter` | `.hdbprocedure`       | `OUT` and `INOUT` parameters                                                  |
+| `roleName`        | `.hdbrole`            | The role name defined in the file                                             |
+| `grantedRoleName` | `.hdbrole`            | Each role listed in `extends roles { ... }`                                   |
+| `field`           | `.hdbcalculationview` | Output attributes, calculated attributes, base/calculated/restricted measures |
+| `inputParameter`  | `.hdbcalculationview` | Input parameters (`variable[@parameter="true"]`)                              |
 
 ### Default Config Example
 
@@ -284,6 +290,66 @@ Supported extractors in this version:
                     }
                 ]
             }
+        },
+        {
+            "extension": ".hdbfunction",
+            "target": "inputParameter",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Input parameters prefixed with IP_",
+                        "pattern": "^IP_[A-Z0-9_]+$"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbtabletype",
+            "target": "field",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Field names in uppercase snake case",
+                        "pattern": "^[A-Z0-9]+(?:_[A-Z0-9]+)*$"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbrole",
+            "target": "roleName",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Role names prefixed with R_",
+                        "pattern": "^R_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbcalculationview",
+            "target": "field",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Output column IDs in uppercase snake case",
+                        "pattern": "^[A-Z0-9]+(?:_[A-Z0-9]+)*$"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbcalculationview",
+            "target": "inputParameter",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Input parameters prefixed with IP_",
+                        "pattern": "^IP_[A-Z0-9_]+$"
+                    }
+                ]
+            }
         }
     ]
 }
@@ -314,6 +380,43 @@ jobs:
 			- run: npx hana-linter
 ```
 
+## Pre-commit Hook (husky + lint-staged)
+
+hana-linter's file-list mode (passing files as arguments) integrates cleanly with [lint-staged](https://github.com/lint-staged/lint-staged): lint-staged appends each staged file that matches the glob to the command, so only the files you are about to commit are linted.
+
+**1. Install the tools**
+
+```bash
+npm install --save-dev husky lint-staged
+npx husky init
+```
+
+**2. Configure lint-staged**
+
+Add a `lint-staged` key to `package.json`:
+
+```json
+{
+    "lint-staged": {
+        "*.hdb*": "hana-linter"
+    }
+}
+```
+
+lint-staged turns this into `hana-linter <file1> <file2> …` for every staged file that matches the glob, which is exactly the file-list mode hana-linter supports.
+
+**3. Wire the pre-commit hook**
+
+Replace the contents of `.husky/pre-commit` with:
+
+```bash
+npx lint-staged
+```
+
+Now, every `git commit` will automatically run hana-linter against the staged HANA artifact files. If any naming violations are found, the commit is blocked and the issues are reported in the terminal.
+
+> **Tip:** Add `hana-linter` to `dependencies` (not `devDependencies`) if the linter also runs in production CI, so it is available after a plain `npm ci --production` install. For pre-commit-only use, `devDependencies` is fine.
+
 ## Requirements
 
 - Node.js >= 14

package/dist/assets/.hana-linter.json

@@ -219,6 +219,78 @@
                     }
                 ]
             }
+        },
+        {
+            "extension": ".hdbview",
+            "target": "field",
+            "groups": {
+                "all": [
+                    {
+                        "description": "View column aliases in uppercase snake case",
+                        "pattern": "^[A-Z0-9]+(?:_[A-Z0-9]+)*$"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbfunction",
+            "target": "inputParameter",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Input parameters prefixed with IP_",
+                        "pattern": "^IP_[A-Z0-9_]+$"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbtabletype",
+            "target": "field",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Field names in uppercase snake case",
+                        "pattern": "^[A-Z0-9]+(?:_[A-Z0-9]+)*$"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbrole",
+            "target": "roleName",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Role names prefixed with R_",
+                        "pattern": "^R_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbcalculationview",
+            "target": "field",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Output column IDs in uppercase snake case",
+                        "pattern": "^[A-Z0-9]+(?:_[A-Z0-9]+)*$"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbcalculationview",
+            "target": "inputParameter",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Input parameters prefixed with IP_",
+                        "pattern": "^IP_[A-Z0-9_]+$"
+                    }
+                ]
+            }
         }
     ]
 }

package/dist/cli.d.ts

@@ -0,0 +1,17 @@
+import { CliInput } from './types/cli';
+/**
+ * Parse command-line arguments.
+ *
+ * Supported:
+ * - --config <path>
+ * - remaining arguments are treated as file paths
+ *
+ * @returns Parsed CLI input.
+ */
+export declare function parseCliInput(): CliInput;
+/**
+ * Create .hana-linter.json in current working directory from bundled template.
+ *
+ * @param force - Overwrite existing file when true.
+ */
+export declare function runInit(force: boolean): Promise<void>;

package/dist/config.d.ts

@@ -0,0 +1,16 @@
+import { LintConfig } from './types/config';
+import { JsonLintConfig } from './types/rules';
+/**
+ * Read and parse JSON config file.
+ *
+ * @param configPath - Path to JSON configuration.
+ * @returns Parsed JSON config object.
+ */
+export declare function readJsonConfig(configPath: string): Promise<JsonLintConfig>;
+/**
+ * Convert JSON config into runtime compiled config.
+ *
+ * @param jsonConfig - Parsed JSON config.
+ * @returns Runtime lint config with compiled regex.
+ */
+export declare function toLintConfig(jsonConfig: JsonLintConfig): LintConfig;

package/dist/content-lint.d.ts

@@ -0,0 +1,10 @@
+import { LintIssue } from './types/issues';
+import { ContentRuleSet } from './types/rules';
+/**
+ * Run content-based naming lint for a file.
+ *
+ * @param filePath - Candidate file path.
+ * @param contentRuleSets - Configured content rule sets.
+ * @returns List of content-based lint issues.
+ */
+export declare function lintFileContent(filePath: string, contentRuleSets: readonly ContentRuleSet[]): Promise<LintIssue[]>;

package/dist/content-lint.js

@@ -10,6 +10,9 @@ const index_1 = require("./parsers/hdbtable/index");
 const index_2 = require("./parsers/hdbview/index");
 const index_3 = require("./parsers/hdbprocedure/index");
 const index_4 = require("./parsers/hdbfunction/index");
+const index_5 = require("./parsers/hdbtabletype/index");
+const index_6 = require("./parsers/hdbrole/index");
+const index_7 = require("./parsers/hdbcalculationview/index");
 /**
  * Run content-based naming lint for a file.
  *
@@ -58,6 +61,15 @@ function extractSubjects(extension, fileContent) {
     if (extension === '.hdbfunction') {
         return (0, index_4.extractFunctionParameters)(fileContent);
     }
+    if (extension === '.hdbtabletype') {
+        return (0, index_5.extractTableTypeColumns)(fileContent);
+    }
+    if (extension === '.hdbrole') {
+        return (0, index_6.extractRoleNames)(fileContent);
+    }
+    if (extension === '.hdbcalculationview') {
+        return (0, index_7.extractCalculationViewOutputs)(fileContent);
+    }
     return [];
 }
 function evaluateAllRules(filePath, extension, subject, rules) {
@@ -70,6 +82,7 @@ function evaluateAllRules(filePath, extension, subject, rules) {
                 extension,
                 subjectType: subject.type,
                 subjectName: subject.name,
+                lineNumber: subject.lineNumber,
                 failedRuleDescription: rule.description,
                 failedPattern: toRegexLiteral(rule)
             });
@@ -89,6 +102,7 @@ function evaluateAnyRules(filePath, extension, subject, rules) {
             extension,
             subjectType: subject.type,
             subjectName: subject.name,
+            lineNumber: subject.lineNumber,
             failedRuleDescription: 'At least one OR-group rule must match: ' + rules.map((rule) => rule.description).join(' | '),
             failedPattern: rules.map(toRegexLiteral).join(' OR ')
         }

package/dist/files.d.ts

@@ -0,0 +1,12 @@
+import { CliInput } from './types/cli';
+import { LintConfig } from './types/config';
+/**
+ * Resolve files to validate:
+ * - If CLI files are provided: use only existing files from that list.
+ * - If none are provided: run full scan from rootDir.
+ *
+ * @param config - Lint configuration.
+ * @param cliInput - Parsed CLI input.
+ * @returns List of file paths to validate.
+ */
+export declare function resolveFilesToValidate(config: LintConfig, cliInput: CliInput): Promise<string[]>;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/lib.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Public library API for hana-linter.
+ *
+ * Import this entry point when using hana-linter programmatically
+ * (e.g. from a VS Code extension). The CLI remains available via the
+ * `hana-linter` binary.
+ */
+export { runLint } from './lint';
+export { lintFileContent } from './content-lint';
+export { readJsonConfig, toLintConfig } from './config';
+export type { LintIssue, ExtractedSubject } from './types/issues';
+export type { LintConfig } from './types/config';
+export type { JsonLintConfig, JsonExtensionRuleSet, JsonContentRuleSet, JsonRuleDefinition, JsonRuleGroup, ContentTarget } from './types/rules';

package/dist/lib.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Public library API for hana-linter.
+ *
+ * Import this entry point when using hana-linter programmatically
+ * (e.g. from a VS Code extension). The CLI remains available via the
+ * `hana-linter` binary.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toLintConfig = exports.readJsonConfig = exports.lintFileContent = exports.runLint = void 0;
+var lint_1 = require("./lint");
+Object.defineProperty(exports, "runLint", { enumerable: true, get: function () { return lint_1.runLint; } });
+var content_lint_1 = require("./content-lint");
+Object.defineProperty(exports, "lintFileContent", { enumerable: true, get: function () { return content_lint_1.lintFileContent; } });
+var config_1 = require("./config");
+Object.defineProperty(exports, "readJsonConfig", { enumerable: true, get: function () { return config_1.readJsonConfig; } });
+Object.defineProperty(exports, "toLintConfig", { enumerable: true, get: function () { return config_1.toLintConfig; } });

package/dist/lint.d.ts

@@ -0,0 +1,10 @@
+import { LintIssue } from './types/issues';
+import { LintConfig } from './types/config';
+/**
+ * Run naming lint and return all discovered issues.
+ *
+ * @param config - Lint configuration.
+ * @param filesToValidate - File paths to validate.
+ * @returns All naming violations.
+ */
+export declare function runLint(config: LintConfig, filesToValidate: readonly string[]): Promise<LintIssue[]>;

package/dist/parsers/hdbcalculationview/__tests__/extractCalculationViewOutputs.test.d.ts

@@ -0,0 +1 @@
+export {};