hana-linter 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+### 1.4.0
+
+- Bumped package version metadata to `1.4.0` (`package.json` and `package-lock.json`)
+
+---
+
 ### 1.3.0
 
 - Added Chevrotain-based `.hdbtrigger` parser; content-linting of trigger names is now fully supported

package/dist/config.js

@@ -160,7 +160,15 @@ function isJsonLintConfig(value) {
     });
 }
 function isContentTarget(target) {
-    return target === 'field' || target === 'inputParameter' || target === 'outputParameter';
+    return (target === 'field' ||
+        target === 'inputParameter' ||
+        target === 'outputParameter' ||
+        target === 'roleName' ||
+        target === 'grantedRoleName' ||
+        target === 'sequenceName' ||
+        target === 'jobAction' ||
+        target === 'indexName' ||
+        target === 'triggerName');
 }
 function compileRuleGroup(groups, contextRoot) {
     const allRules = (groups.all ?? []).map((rule, index) => {

package/dist/config.test.d.ts

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

package/dist/config.test.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = require("node:fs");
+const node_os_1 = require("node:os");
+const node_path_1 = __importDefault(require("node:path"));
+const vitest_1 = require("vitest");
+const config_1 = require("./config");
+const supportedTargets = [
+    'field',
+    'inputParameter',
+    'outputParameter',
+    'roleName',
+    'grantedRoleName',
+    'sequenceName',
+    'jobAction',
+    'indexName',
+    'triggerName'
+];
+(0, vitest_1.describe)('readJsonConfig', () => {
+    (0, vitest_1.it)('accepts the bundled default configuration', async () => {
+        const configPath = node_path_1.default.resolve(process.cwd(), 'src/assets/.hana-linter.json');
+        await (0, vitest_1.expect)((0, config_1.readJsonConfig)(configPath)).resolves.toBeDefined();
+    });
+    vitest_1.it.each(supportedTargets)('accepts content target "%s"', async (target) => {
+        const tempDir = await node_fs_1.promises.mkdtemp(node_path_1.default.join((0, node_os_1.tmpdir)(), 'hana-linter-config-'));
+        const configPath = node_path_1.default.join(tempDir, '.hana-linter.json');
+        const config = {
+            rootDir: 'db',
+            ignoredDirectories: ['node_modules'],
+            extensionRuleSets: [
+                {
+                    extension: '*',
+                    groups: {
+                        all: [{ description: 'Any name', pattern: '.+' }]
+                    }
+                }
+            ],
+            contentRuleSets: [
+                {
+                    extension: '.hdbtable',
+                    target,
+                    groups: {
+                        all: [{ description: 'Any name', pattern: '.+' }]
+                    }
+                }
+            ]
+        };
+        await node_fs_1.promises.writeFile(configPath, JSON.stringify(config), 'utf-8');
+        await (0, vitest_1.expect)((0, config_1.readJsonConfig)(configPath)).resolves.toEqual(config);
+        await node_fs_1.promises.rm(tempDir, { recursive: true, force: true });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hana-linter",
-    "version": "1.3.0",
+    "version": "1.4.0",
     "description": "Linter for SAP HANA artifacts in an SAP CAP project",
     "main": "./dist/lib.js",
     "types": "./dist/lib.d.ts",

package/src/config.test.ts

@@ -0,0 +1,58 @@
+import { promises as fs } from 'node:fs';
+import { tmpdir } from 'node:os';
+import path from 'node:path';
+import { describe, expect, it } from 'vitest';
+import { readJsonConfig } from './config';
+import { ContentTarget, JsonLintConfig } from './types/rules';
+
+const supportedTargets: ContentTarget[] = [
+    'field',
+    'inputParameter',
+    'outputParameter',
+    'roleName',
+    'grantedRoleName',
+    'sequenceName',
+    'jobAction',
+    'indexName',
+    'triggerName'
+];
+
+describe('readJsonConfig', () => {
+    it('accepts the bundled default configuration', async () => {
+        const configPath = path.resolve(process.cwd(), 'src/assets/.hana-linter.json');
+        await expect(readJsonConfig(configPath)).resolves.toBeDefined();
+    });
+
+    it.each(supportedTargets)('accepts content target "%s"', async (target) => {
+        const tempDir = await fs.mkdtemp(path.join(tmpdir(), 'hana-linter-config-'));
+        const configPath = path.join(tempDir, '.hana-linter.json');
+
+        const config: JsonLintConfig = {
+            rootDir: 'db',
+            ignoredDirectories: ['node_modules'],
+            extensionRuleSets: [
+                {
+                    extension: '*',
+                    groups: {
+                        all: [{ description: 'Any name', pattern: '.+' }]
+                    }
+                }
+            ],
+            contentRuleSets: [
+                {
+                    extension: '.hdbtable',
+                    target,
+                    groups: {
+                        all: [{ description: 'Any name', pattern: '.+' }]
+                    }
+                }
+            ]
+        };
+
+        await fs.writeFile(configPath, JSON.stringify(config), 'utf-8');
+
+        await expect(readJsonConfig(configPath)).resolves.toEqual(config);
+
+        await fs.rm(tempDir, { recursive: true, force: true });
+    });
+});

package/src/config.ts

@@ -230,7 +230,17 @@ function isJsonLintConfig(value: unknown): value is JsonLintConfig {
 }
 
 function isContentTarget(target: unknown): target is ContentTarget {
-    return target === 'field' || target === 'inputParameter' || target === 'outputParameter';
+    return (
+        target === 'field' ||
+        target === 'inputParameter' ||
+        target === 'outputParameter' ||
+        target === 'roleName' ||
+        target === 'grantedRoleName' ||
+        target === 'sequenceName' ||
+        target === 'jobAction' ||
+        target === 'indexName' ||
+        target === 'triggerName'
+    );
 }
 
 function compileRuleGroup(groups: { all?: readonly JsonRuleDefinition[]; any?: readonly JsonRuleDefinition[] }, contextRoot: string): RuleGroup {