@featurevisor/core 2.12.0 → 2.13.0

package/lib/linter/lintProject.spec.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const projectConfig_1 = require("../config/projectConfig");
+const datasource_1 = require("../datasource");
+const lintProject_1 = require("./lintProject");
+function createTempProjectFromExample1() {
+    const fixturePath = path.resolve(__dirname, "../../../../examples/example-1");
+    const tempRoot = fs.mkdtempSync(path.join(os.tmpdir(), "featurevisor-lint-"));
+    fs.cpSync(fixturePath, tempRoot, { recursive: true });
+    return tempRoot;
+}
+function getDeps(rootDirectoryPath) {
+    const projectConfig = (0, projectConfig_1.getProjectConfig)(rootDirectoryPath);
+    const datasource = new datasource_1.Datasource(projectConfig, rootDirectoryPath);
+    return {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: {},
+    };
+}
+describe("core: lintProject", function () {
+    let tempProjectPath;
+    beforeEach(() => {
+        tempProjectPath = createTempProjectFromExample1();
+    });
+    afterEach(() => {
+        fs.rmSync(tempProjectPath, { recursive: true, force: true });
+        jest.restoreAllMocks();
+    });
+    it("returns JSON-friendly empty errors array for a valid project", async () => {
+        const result = await (0, lintProject_1.lintProject)(getDeps(tempProjectPath), { json: true });
+        expect(result).toEqual({
+            hasError: false,
+            errors: [],
+        });
+    });
+    it("returns structured errors in JSON mode", async () => {
+        fs.writeFileSync(path.join(tempProjectPath, "attributes", "invalid name.yml"), "description: this has an invalid key name\ntype: string\n", "utf8");
+        const result = await (0, lintProject_1.lintProject)(getDeps(tempProjectPath), {
+            json: true,
+            entityType: "attribute",
+        });
+        expect(result.hasError).toBe(true);
+        expect(result.errors.length).toBeGreaterThan(0);
+        expect(result.errors[0]).toMatchObject({
+            entityType: "attribute",
+            key: "invalid name",
+            message: 'Invalid name: "invalid name"',
+            code: "invalid_name",
+            path: [],
+        });
+        expect(result.errors[0].filePath).toContain("attributes");
+    });
+    it("plugin prints pretty JSON only once in --json --pretty mode", async () => {
+        const consoleLogSpy = jest.spyOn(console, "log").mockImplementation(() => { });
+        const pluginResult = await lintProject_1.lintPlugin.handler({
+            ...getDeps(tempProjectPath),
+            parsed: {
+                json: true,
+                pretty: true,
+            },
+        });
+        expect(pluginResult).toBeUndefined();
+        expect(consoleLogSpy).toHaveBeenCalledTimes(1);
+        const output = consoleLogSpy.mock.calls[0][0];
+        expect(output).toContain('\n  "errors": []\n');
+    });
+    it("does not call process.exit for zod validation errors while linting tests", async () => {
+        fs.writeFileSync(path.join(tempProjectPath, "tests", "broken.spec.yml"), "feature: foo\n", "utf8");
+        const processExitSpy = jest
+            .spyOn(process, "exit")
+            .mockImplementation((() => undefined));
+        const result = await (0, lintProject_1.lintProject)(getDeps(tempProjectPath), {
+            json: true,
+            entityType: "test",
+        });
+        expect(result.hasError).toBe(true);
+        expect(result.errors.length).toBeGreaterThan(0);
+        expect(processExitSpy).not.toHaveBeenCalled();
+    });
+});
+//# sourceMappingURL=lintProject.spec.js.map

