@featurevisor/core 1.25.0 → 1.27.0

package/lib/site/index.js

@@ -1,19 +1,91 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./exportSite"), exports);
-__exportStar(require("./serveSite"), exports);
+exports.sitePlugin = void 0;
+var exportSite_1 = require("./exportSite");
+var serveSite_1 = require("./serveSite");
+exports.sitePlugin = {
+    command: "site [subcommand]",
+    handler: function (_a) {
+        var rootDirectoryPath = _a.rootDirectoryPath, projectConfig = _a.projectConfig, datasource = _a.datasource, parsed = _a.parsed;
+        return __awaiter(this, void 0, void 0, function () {
+            var deps, allowedSubcommands, hasError;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        deps = {
+                            rootDirectoryPath: rootDirectoryPath,
+                            projectConfig: projectConfig,
+                            datasource: datasource,
+                            options: parsed,
+                        };
+                        allowedSubcommands = ["export", "serve"];
+                        if (!allowedSubcommands.includes(parsed.subcommand)) {
+                            console.log("Please specify a subcommand: `export` or `serve`");
+                            return [2 /*return*/];
+                        }
+                        if (!(parsed.subcommand === "export")) return [3 /*break*/, 2];
+                        return [4 /*yield*/, (0, exportSite_1.exportSite)(deps)];
+                    case 1:
+                        hasError = _b.sent();
+                        if (hasError) {
+                            return [2 /*return*/, false];
+                        }
+                        _b.label = 2;
+                    case 2:
+                        // serve
+                        if (parsed.subcommand === "serve") {
+                            (0, serveSite_1.serveSite)(deps);
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    },
+    examples: [
+        {
+            command: "site export",
+            description: "generate static site with project data",
+        },
+        {
+            command: "site serve",
+            description: "serve already exported site locally",
+        },
+    ],
+};
 //# sourceMappingURL=index.js.map

package/lib/site/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/site/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/site/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA0C;AAC1C,yCAAwC;AAE3B,QAAA,UAAU,GAAW;IAChC,OAAO,EAAE,mBAAmB;IAC5B,OAAO,EAAE,UAAgB,EAAwD;YAAtD,iBAAiB,uBAAA,EAAE,aAAa,mBAAA,EAAE,UAAU,gBAAA,EAAE,MAAM,YAAA;;;;;;wBACvE,IAAI,GAAG;4BACX,iBAAiB,mBAAA;4BACjB,aAAa,eAAA;4BACb,UAAU,YAAA;4BACV,OAAO,EAAE,MAAM;yBAChB,CAAC;wBAEI,kBAAkB,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;wBAE/C,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;4BACnD,OAAO,CAAC,GAAG,CAAC,kDAAkD,CAAC,CAAC;4BAChE,sBAAO;yBACR;6BAGG,CAAA,MAAM,CAAC,UAAU,KAAK,QAAQ,CAAA,EAA9B,wBAA8B;wBACf,qBAAM,IAAA,uBAAU,EAAC,IAAI,CAAC,EAAA;;wBAAjC,QAAQ,GAAG,SAAsB;wBAEvC,IAAI,QAAQ,EAAE;4BACZ,sBAAO,KAAK,EAAC;yBACd;;;wBAGH,QAAQ;wBACR,IAAI,MAAM,CAAC,UAAU,KAAK,OAAO,EAAE;4BACjC,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC;yBACjB;;;;;KACF;IACD,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,wCAAwC;SACtD;QACD;YACE,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,qCAAqC;SACnD;KACF;CACF,CAAC"}

package/lib/tester/testProject.d.ts

@@ -1,5 +1,6 @@
 import { DatafileContent } from "@featurevisor/types";
 import { Dependencies } from "../dependencies";
+import { Plugin } from "../cli";
 export interface TestProjectOptions {
     keyPattern?: string;
     assertionPattern?: string;
@@ -23,3 +24,4 @@ export interface DatafileContentByEnvironment {
 }
 export declare function executeTest(testFile: string, deps: Dependencies, options: TestProjectOptions, patterns: TestPatterns, datafileContentByEnvironment: DatafileContentByEnvironment): Promise<ExecutionResult | undefined>;
 export declare function testProject(deps: Dependencies, options?: TestProjectOptions): Promise<boolean>;
+export declare const testPlugin: Plugin;

package/lib/tester/testProject.js

@@ -36,7 +36,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testProject = exports.executeTest = void 0;
+exports.testPlugin = exports.testProject = exports.executeTest = void 0;
 var fs = require("fs");
 var testSegment_1 = require("./testSegment");
 var testFeature_1 = require("./testFeature");
@@ -210,4 +210,55 @@ function testProject(deps, options) {
     });
 }
 exports.testProject = testProject;
+exports.testPlugin = {
+    command: "test",
+    handler: function (_a) {
+        var rootDirectoryPath = _a.rootDirectoryPath, projectConfig = _a.projectConfig, datasource = _a.datasource, parsed = _a.parsed;
+        return __awaiter(this, void 0, void 0, function () {
+            var hasError;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, testProject({
+                            rootDirectoryPath: rootDirectoryPath,
+                            projectConfig: projectConfig,
+                            datasource: datasource,
+                            options: parsed,
+                        }, parsed)];
+                    case 1:
+                        hasError = _b.sent();
+                        if (hasError) {
+                            return [2 /*return*/, false];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    },
+    examples: [
+        {
+            command: "test",
+            description: "run all tests",
+        },
+        {
+            command: "test --keyPattern=pattern",
+            description: "run tests matching key pattern",
+        },
+        {
+            command: "test --assertionPattern=pattern",
+            description: "run tests matching assertion pattern",
+        },
+        {
+            command: "test --onlyFailures",
+            description: "run only failed tests",
+        },
+        {
+            command: "test --showDatafile",
+            description: "show datafile content for each test",
+        },
+        {
+            command: "test --verbose",
+            description: "show all test results",
+        },
+    ],
+};
 //# sourceMappingURL=testProject.js.map

package/lib/tester/testProject.js.map

@@ -1 +1 @@
-{"version":3,"file":"testProject.js","sourceRoot":"","sources":["../../src/tester/testProject.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uBAAyB;AAIzB,6CAA4C;AAC5C,6CAA4C;AAC5C,yCAAgF;AAEhF,mDAAkD;AAClD,qDAAoD;AAEpD,sCAA2C;AAC3C,oCAA2C;AA2B3C,SAAsB,WAAW,CAC/B,QAAgB,EAChB,IAAkB,EAClB,OAA2B,EAC3B,QAAsB,EACtB,4BAA0D;;;;;;oBAElD,UAAU,GAAuC,IAAI,WAA3C,EAAE,aAAa,GAAwB,IAAI,cAA5B,EAAE,iBAAiB,GAAK,IAAI,kBAAT,CAAU;oBAExD,YAAY,GAAG,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;oBAEhD,qBAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAA;;oBAAvC,CAAC,GAAG,SAAmC;oBAEvC,UAAU,GAAG,CAAgB,CAAC;oBAC9B,UAAU,GAAG,CAAgB,CAAC;oBAC9B,GAAG,GAAG,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC;oBAC/C,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;oBAElD,eAAe,GAAoB;wBACvC,MAAM,EAAE,IAAI;wBACZ,eAAe,EAAE;4BACf,MAAM,EAAE,CAAC;4BACT,MAAM,EAAE,CAAC;yBACV;qBACF,CAAC;oBAEF,IAAI,CAAC,GAAG,EAAE;wBACR,OAAO,CAAC,KAAK,CAAC,6BAAsB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC;wBACzD,eAAe,CAAC,MAAM,GAAG,KAAK,CAAC;wBAE/B,sBAAO,eAAe,EAAC;qBACxB;oBAED,IAAI,QAAQ,CAAC,UAAU,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;wBACzD,sBAAO;qBACR;yBAGG,CAAA,IAAI,KAAK,SAAS,CAAA,EAAlB,wBAAkB;oBACP,qBAAM,IAAA,yBAAW,EAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAA;;oBAAhE,UAAU,GAAG,SAAmD,CAAC;;wBAEpD,qBAAM,IAAA,yBAAW,EAC5B,UAAU,EACV,aAAa,EACb,UAAU,EACV,OAAO,EACP,QAAQ,EACR,4BAA4B,CAC7B,EAAA;;oBAPD,UAAU,GAAG,SAOZ,CAAC;;;oBAGJ,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;wBACzB,WAAW;wBACX,IAAA,iCAAe,EAAC,UAAU,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC;qBAC9D;yBAAM;wBACL,mBAAmB;wBACnB,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;4BACtB,IAAA,iCAAe,EAAC,UAAU,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC;yBAC9D;qBACF;oBAED,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;wBACtB,eAAe,CAAC,MAAM,GAAG,KAAK,CAAC;wBAE/B,eAAe,CAAC,eAAe,CAAC,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,CAAC,MAAM,EAAT,CAAS,CAAC,CAAC,MAAM,CAAC;wBAC/F,eAAe,CAAC,eAAe,CAAC,MAAM;4BACpC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC;qBACzE;yBAAM;wBACL,eAAe,CAAC,eAAe,CAAC,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;qBACvE;oBAED,sBAAO,eAAe,EAAC;;;;CACxB;AAxED,kCAwEC;AAED,SAAsB,WAAW,CAC/B,IAAkB,EAClB,OAAgC;IAAhC,wBAAA,EAAA,YAAgC;;;;;;oBAExB,aAAa,GAAiB,IAAI,cAArB,EAAE,UAAU,GAAK,IAAI,WAAT,CAAU;oBAEvC,QAAQ,GAAG,KAAK,CAAC;oBAErB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE;wBACpD,OAAO,CAAC,KAAK,CAAC,0CAAmC,aAAa,CAAC,kBAAkB,CAAE,CAAC,CAAC;wBACrF,QAAQ,GAAG,IAAI,CAAC;wBAEhB,sBAAO,QAAQ,EAAC;qBACjB;oBAEiB,qBAAM,UAAU,CAAC,SAAS,EAAE,EAAA;;oBAAxC,SAAS,GAAG,SAA4B;oBAE9C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;wBAC1B,OAAO,CAAC,KAAK,CAAC,6BAAsB,aAAa,CAAC,kBAAkB,CAAE,CAAC,CAAC;wBACxE,QAAQ,GAAG,IAAI,CAAC;wBAEhB,sBAAO,QAAQ,EAAC;qBACjB;oBAEK,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAEvB,QAAQ,GAAiB;wBAC7B,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;wBAC3E,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS;qBAC9F,CAAC;oBAEE,gBAAgB,GAAG,CAAC,CAAC;oBACrB,gBAAgB,GAAG,CAAC,CAAC;oBAErB,qBAAqB,GAAG,CAAC,CAAC;oBAC1B,qBAAqB,GAAG,CAAC,CAAC;oBAExB,4BAA4B,GAAiC,EAAE,CAAC;0BAElB,EAA1B,KAAA,aAAa,CAAC,YAAY;;;yBAA1B,CAAA,cAA0B,CAAA;oBAAzC,WAAW;oBACE,qBAAM,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,EAAA;;oBAAvD,aAAa,GAAG,SAAuC;oBACrC,qBAAM,IAAA,uBAAa,EACzC,aAAa,EACb,UAAU,EACV;4BACE,aAAa,EAAE,uBAAc;4BAC7B,QAAQ,EAAE,sBAAsB;4BAChC,WAAW,EAAE,WAAW;yBACzB,EACD,aAAa,CACd,EAAA;;oBATK,eAAe,GAAG,SASvB;oBAED,4BAA4B,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC;;;oBAbpC,IAA0B,CAAA;;;0BAgBpB,EAAT,uBAAS;;;yBAAT,CAAA,uBAAS,CAAA;oBAArB,QAAQ;oBACO,qBAAM,WAAW,CACvC,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,4BAA4B,CAC7B,EAAA;;oBANK,eAAe,GAAG,SAMvB;oBAED,IAAI,CAAC,eAAe,EAAE;wBACpB,wBAAS;qBACV;oBAED,IAAI,eAAe,CAAC,MAAM,EAAE;wBAC1B,gBAAgB,IAAI,CAAC,CAAC;qBACvB;yBAAM;wBACL,QAAQ,GAAG,IAAI,CAAC;wBAChB,gBAAgB,IAAI,CAAC,CAAC;qBACvB;oBAED,qBAAqB,IAAI,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC;oBAChE,qBAAqB,IAAI,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC;;;oBArB3C,IAAS,CAAA;;;oBAwB1B,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;oBAExC,IAAI,OAAO,CAAC,YAAY,KAAK,IAAI,IAAI,QAAQ,EAAE;wBAC7C,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;qBACtB;oBACD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAEV,gBAAgB,GAAG,sBAAe,gBAAgB,sBAAY,gBAAgB,YAAS,CAAC;oBACxF,qBAAqB,GAAG,sBAAe,qBAAqB,sBAAY,qBAAqB,YAAS,CAAC;oBAC7G,IAAI,QAAQ,EAAE;wBACZ,OAAO,CAAC,GAAG,CAAC,0BAAc,EAAE,gBAAgB,CAAC,CAAC;wBAC9C,OAAO,CAAC,GAAG,CAAC,0BAAc,EAAE,qBAAqB,CAAC,CAAC;qBACpD;yBAAM;wBACL,OAAO,CAAC,GAAG,CAAC,4BAAgB,EAAE,gBAAgB,CAAC,CAAC;wBAChD,OAAO,CAAC,GAAG,CAAC,4BAAgB,EAAE,qBAAqB,CAAC,CAAC;qBACtD;oBAED,OAAO,CAAC,GAAG,CAAC,2BAAe,EAAE,sBAAe,IAAA,+BAAc,EAAC,QAAQ,CAAC,CAAE,CAAC,CAAC;oBAExE,sBAAO,QAAQ,EAAC;;;;CACjB;AAnGD,kCAmGC"}
+{"version":3,"file":"testProject.js","sourceRoot":"","sources":["../../src/tester/testProject.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uBAAyB;AAIzB,6CAA4C;AAC5C,6CAA4C;AAC5C,yCAAgF;AAEhF,mDAAkD;AAClD,qDAAoD;AAEpD,sCAA2C;AAC3C,oCAA2C;AA4B3C,SAAsB,WAAW,CAC/B,QAAgB,EAChB,IAAkB,EAClB,OAA2B,EAC3B,QAAsB,EACtB,4BAA0D;;;;;;oBAElD,UAAU,GAAuC,IAAI,WAA3C,EAAE,aAAa,GAAwB,IAAI,cAA5B,EAAE,iBAAiB,GAAK,IAAI,kBAAT,CAAU;oBAExD,YAAY,GAAG,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;oBAEhD,qBAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAA;;oBAAvC,CAAC,GAAG,SAAmC;oBAEvC,UAAU,GAAG,CAAgB,CAAC;oBAC9B,UAAU,GAAG,CAAgB,CAAC;oBAC9B,GAAG,GAAG,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC;oBAC/C,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;oBAElD,eAAe,GAAoB;wBACvC,MAAM,EAAE,IAAI;wBACZ,eAAe,EAAE;4BACf,MAAM,EAAE,CAAC;4BACT,MAAM,EAAE,CAAC;yBACV;qBACF,CAAC;oBAEF,IAAI,CAAC,GAAG,EAAE;wBACR,OAAO,CAAC,KAAK,CAAC,6BAAsB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC;wBACzD,eAAe,CAAC,MAAM,GAAG,KAAK,CAAC;wBAE/B,sBAAO,eAAe,EAAC;qBACxB;oBAED,IAAI,QAAQ,CAAC,UAAU,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;wBACzD,sBAAO;qBACR;yBAGG,CAAA,IAAI,KAAK,SAAS,CAAA,EAAlB,wBAAkB;oBACP,qBAAM,IAAA,yBAAW,EAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAA;;oBAAhE,UAAU,GAAG,SAAmD,CAAC;;wBAEpD,qBAAM,IAAA,yBAAW,EAC5B,UAAU,EACV,aAAa,EACb,UAAU,EACV,OAAO,EACP,QAAQ,EACR,4BAA4B,CAC7B,EAAA;;oBAPD,UAAU,GAAG,SAOZ,CAAC;;;oBAGJ,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;wBACzB,WAAW;wBACX,IAAA,iCAAe,EAAC,UAAU,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC;qBAC9D;yBAAM;wBACL,mBAAmB;wBACnB,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;4BACtB,IAAA,iCAAe,EAAC,UAAU,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC;yBAC9D;qBACF;oBAED,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;wBACtB,eAAe,CAAC,MAAM,GAAG,KAAK,CAAC;wBAE/B,eAAe,CAAC,eAAe,CAAC,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,CAAC,MAAM,EAAT,CAAS,CAAC,CAAC,MAAM,CAAC;wBAC/F,eAAe,CAAC,eAAe,CAAC,MAAM;4BACpC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC;qBACzE;yBAAM;wBACL,eAAe,CAAC,eAAe,CAAC,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;qBACvE;oBAED,sBAAO,eAAe,EAAC;;;;CACxB;AAxED,kCAwEC;AAED,SAAsB,WAAW,CAC/B,IAAkB,EAClB,OAAgC;IAAhC,wBAAA,EAAA,YAAgC;;;;;;oBAExB,aAAa,GAAiB,IAAI,cAArB,EAAE,UAAU,GAAK,IAAI,WAAT,CAAU;oBAEvC,QAAQ,GAAG,KAAK,CAAC;oBAErB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE;wBACpD,OAAO,CAAC,KAAK,CAAC,0CAAmC,aAAa,CAAC,kBAAkB,CAAE,CAAC,CAAC;wBACrF,QAAQ,GAAG,IAAI,CAAC;wBAEhB,sBAAO,QAAQ,EAAC;qBACjB;oBAEiB,qBAAM,UAAU,CAAC,SAAS,EAAE,EAAA;;oBAAxC,SAAS,GAAG,SAA4B;oBAE9C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;wBAC1B,OAAO,CAAC,KAAK,CAAC,6BAAsB,aAAa,CAAC,kBAAkB,CAAE,CAAC,CAAC;wBACxE,QAAQ,GAAG,IAAI,CAAC;wBAEhB,sBAAO,QAAQ,EAAC;qBACjB;oBAEK,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAEvB,QAAQ,GAAiB;wBAC7B,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;wBAC3E,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS;qBAC9F,CAAC;oBAEE,gBAAgB,GAAG,CAAC,CAAC;oBACrB,gBAAgB,GAAG,CAAC,CAAC;oBAErB,qBAAqB,GAAG,CAAC,CAAC;oBAC1B,qBAAqB,GAAG,CAAC,CAAC;oBAExB,4BAA4B,GAAiC,EAAE,CAAC;0BAElB,EAA1B,KAAA,aAAa,CAAC,YAAY;;;yBAA1B,CAAA,cAA0B,CAAA;oBAAzC,WAAW;oBACE,qBAAM,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,EAAA;;oBAAvD,aAAa,GAAG,SAAuC;oBACrC,qBAAM,IAAA,uBAAa,EACzC,aAAa,EACb,UAAU,EACV;4BACE,aAAa,EAAE,uBAAc;4BAC7B,QAAQ,EAAE,sBAAsB;4BAChC,WAAW,EAAE,WAAW;yBACzB,EACD,aAAa,CACd,EAAA;;oBATK,eAAe,GAAG,SASvB;oBAED,4BAA4B,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC;;;oBAbpC,IAA0B,CAAA;;;0BAgBpB,EAAT,uBAAS;;;yBAAT,CAAA,uBAAS,CAAA;oBAArB,QAAQ;oBACO,qBAAM,WAAW,CACvC,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,4BAA4B,CAC7B,EAAA;;oBANK,eAAe,GAAG,SAMvB;oBAED,IAAI,CAAC,eAAe,EAAE;wBACpB,wBAAS;qBACV;oBAED,IAAI,eAAe,CAAC,MAAM,EAAE;wBAC1B,gBAAgB,IAAI,CAAC,CAAC;qBACvB;yBAAM;wBACL,QAAQ,GAAG,IAAI,CAAC;wBAChB,gBAAgB,IAAI,CAAC,CAAC;qBACvB;oBAED,qBAAqB,IAAI,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC;oBAChE,qBAAqB,IAAI,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC;;;oBArB3C,IAAS,CAAA;;;oBAwB1B,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;oBAExC,IAAI,OAAO,CAAC,YAAY,KAAK,IAAI,IAAI,QAAQ,EAAE;wBAC7C,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;qBACtB;oBACD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAEV,gBAAgB,GAAG,sBAAe,gBAAgB,sBAAY,gBAAgB,YAAS,CAAC;oBACxF,qBAAqB,GAAG,sBAAe,qBAAqB,sBAAY,qBAAqB,YAAS,CAAC;oBAC7G,IAAI,QAAQ,EAAE;wBACZ,OAAO,CAAC,GAAG,CAAC,0BAAc,EAAE,gBAAgB,CAAC,CAAC;wBAC9C,OAAO,CAAC,GAAG,CAAC,0BAAc,EAAE,qBAAqB,CAAC,CAAC;qBACpD;yBAAM;wBACL,OAAO,CAAC,GAAG,CAAC,4BAAgB,EAAE,gBAAgB,CAAC,CAAC;wBAChD,OAAO,CAAC,GAAG,CAAC,4BAAgB,EAAE,qBAAqB,CAAC,CAAC;qBACtD;oBAED,OAAO,CAAC,GAAG,CAAC,2BAAe,EAAE,sBAAe,IAAA,+BAAc,EAAC,QAAQ,CAAC,CAAE,CAAC,CAAC;oBAExE,sBAAO,QAAQ,EAAC;;;;CACjB;AAnGD,kCAmGC;AAEY,QAAA,UAAU,GAAW;IAChC,OAAO,EAAE,MAAM;IACf,OAAO,EAAE,UAAgB,EAAwD;YAAtD,iBAAiB,uBAAA,EAAE,aAAa,mBAAA,EAAE,UAAU,gBAAA,EAAE,MAAM,YAAA;;;;;4BAC5D,qBAAM,WAAW,CAChC;4BACE,iBAAiB,mBAAA;4BACjB,aAAa,eAAA;4BACb,UAAU,YAAA;4BACV,OAAO,EAAE,MAAM;yBAChB,EACD,MAA4B,CAC7B,EAAA;;wBARK,QAAQ,GAAG,SAQhB;wBAED,IAAI,QAAQ,EAAE;4BACZ,sBAAO,KAAK,EAAC;yBACd;;;;;KACF;IACD,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,eAAe;SAC7B;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,WAAW,EAAE,gCAAgC;SAC9C;QACD;YACE,OAAO,EAAE,iCAAiC;YAC1C,WAAW,EAAE,sCAAsC;SACpD;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,WAAW,EAAE,uBAAuB;SACrC;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,WAAW,EAAE,qCAAqC;SACnD;QACD;YACE,OAAO,EAAE,gBAAgB;YACzB,WAAW,EAAE,uBAAuB;SACrC;KACF;CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@featurevisor/core",
-  "version": "1.25.0",
+  "version": "1.27.0",
   "description": "Core package of Featurevisor for Node.js usage",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -51,11 +51,12 @@
     "js-yaml": "^4.1.0",
     "mkdirp": "^2.1.3",
     "tar": "^6.1.13",
+    "yargs": "^17.7.2",
     "zod": "^3.22.4"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.5",
     "@types/tar": "^6.1.4"
   },
-  "gitHead": "4ba871333e577b6164af64e9d66955306fb0fc04"
+  "gitHead": "8b06b8f1bb33dd9a80988c013c91381c06c3b606"
 }

package/src/assess-distribution/index.ts

@@ -7,6 +7,7 @@ import { Dependencies } from "../dependencies";
 import { buildDatafile } from "../builder";
 import { SCHEMA_VERSION } from "../config";
 import { prettyPercentage, prettyNumber } from "../utils";
+import { Plugin } from "../cli";
 
 const UUID_LENGTHS = [4, 2, 2, 2, 6];
 
@@ -165,3 +166,34 @@ export async function assessDistribution(deps: Dependencies, options: AssessDist
     printCounts(variationEvaluations, options.n);
   }
 }
+
+export const assessDistributionPlugin: Plugin = {
+  command: "assess-distribution",
+  handler: async ({ rootDirectoryPath, projectConfig, datasource, parsed }) => {
+    await assessDistribution(
+      {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: parsed,
+      },
+      {
+        environment: parsed.environment,
+        feature: parsed.feature,
+        n: parseInt(parsed.n, 10) || 1,
+        context: parsed.context ? JSON.parse(parsed.context) : {},
+        populateUuid: Array.isArray(parsed.populateUuid)
+          ? parsed.populateUuid
+          : [parsed.populateUuid as string].filter(Boolean),
+        verbose: parsed.verbose,
+      },
+    );
+  },
+  examples: [
+    {
+      command:
+        "assess-distribution --environment=production --feature=my_feature --context='{}' --populateUuid=userId -n=100",
+      description: "test traffic distribution a feature against provided context",
+    },
+  ],
+};

package/src/benchmark/index.ts

@@ -5,6 +5,7 @@ import { SCHEMA_VERSION } from "../config";
 import { buildDatafile } from "../builder";
 import { Dependencies } from "../dependencies";
 import { prettyDuration } from "../tester/prettyDuration";
+import { Plugin } from "../cli";
 
 export interface BenchmarkOutput {
   value: any;
@@ -148,3 +149,42 @@ export async function benchmarkFeature(
   console.log(`Total duration  : ${prettyDuration(output.duration)}`);
   console.log(`Average duration: ${prettyDuration(output.duration / options.n)}`);
 }
+
+export const benchmarkPlugin: Plugin = {
+  command: "benchmark",
+  handler: async ({ rootDirectoryPath, projectConfig, datasource, parsed }) => {
+    await benchmarkFeature(
+      {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: parsed,
+      },
+      {
+        environment: parsed.environment,
+        feature: parsed.feature,
+        n: parseInt(parsed.n, 10) || 1,
+        context: parsed.context ? JSON.parse(parsed.context) : {},
+        variation: parsed.variation || undefined,
+        variable: parsed.variable || undefined,
+      },
+    );
+  },
+  examples: [
+    {
+      command:
+        'benchmark --environment=production --feature=my_feature -n=1000 --context=\'{"userId": "123"}\'',
+      description: "Benchmark a feature flag",
+    },
+    {
+      command:
+        'benchmark --environment=production --feature=my_feature -n=1000 --context=\'{"userId": "123"}\' --variation',
+      description: "Benchmark a feature variation",
+    },
+    {
+      command:
+        'benchmark --environment=production --feature=my_feature -n=1000 --context=\'{"userId": "123"}\' --variable=my-variable',
+      description: "Benchmark a feature variable",
+    },
+  ],
+};

package/src/builder/buildProject.ts

@@ -3,6 +3,7 @@ import { SCHEMA_VERSION } from "../config";
 import { getNextRevision } from "./revision";
 import { buildDatafile, getCustomDatafile } from "./buildDatafile";
 import { Dependencies } from "../dependencies";
+import { Plugin } from "../cli";
 
 export interface BuildCLIOptions {
   revision?: string;
@@ -12,6 +13,7 @@ export interface BuildCLIOptions {
   feature?: string;
   print?: boolean;
   pretty?: boolean;
+  stateFiles?: boolean; // --no-state-files in CLI
 }
 
 export async function buildProject(deps: Dependencies, cliOptions: BuildCLIOptions = {}) {
@@ -84,12 +86,55 @@ export async function buildProject(deps: Dependencies, cliOptions: BuildCLIOptio
       });
     }
 
-    // write state for environment
-    await datasource.writeState(environment, existingState);
+    if (typeof cliOptions.stateFiles === "undefined" || cliOptions.stateFiles) {
+      // write state for environment
+      await datasource.writeState(environment, existingState);
 
-    // write revision
-    await datasource.writeRevision(nextRevision);
+      // write revision
+      await datasource.writeRevision(nextRevision);
+    }
   }
 
   console.log("\nLatest revision:", nextRevision);
 }
+
+export const buildPlugin: Plugin = {
+  command: "build",
+  handler: async function ({ rootDirectoryPath, projectConfig, datasource, parsed }) {
+    await buildProject(
+      {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: parsed,
+      },
+      parsed as BuildCLIOptions,
+    );
+  },
+  examples: [
+    {
+      command: "build",
+      description: "build datafiles for all environments and tags",
+    },
+    {
+      command: "build --revision=123",
+      description: "build datafiles starting with revision value as 123",
+    },
+    {
+      command: "build --environment=production",
+      description: "build datafiles for production environment",
+    },
+    {
+      command: "build --print --environment=production --feature=featureKey",
+      description: "print datafile for a feature in production environment",
+    },
+    {
+      command: "build --print --environment=production --pretty",
+      description: "print datafile with pretty print",
+    },
+    {
+      command: "build --no-state-files",
+      description: "build datafiles without writing state files",
+    },
+  ],
+};

package/src/cli/cli.ts

@@ -0,0 +1,105 @@
+import { ProjectConfig } from "../config";
+import { Datasource } from "../datasource";
+
+import { commonPlugins, nonProjectPlugins, projectBasedPlugins } from "./plugins";
+
+export interface ParsedOptions {
+  _: string[];
+  [key: string]: any;
+}
+
+export interface PluginHandlerOptions {
+  rootDirectoryPath: string;
+  projectConfig: ProjectConfig;
+  datasource: Datasource;
+  parsed: ParsedOptions;
+}
+
+export interface Plugin {
+  command: string; // single word
+  handler: (options: PluginHandlerOptions) => Promise<void | boolean>;
+  examples: {
+    command: string; // full command usage
+    description: string;
+  }[];
+}
+
+export interface RunnerOptions {
+  rootDirectoryPath: string;
+
+  // optional because Featurevisor CLI can be used without a project
+  projectConfig?: ProjectConfig;
+  datasource?: Datasource;
+}
+
+export async function runCLI(runnerOptions: RunnerOptions) {
+  const yargs = require("yargs");
+
+  let y = yargs(process.argv.slice(2)).usage("Usage: <command> [options]");
+  const registeredSubcommands: string[] = [];
+
+  const { rootDirectoryPath, projectConfig, datasource } = runnerOptions;
+
+  function registerPlugin(plugin: Plugin) {
+    const subcommand = plugin.command.split(" ")[0];
+
+    if (registeredSubcommands.includes(subcommand)) {
+      console.warn(`Plugin "${subcommand}" already registered. Skipping.`);
+      return;
+    }
+
+    y = y.command({
+      command: plugin.command,
+      handler: async function (parsed: ParsedOptions) {
+        try {
+          const result = await plugin.handler({
+            rootDirectoryPath,
+            projectConfig,
+            datasource,
+            parsed,
+          } as PluginHandlerOptions);
+
+          if (result === false) {
+            process.exit(1);
+          }
+        } catch (error) {
+          console.error(error);
+          process.exit(1);
+        }
+      },
+    });
+
+    for (const example of plugin.examples) {
+      y = y.example(`$0 ${example.command}`, example.description);
+    }
+
+    registeredSubcommands.push(subcommand);
+  }
+
+  // non project-based plugins
+  if (!projectConfig) {
+    for (const plugin of nonProjectPlugins) {
+      registerPlugin(plugin);
+    }
+  }
+
+  // project-based plugins
+  if (projectConfig) {
+    for (const plugin of [...projectBasedPlugins, ...(projectConfig.plugins || [])]) {
+      registerPlugin(plugin);
+    }
+  }
+
+  // common plugins
+  for (const plugin of commonPlugins) {
+    registerPlugin(plugin);
+  }
+
+  // show help if no command is provided
+  y.command({
+    command: "*",
+    handler() {
+      y.showHelp();
+    },
+  }).argv;
+}

package/src/cli/index.ts

@@ -0,0 +1,2 @@
+export * from "./cli";
+export * from "./plugins";

package/src/cli/plugins.ts

@@ -0,0 +1,38 @@
+import type { Plugin } from "./cli";
+
+import { initPlugin } from "../init";
+import { lintPlugin } from "../linter";
+import { buildPlugin } from "../builder";
+import { restorePlugin } from "../restore";
+import { testPlugin } from "../tester";
+import { generateCodePlugin } from "../generate-code";
+import { findDuplicateSegmentsPlugin } from "../find-duplicate-segments";
+import { findUsagePlugin } from "../find-usage";
+import { benchmarkPlugin } from "../benchmark";
+import { configPlugin } from "../config";
+import { evaluatePlugin } from "../evaluate";
+import { assessDistributionPlugin } from "../assess-distribution";
+import { infoPlugin } from "../info";
+import { sitePlugin } from "../site";
+
+// that do not require an existing project
+export const nonProjectPlugins: Plugin[] = [initPlugin];
+
+// that require an existing Featurevisor project
+export const projectBasedPlugins: Plugin[] = [
+  lintPlugin,
+  buildPlugin,
+  restorePlugin,
+  testPlugin,
+  generateCodePlugin,
+  findDuplicateSegmentsPlugin,
+  findUsagePlugin,
+  benchmarkPlugin,
+  configPlugin,
+  evaluatePlugin,
+  assessDistributionPlugin,
+  infoPlugin,
+  sitePlugin,
+];
+
+export const commonPlugins: Plugin[] = [];

package/src/config/projectConfig.ts

@@ -4,6 +4,7 @@ import { BucketBy } from "@featurevisor/types";
 
 import { Parser, parsers } from "./parsers";
 import { FilesystemAdapter } from "../datasource/filesystemAdapter";
+import type { Plugin } from "../cli";
 
 export const FEATURES_DIRECTORY_NAME = "features";
 export const SEGMENTS_DIRECTORY_NAME = "segments";
@@ -46,6 +47,7 @@ export interface ProjectConfig {
   siteExportDirectoryPath: string;
   enforceCatchAllRule?: boolean;
   adapter: any; // @TODO: type this properly later
+  plugins: Plugin[];
 }
 
 // rootDirectoryPath: path to the root directory of the project (without ending with a slash)
@@ -73,6 +75,7 @@ export function getProjectConfig(rootDirectoryPath: string): ProjectConfig {
     siteExportDirectoryPath: path.join(rootDirectoryPath, SITE_EXPORT_DIRECTORY_NAME),
 
     enforceCatchAllRule: false,
+    plugins: [],
   };
 
   const configModulePath = path.join(rootDirectoryPath, CONFIG_MODULE_NAME);
@@ -134,3 +137,28 @@ export function showProjectConfig(
     console.log(`  - ${key.padEnd(longestKeyLength, " ")}: ${projectConfig[key]}`);
   }
 }
+
+export const configPlugin: Plugin = {
+  command: "config",
+  handler: async ({ rootDirectoryPath, parsed }) => {
+    const projectConfig = getProjectConfig(rootDirectoryPath);
+    showProjectConfig(projectConfig, {
+      print: parsed.print,
+      pretty: parsed.pretty,
+    });
+  },
+  examples: [
+    {
+      command: "config",
+      description: "show the project configuration",
+    },
+    {
+      command: "config --print",
+      description: "show the project configuration as JSON",
+    },
+    {
+      command: "config --print --pretty",
+      description: "show the project configuration (as pretty JSON)",
+    },
+  ],
+};

package/src/evaluate/index.ts

@@ -11,6 +11,7 @@ import {
 import { Dependencies } from "../dependencies";
 import { SCHEMA_VERSION } from "../config";
 import { buildDatafile } from "../builder";
+import { Plugin } from "../cli";
 
 function printEvaluationDetails(evaluation: Evaluation) {
   const ignoreKeys = ["featureKey", "variableKey", "traffic", "force"];
@@ -191,3 +192,32 @@ export async function evaluateFeature(deps: Dependencies, options: EvaluateOptio
     console.log("No variables defined.");
   }
 }
+
+export const evaluatePlugin: Plugin = {
+  command: "evaluate",
+  handler: async ({ rootDirectoryPath, projectConfig, datasource, parsed }) => {
+    await evaluateFeature(
+      {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: parsed,
+      },
+      {
+        environment: parsed.environment,
+        feature: parsed.feature,
+        context: parsed.context ? JSON.parse(parsed.context) : {},
+        print: parsed.print,
+        pretty: parsed.pretty,
+        verbose: parsed.verbose,
+      },
+    );
+  },
+  examples: [
+    {
+      command:
+        'evaluate --environment=production --feature=my_feature --context=\'{"userId": "123"}\'',
+      description: "evaluate a feature against provided context",
+    },
+  ],
+};