@featurevisor/cli 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.0.3](https://github.com/fahad19/featurevisor/compare/v0.0.2...v0.0.3) (2023-03-05)
+
+
+### Bug Fixes
+
+* publish access ([ea5cd7c](https://github.com/fahad19/featurevisor/commit/ea5cd7cd8554e2def5fdcc1d3488598a08e99bfa))
+
+
+
+
+
+## [0.0.2](https://github.com/fahad19/featurevisor/compare/v0.0.1...v0.0.2) (2023-03-05)
+
+
+### Bug Fixes
+
+* cli package ([5aeca09](https://github.com/fahad19/featurevisor/commit/5aeca098a02afcd16c5327dc94a286006f618d60))
+
+
+
+
+
+## 0.0.1 (2023-03-05)
+
+
+### Bug Fixes
+
+* linting ([230bfa0](https://github.com/fahad19/featurevisor/commit/230bfa0824f79181581585ccc37c2e78c5aeac42))

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Fahad Heylaal (https://fahad19.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+# @featurevisor/cli
+
+CLI package of Featurevisor.
+
+Visit [https://featurevisor.com](https://featurevisor.com) for more information.
+
+## Installation
+
+```
+$ npm install -g @featurevisor/cli
+```
+
+Or via `npx`:
+
+```
+$ npx featurevisor <command>
+```
+
+## Usage
+
+### `init`
+
+Initialize your project.
+
+```
+$ featurevisor init
+```
+
+If you want to initialize your project with a specific example:
+
+```
+$ featurevisor init --example <name>
+```
+
+Examples found [here](../../examples).
+
+### `lint`
+
+Check if your YAMLs are valid.
+
+```
+$ featurevisor lint
+```
+
+
+### `build`
+
+Build your datafiles.
+
+```
+$ featurevisor build
+```
+
+### `test`
+
+Test your generated datafiles using the SDK, against specs written in YAMLs.
+
+```
+$ featurevisor test
+```
+
+See test specs in YAMLs [here](../../examples/example-1/tests) for inspiration.
+
+## License
+
+MIT © [Fahad Heylaal](https://fahad19.com)

package/bin.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require("./lib/index");

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,148 @@
+"use strict";
+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(exports, "__esModule", { value: true });
+var fs = require("fs");
+var path = require("path");
+var yargs = require("yargs");
+var core_1 = require("@featurevisor/core");
+process.on("unhandledRejection", function (reason, p) {
+    console.error(reason);
+    process.exit(1);
+});
+function requireConfigFile(configModulePath) {
+    if (!fs.existsSync(configModulePath)) {
+        console.error("No config file found. Please create `featurevisor.config.js` file first.");
+        process.exit(1);
+    }
+}
+function requireAndGetProjectConfig(rootDirectoryPath) {
+    var configModulePath = path.join(rootDirectoryPath, core_1.CONFIG_MODULE_NAME);
+    requireConfigFile(configModulePath);
+    return (0, core_1.getProjectConfig)(rootDirectoryPath);
+}
+function main() {
+    return __awaiter(this, void 0, void 0, function () {
+        var rootDirectoryPath;
+        return __generator(this, function (_a) {
+            rootDirectoryPath = process.cwd();
+            yargs(process.argv.slice(2))
+                .usage("Usage: <command> [options]")
+                /**
+                 * Commands
+                 */
+                .command({
+                command: "init",
+                handler: function (options) {
+                    return __awaiter(this, void 0, void 0, function () {
+                        var hasError;
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0: return [4 /*yield*/, (0, core_1.initProject)(rootDirectoryPath, options.example)];
+                                case 1:
+                                    hasError = _a.sent();
+                                    if (hasError) {
+                                        process.exit(1);
+                                    }
+                                    return [2 /*return*/];
+                            }
+                        });
+                    });
+                },
+            })
+                .example("$0 init", "scaffold a new project")
+                .example("$0 init --example=exampleName", "scaffold a new project from known example")
+                .command({
+                command: "lint",
+                handler: function (options) {
+                    return __awaiter(this, void 0, void 0, function () {
+                        var projectConfig, hasError;
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0:
+                                    projectConfig = requireAndGetProjectConfig(rootDirectoryPath);
+                                    return [4 /*yield*/, (0, core_1.lintProject)(projectConfig)];
+                                case 1:
+                                    hasError = _a.sent();
+                                    if (hasError) {
+                                        process.exit(1);
+                                    }
+                                    return [2 /*return*/];
+                            }
+                        });
+                    });
+                },
+            })
+                .example("$0 lint", "lint all YAML file content")
+                .command({
+                command: "build",
+                handler: function (options) {
+                    var projectConfig = requireAndGetProjectConfig(rootDirectoryPath);
+                    (0, core_1.buildProject)(rootDirectoryPath, projectConfig);
+                },
+            })
+                .example("$0 build", "build datafiles")
+                .command({
+                command: "test",
+                handler: function (options) {
+                    var projectConfig = requireAndGetProjectConfig(rootDirectoryPath);
+                    var hasError = (0, core_1.testProject)(rootDirectoryPath, projectConfig);
+                    if (hasError) {
+                        process.exit(1);
+                    }
+                },
+            })
+                .example("$0 test", "test features")
+                /**
+                 * Options
+                 */
+                // @TODO: add --config option
+                /**
+                 * Help
+                 */
+                .command({
+                command: "*",
+                handler: function () {
+                    yargs.showHelp();
+                },
+            }).argv;
+            return [2 /*return*/];
+        });
+    });
+}
+main();
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uBAAyB;AACzB,2BAA6B;AAE7B,6BAA+B;AAE/B,2CAO4B;AAE5B,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,UAAC,MAAM,EAAE,CAAC;IACzC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,SAAS,iBAAiB,CAAC,gBAAgB;IACzC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE;QACpC,OAAO,CAAC,KAAK,CAAC,0EAA0E,CAAC,CAAC;QAE1F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC;AAED,SAAS,0BAA0B,CAAC,iBAAiB;IACnD,IAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,yBAAkB,CAAC,CAAC;IAE1E,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IAEpC,OAAO,IAAA,uBAAgB,EAAC,iBAAiB,CAAC,CAAC;AAC7C,CAAC;AAED,SAAe,IAAI;;;;YACX,iBAAiB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;YAExC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;iBACzB,KAAK,CAAC,4BAA4B,CAAC;gBAEpC;;mBAEG;iBACF,OAAO,CAAC;gBACP,OAAO,EAAE,MAAM;gBACf,OAAO,EAAE,UAAgB,OAAO;;;;;wCACb,qBAAM,IAAA,kBAAW,EAAC,iBAAiB,EAAE,OAAO,CAAC,OAAO,CAAC,EAAA;;oCAAhE,QAAQ,GAAG,SAAqD;oCAEtE,IAAI,QAAQ,EAAE;wCACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;qCACjB;;;;;iBACF;aACF,CAAC;iBACD,OAAO,CAAC,SAAS,EAAE,wBAAwB,CAAC;iBAC5C,OAAO,CAAC,+BAA+B,EAAE,2CAA2C,CAAC;iBAErF,OAAO,CAAC;gBACP,OAAO,EAAE,MAAM;gBACf,OAAO,EAAE,UAAgB,OAAO;;;;;;oCACxB,aAAa,GAAG,0BAA0B,CAAC,iBAAiB,CAAC,CAAC;oCAEnD,qBAAM,IAAA,kBAAW,EAAC,aAAa,CAAC,EAAA;;oCAA3C,QAAQ,GAAG,SAAgC;oCAEjD,IAAI,QAAQ,EAAE;wCACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;qCACjB;;;;;iBACF;aACF,CAAC;iBACD,OAAO,CAAC,SAAS,EAAE,4BAA4B,CAAC;iBAEhD,OAAO,CAAC;gBACP,OAAO,EAAE,OAAO;gBAChB,OAAO,EAAE,UAAU,OAAO;oBACxB,IAAM,aAAa,GAAG,0BAA0B,CAAC,iBAAiB,CAAC,CAAC;oBAEpE,IAAA,mBAAY,EAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;gBACjD,CAAC;aACF,CAAC;iBACD,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC;iBAEtC,OAAO,CAAC;gBACP,OAAO,EAAE,MAAM;gBACf,OAAO,EAAE,UAAU,OAAO;oBACxB,IAAM,aAAa,GAAG,0BAA0B,CAAC,iBAAiB,CAAC,CAAC;oBAEpE,IAAM,QAAQ,GAAG,IAAA,kBAAW,EAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;oBAE/D,IAAI,QAAQ,EAAE;wBACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;qBACjB;gBACH,CAAC;aACF,CAAC;iBACD,OAAO,CAAC,SAAS,EAAE,eAAe,CAAC;gBAEpC;;mBAEG;gBAEH,6BAA6B;gBAE7B;;mBAEG;iBAEF,OAAO,CAAC;gBACP,OAAO,EAAE,GAAG;gBACZ,OAAO;oBACL,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACnB,CAAC;aACF,CAAC,CAAC,IAAI,CAAC;YAEV,sBAAO;;;CACR;AAED,IAAI,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@featurevisor/cli",
+  "version": "0.0.3",
+  "description": "CLI package of Featurevisor",
+  "main": "bin.js",
+  "types": "lib/index.d.ts",
+  "bin": {
+    "featurevisor": "bin.js"
+  },
+  "scripts": {
+    "lint": "echo 'not linting in this package yet'",
+    "transpile": "rimraf lib && tsc --project tsconfig.cjs.json",
+    "dist": "echo 'Nothing to dist here'",
+    "build": "npm run transpile",
+    "test": "echo 'Nothing to test in this package'"
+  },
+  "homepage": "https://featurevisor.com",
+  "keywords": [
+    "featurevisor",
+    "feature",
+    "features",
+    "flags",
+    "feature flags",
+    "feature toggles",
+    "feature management",
+    "experimentation",
+    "experiment",
+    "experiments"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fahad19/featurevisor.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "bugs": {
+    "url": "https://github.com/fahad19/featurevisor/issues"
+  },
+  "author": {
+    "name": "Fahad Heylaal",
+    "url": "https://fahad19.com"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@featurevisor/core": "^0.0.3",
+    "yargs": "^17.6.2"
+  },
+  "devDependencies": {
+    "@types/yargs": "^17.0.22"
+  },
+  "gitHead": "303aca84f7c32163cb1079513d799296bd892e72"
+}

package/src/index.ts

@@ -0,0 +1,116 @@
+import * as fs from "fs";
+import * as path from "path";
+
+import * as yargs from "yargs";
+
+import {
+  CONFIG_MODULE_NAME,
+  getProjectConfig,
+  lintProject,
+  testProject,
+  buildProject,
+  initProject,
+} from "@featurevisor/core";
+
+process.on("unhandledRejection", (reason, p) => {
+  console.error(reason);
+  process.exit(1);
+});
+
+function requireConfigFile(configModulePath) {
+  if (!fs.existsSync(configModulePath)) {
+    console.error("No config file found. Please create `featurevisor.config.js` file first.");
+
+    process.exit(1);
+  }
+}
+
+function requireAndGetProjectConfig(rootDirectoryPath) {
+  const configModulePath = path.join(rootDirectoryPath, CONFIG_MODULE_NAME);
+
+  requireConfigFile(configModulePath);
+
+  return getProjectConfig(rootDirectoryPath);
+}
+
+async function main() {
+  const rootDirectoryPath = process.cwd();
+
+  yargs(process.argv.slice(2))
+    .usage("Usage: <command> [options]")
+
+    /**
+     * Commands
+     */
+    .command({
+      command: "init",
+      handler: async function (options) {
+        const hasError = await initProject(rootDirectoryPath, options.example);
+
+        if (hasError) {
+          process.exit(1);
+        }
+      },
+    })
+    .example("$0 init", "scaffold a new project")
+    .example("$0 init --example=exampleName", "scaffold a new project from known example")
+
+    .command({
+      command: "lint",
+      handler: async function (options) {
+        const projectConfig = requireAndGetProjectConfig(rootDirectoryPath);
+
+        const hasError = await lintProject(projectConfig);
+
+        if (hasError) {
+          process.exit(1);
+        }
+      },
+    })
+    .example("$0 lint", "lint all YAML file content")
+
+    .command({
+      command: "build",
+      handler: function (options) {
+        const projectConfig = requireAndGetProjectConfig(rootDirectoryPath);
+
+        buildProject(rootDirectoryPath, projectConfig);
+      },
+    })
+    .example("$0 build", "build datafiles")
+
+    .command({
+      command: "test",
+      handler: function (options) {
+        const projectConfig = requireAndGetProjectConfig(rootDirectoryPath);
+
+        const hasError = testProject(rootDirectoryPath, projectConfig);
+
+        if (hasError) {
+          process.exit(1);
+        }
+      },
+    })
+    .example("$0 test", "test features")
+
+    /**
+     * Options
+     */
+
+    // @TODO: add --config option
+
+    /**
+     * Help
+     */
+
+    .command({
+      command: "*",
+      handler() {
+        yargs.showHelp();
+      },
+    }).argv;
+
+  return;
+}
+
+main();

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.cjs.json",
+  "compilerOptions": {
+    "outDir": "./lib"
+  },
+  "include": ["./src/**/*.ts"]
+}