package/lib/linter/lintProject.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lintProject.spec.js","sourceRoot":"","sources":["../../src/linter/lintProject.spec.ts"],"names":[],"mappings":";;AAAA,yBAAyB;AACzB,yBAAyB;AACzB,6BAA6B;AAE7B,2DAA2D;AAC3D,8CAA2C;AAC3C,+CAAyE;AAEzE,SAAS,6BAA6B;IACpC,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAC;IAC9E,MAAM,QAAQ,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAE9E,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,OAAO,CAAC,iBAAyB;IACxC,MAAM,aAAa,GAAG,IAAA,gCAAgB,EAAC,iBAAiB,CAAC,CAAC;IAC1D,MAAM,UAAU,GAAG,IAAI,uBAAU,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;IAEpE,OAAO;QACL,iBAAiB;QACjB,aAAa;QACb,UAAU;QACV,OAAO,EAAE,EAAE;KACZ,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,mBAAmB,EAAE;IAC5B,IAAI,eAAuB,CAAC;IAE5B,UAAU,CAAC,GAAG,EAAE;QACd,eAAe,GAAG,6BAA6B,EAAE,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,MAAM,GAAG,MAAM,IAAA,yBAAW,EAAC,OAAO,CAAC,eAAe,CAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAElF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,EAAE;SACX,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACtD,EAAE,CAAC,aAAa,CACd,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,EAAE,kBAAkB,CAAC,EAC5D,2DAA2D,EAC3D,MAAM,CACP,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,IAAA,yBAAW,EAAC,OAAO,CAAC,eAAe,CAAQ,EAAE;YAChE,IAAI,EAAE,IAAI;YACV,UAAU,EAAE,WAAW;SACxB,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAEhD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YACrC,UAAU,EAAE,WAAW;YACvB,GAAG,EAAE,cAAc;YACnB,OAAO,EAAE,8BAA8B;YACvC,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,EAAE;SACT,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAE9E,MAAM,YAAY,GAAG,MAAM,wBAAU,CAAC,OAAO,CAAC;YAC5C,GAAG,OAAO,CAAC,eAAe,CAAC;YAC3B,MAAM,EAAE;gBACN,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,IAAI;aACb;SACK,CAAC,CAAC;QAEV,MAAM,CAAC,YAAY,CAAC,CAAC,aAAa,EAAE,CAAC;QACrC,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAE/C,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,EAAE,CAAC,aAAa,CACd,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,EAAE,iBAAiB,CAAC,EACtD,gBAAgB,EAChB,MAAM,CACP,CAAC;QAEF,MAAM,cAAc,GAAG,IAAI;aACxB,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC;aACtB,kBAAkB,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,CAAmC,CAAC,CAAC;QAE3E,MAAM,MAAM,GAAe,MAAM,IAAA,yBAAW,EAAC,OAAO,CAAC,eAAe,CAAQ,EAAE;YAC5E,IAAI,EAAE,IAAI;YACV,UAAU,EAAE,MAAM;SACnB,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAChD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/linter/printError.d.ts

@@ -1,2 +1,9 @@
 import { ZodError } from "zod";
+export interface LintIssueFromZod {
+    message: string;
+    path: (string | number)[];
+    code?: string;
+    value?: unknown;
+}
+export declare function getLintIssuesFromZodError(e: ZodError): LintIssueFromZod[];
 export declare function printZodError(e: ZodError): void;

package/lib/linter/printError.js

@@ -1,24 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLintIssuesFromZodError = getLintIssuesFromZodError;
 exports.printZodError = printZodError;
 const cliFormat_1 = require("../tester/cliFormat");
