hana-linter 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+### 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
+
+---
+
+### 1.0.2
+
+- Added Chevrotain-based `.hdbfunction` parser; content-linting of function input parameters is now fully reliable
+- The `.hdbfunction` parser isolates the parameter list from the `RETURNS` clause and the function body (`AS BEGIN … END`), eliminating false positives caused by `IN` keywords inside SQL body statements and column names in `RETURNS TABLE (...)` definitions
+- HANA functions accept only `IN` parameters; the new parser correctly produces only `inputParameter` subjects and never emits `outputParameter` entries for `.hdbfunction` files
+- Removed the shared ad-hoc regex extractor (`extractProcedureFunctionParameters`) that was previously used for both `.hdbprocedure` and `.hdbfunction` files
+
+---
+
 ### 1.0.0
 
 - Replaced ad-hoc, line-by-line regex extraction with Chevrotain-based lexer + CST parsers for `.hdbtable`, `.hdbprocedure`, and `.hdbview` files

package/README.md

@@ -46,23 +46,22 @@ Content-based linting uses [Chevrotain](https://chevrotain.io)-powered lexers an
 
 > **Work in progress.** Not all artifact types have been migrated to the Chevrotain-based parsing infrastructure yet.
 
-| Artifact extension        | Content extractor      | Status             |
-| ------------------------- | ---------------------- | ------------------ |
-| `.hdbtable`               | Chevrotain lexer + CST | ✅ Migrated        |
-| `.hdbview`                | Chevrotain lexer + CST | ✅ Migrated        |
-| `.hdbprocedure`           | Chevrotain lexer + CST | ✅ Migrated        |
-| `.hdbfunction`            | Inline regex           | ⚠️ Needs migration |
-| `.hdbtabletype`           | —                      | ❌ Not implemented |
-| `.hdbcalculationview`     | —                      | ❌ Not implemented |
-| `.hdbanalyticalprivilege` | —                      | ❌ Not implemented |
-| `.hdbrole`                | —                      | ❌ Not implemented |
-| `.hdbsequence`            | —                      | ❌ Not implemented |
-| `.hdbconstraint`          | —                      | ❌ Not implemented |
-| `.hdbschedulerjob`        | —                      | ❌ Not implemented |
-| `.hdbindex`               | —                      | ❌ Not implemented |
-| `.hdbtrigger`             | —                      | ❌ Not implemented |
-
-- **Needs migration**: uses an ad-hoc regex scan, subject to false positives from body keywords, multi-line definitions, and block comments.
+| Artifact extension        | Content extractor      | Status                 |
+| ------------------------- | ---------------------- | ---------------------- |
+| `.hdbtable`               | Chevrotain lexer + CST | ✅ Migrated            |
+| `.hdbview`                | Chevrotain lexer + CST | ✅ Migrated            |
+| `.hdbprocedure`           | Chevrotain lexer + CST | ✅ Migrated            |
+| `.hdbfunction`            | Chevrotain lexer + CST | ✅ Migrated            |
+| `.hdbtabletype`           | —                      | ❌ Not yet implemented |
+| `.hdbcalculationview`     | —                      | ❌ Not yet implemented |
+| `.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 |
+
 - **Not implemented**: `contentRuleSets` targeting these extensions will silently return no results — no identifiers are extracted and no content issues are raised.
 
 ## Install
@@ -178,12 +177,13 @@ 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`, `.hdbfunction` | `IN` and `INOUT` parameters                    |
-| `outputParameter` | `.hdbprocedure`, `.hdbfunction` | `OUT` and `INOUT` parameters                   |
+| `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                   |
 
 ### Default Config Example
 

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

@@ -0,0 +1,224 @@
+{
+    "rootDir": "db",
+    "ignoredDirectories": ["node_modules", ".git", "gen"],
+    "extensionRuleSets": [
+        {
+            "extension": "hdb*",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Upper snake case only",
+                        "pattern": "^[A-Z0-9]+(?:_[A-Z0-9]+)*$"
+                    },
+                    {
+                        "description": "Max length 30",
+                        "pattern": "^.{1,30}$",
+                        "flags": "u"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbtable",
+            "folderName": "tables",
+            "groups": {
+                "any": [
+                    {
+                        "description": "Prefix T_",
+                        "pattern": "^T_.+"
+                    },
+                    {
+                        "description": "Prefix TX_",
+                        "pattern": "^TX_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbview",
+            "folderName": "sqlviews",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix V_",
+                        "pattern": "^V_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbfunction",
+            "folderName": "functions",
+            "groups": {
+                "any": [
+                    {
+                        "description": "Prefix TF_",
+                        "pattern": "^TF_.+"
+                    },
+                    {
+                        "description": "Prefix SF_",
+                        "pattern": "^SF_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbprocedure",
+            "folderName": "procedures",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix PR_",
+                        "pattern": "^PR_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbcalculationview",
+            "folderName": "models",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix CV_",
+                        "pattern": "^CV_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbanalyticalprivilege",
+            "folderName": "authorizations",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix AP_",
+                        "pattern": "^AP_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbrole",
+            "folderName": "roles",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix R_",
+                        "pattern": "^R_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbsequence",
+            "folderName": "sequences",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix S_",
+                        "pattern": "^S_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbtabletype",
+            "folderName": "tabletypes",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix TT_",
+                        "pattern": "^TT_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbconstraint",
+            "folderName": "constraints",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix C_",
+                        "pattern": "^C_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbschedulerjob",
+            "folderName": "jobs",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix J_",
+                        "pattern": "^J_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbindex",
+            "folderName": "indexes",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix IDX_",
+                        "pattern": "^IDX_.+"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbtrigger",
+            "folderName": "triggers",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Prefix TR_",
+                        "pattern": "^TR_.+"
+                    }
+                ]
+            }
+        }
+    ],
+    "contentRuleSets": [
+        {
+            "extension": ".hdbtable",
+            "target": "field",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Field names in uppercase snake case",
+                        "pattern": "^[A-Z0-9]+(?:_[A-Z0-9]+)*$"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbprocedure",
+            "target": "inputParameter",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Input parameters prefixed with IP_",
+                        "pattern": "^IP_[A-Z0-9_]+$"
+                    }
+                ]
+            }
+        },
+        {
+            "extension": ".hdbprocedure",
+            "target": "outputParameter",
+            "groups": {
+                "all": [
+                    {
+                        "description": "Output parameters prefixed with OP_",
+                        "pattern": "^OP_[A-Z0-9_]+$"
+                    }
+                ]
+            }
+        }
+    ]
+}

package/dist/content-lint.js

@@ -9,6 +9,7 @@ const node_path_1 = __importDefault(require("node:path"));
 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");
 /**
  * Run content-based naming lint for a file.
  *
@@ -55,36 +56,10 @@ function extractSubjects(extension, fileContent) {
         return (0, index_3.extractProcedureParameters)(fileContent);
     }
     if (extension === '.hdbfunction') {
-        return extractProcedureFunctionParameters(fileContent);
+        return (0, index_4.extractFunctionParameters)(fileContent);
     }
     return [];
 }
-function extractProcedureFunctionParameters(fileContent) {
-    const subjects = [];
-    const seen = new Set();
-    const parameterRegex = /\b(IN|OUT|INOUT)\s+("?[A-Za-z_][A-Za-z0-9_]*"?)\s+[A-Za-z]/gi;
-    let match = parameterRegex.exec(fileContent);
-    while (match) {
-        const mode = match[1];
-        const rawName = match[2];
-        if (!mode || !rawName) {
-            match = parameterRegex.exec(fileContent);
-            continue;
-        }
-        const normalizedMode = mode.toUpperCase();
-        const normalizedName = rawName.replace(/^"|"$/g, '');
-        if ((normalizedMode === 'IN' || normalizedMode === 'INOUT') && !seen.has(`input:${normalizedName}`)) {
-            seen.add(`input:${normalizedName}`);
-            subjects.push({ type: 'inputParameter', name: normalizedName });
-        }
-        if ((normalizedMode === 'OUT' || normalizedMode === 'INOUT') && !seen.has(`output:${normalizedName}`)) {
-            seen.add(`output:${normalizedName}`);
-            subjects.push({ type: 'outputParameter', name: normalizedName });
-        }
-        match = parameterRegex.exec(fileContent);
-    }
-    return subjects;
-}
 function evaluateAllRules(filePath, extension, subject, rules) {
     const issues = [];
     for (const rule of rules) {