-function printZodError(e) {
-    const { issues } = e;
-    issues.forEach((issue) => {
-        if (issue.code === "invalid_union" && issue.path.length === 0 && issue.unionErrors.length > 0) {
-            // invalid_union
+function getLintIssuesFromZodError(e) {
+    return e.issues
+        .map((issue) => {
+        if (issue.code === "invalid_union" &&
+            issue.path.length === 0 &&
+            issue.unionErrors.length > 0) {
             const lastUnionError = issue.unionErrors[issue.unionErrors.length - 1];
-            console.error(cliFormat_1.CLI_FORMAT_RED, `  => Error: ${lastUnionError.issues[0].message}`);
-            console.error("     Path:", lastUnionError.issues[0].path.join("."));
+            const nestedIssue = lastUnionError.issues[0];
+            return {
+                message: nestedIssue.message,
+                path: nestedIssue.path,
+                code: nestedIssue.code,
+                value: nestedIssue.received,
+            };
         }
-        else {
-            // others
-            console.error(cliFormat_1.CLI_FORMAT_RED, `  => Error: ${issue.message}`);
-            console.error("     Path:", issue.path.join("."));
-            const receivedValue = issue.received;
-            if (typeof receivedValue !== "undefined" && receivedValue !== "undefined") {
-                console.error("     Value:", receivedValue);
-            }
+        return {
+            message: issue.message,
+            path: issue.path,
+            code: issue.code,
+            value: issue.received,
+        };
+    })
+        .filter(Boolean);
+}
+function printZodError(e) {
+    const issues = getLintIssuesFromZodError(e);
+    issues.forEach((issue) => {
+        console.error(cliFormat_1.CLI_FORMAT_RED, `  => Error: ${issue.message}`);
+        console.error("     Path:", issue.path.join("."));
+        if (typeof issue.value !== "undefined" && issue.value !== "undefined") {
+            console.error("     Value:", issue.value);
         }
         console.error("");
     });

package/lib/linter/printError.js.map

@@ -1 +1 @@
-{"version":3,"file":"printError.js","sourceRoot":"","sources":["../../src/linter/printError.ts"],"names":[],"mappings":";;AAIA,sCAsBC;AAxBD,mDAAqD;AAErD,SAAgB,aAAa,CAAC,CAAW;IACvC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IAErB,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACvB,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9F,gBAAgB;YAChB,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACvE,OAAO,CAAC,KAAK,CAAC,0BAAc,EAAE,eAAe,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YACjF,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACvE,CAAC;aAAM,CAAC;YACN,SAAS;YACT,OAAO,CAAC,KAAK,CAAC,0BAAc,EAAE,eAAe,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC9D,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAElD,MAAM,aAAa,GAAI,KAAa,CAAC,QAAQ,CAAC;YAC9C,IAAI,OAAO,aAAa,KAAK,WAAW,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBAC1E,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;QAED,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"printError.js","sourceRoot":"","sources":["../../src/linter/printError.ts"],"names":[],"mappings":";;AAWA,8DA2BC;AAED,sCAUC;AAhDD,mDAAqD;AASrD,SAAgB,yBAAyB,CAAC,CAAW;IACnD,OAAO,CAAC,CAAC,MAAM;SACZ,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,IACE,KAAK,CAAC,IAAI,KAAK,eAAe;YAC9B,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;YACvB,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAC5B,CAAC;YACD,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACvE,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAE7C,OAAO;gBACL,OAAO,EAAE,WAAW,CAAC,OAAO;gBAC5B,IAAI,EAAE,WAAW,CAAC,IAAI;gBACtB,IAAI,EAAE,WAAW,CAAC,IAAI;gBACtB,KAAK,EAAG,WAAmB,CAAC,QAAQ;aACrC,CAAC;QACJ,CAAC;QAED,OAAO;YACL,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,KAAK,EAAG,KAAa,CAAC,QAAQ;SAC/B,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAC;AACrB,CAAC;AAED,SAAgB,aAAa,CAAC,CAAW;IACvC,MAAM,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACvB,OAAO,CAAC,KAAK,CAAC,0BAAc,EAAE,eAAe,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9D,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAClD,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,WAAW,IAAI,KAAK,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;YACtE,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@featurevisor/core",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "description": "Core package of Featurevisor for Node.js usage",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -49,5 +49,5 @@
     "yargs": "^17.7.2",
     "zod": "^3.22.4"
   },
-  "gitHead": "d7542c7da3615c821b031912e4d12ca4c81e5db2"
+  "gitHead": "7f6fadd9c233f676f7439613544bef08520a4e36"
 }

package/src/linter/lintProject.spec.ts

@@ -0,0 +1,115 @@
+import * as fs from "fs";
+import * as os from "os";
+import * as path from "path";
+
+import { getProjectConfig } from "../config/projectConfig";
+import { Datasource } from "../datasource";
+import { lintPlugin, lintProject, type LintResult } from "./lintProject";
+
+function createTempProjectFromExample1() {
+  const fixturePath = path.resolve(__dirname, "../../../../examples/example-1");
+  const tempRoot = fs.mkdtempSync(path.join(os.tmpdir(), "featurevisor-lint-"));
+
+  fs.cpSync(fixturePath, tempRoot, { recursive: true });
+
+  return tempRoot;
+}
+
+function getDeps(rootDirectoryPath: string) {
+  const projectConfig = getProjectConfig(rootDirectoryPath);
+  const datasource = new Datasource(projectConfig, rootDirectoryPath);
+
+  return {
+    rootDirectoryPath,
+    projectConfig,
+    datasource,
+    options: {},
+  };
+}
+
+describe("core: lintProject", function () {
+  let tempProjectPath: string;
+
+  beforeEach(() => {
+    tempProjectPath = createTempProjectFromExample1();
+  });
+
+  afterEach(() => {
+    fs.rmSync(tempProjectPath, { recursive: true, force: true });
+    jest.restoreAllMocks();
+  });
+
+  it("returns JSON-friendly empty errors array for a valid project", async () => {
+    const result = await lintProject(getDeps(tempProjectPath) as any, { json: true });
+
+    expect(result).toEqual({
+      hasError: false,
+      errors: [],
+    });
+  });
+
+  it("returns structured errors in JSON mode", async () => {
+    fs.writeFileSync(
+      path.join(tempProjectPath, "attributes", "invalid name.yml"),
+      "description: this has an invalid key name\ntype: string\n",
+      "utf8",
+    );
+
+    const result = await lintProject(getDeps(tempProjectPath) as any, {
+      json: true,
+      entityType: "attribute",
+    });
+
+    expect(result.hasError).toBe(true);
+    expect(result.errors.length).toBeGreaterThan(0);
+
+    expect(result.errors[0]).toMatchObject({
+      entityType: "attribute",
+      key: "invalid name",
+      message: 'Invalid name: "invalid name"',
+      code: "invalid_name",
+      path: [],
+    });
+
+    expect(result.errors[0].filePath).toContain("attributes");
+  });
+
+  it("plugin prints pretty JSON only once in --json --pretty mode", async () => {
+    const consoleLogSpy = jest.spyOn(console, "log").mockImplementation(() => {});
+
+    const pluginResult = await lintPlugin.handler({
+      ...getDeps(tempProjectPath),
+      parsed: {
+        json: true,
+        pretty: true,
+      },
+    } as any);
+
+    expect(pluginResult).toBeUndefined();
+    expect(consoleLogSpy).toHaveBeenCalledTimes(1);
+
+    const output = consoleLogSpy.mock.calls[0][0] as string;
+    expect(output).toContain('\n  "errors": []\n');
+  });
+
+  it("does not call process.exit for zod validation errors while linting tests", async () => {
+    fs.writeFileSync(
+      path.join(tempProjectPath, "tests", "broken.spec.yml"),
+      "feature: foo\n",
+      "utf8",
+    );
+
+    const processExitSpy = jest
+      .spyOn(process, "exit")
+      .mockImplementation((() => undefined) as unknown as typeof process.exit);
+
+    const result: LintResult = await lintProject(getDeps(tempProjectPath) as any, {
+      json: true,
+      entityType: "test",
+    });
+
+    expect(result.hasError).toBe(true);
+    expect(result.errors.length).toBeGreaterThan(0);
+    expect(processExitSpy).not.toHaveBeenCalled();
+  });
+});