@featurevisor/core 1.25.0 → 1.27.0

package/src/find-duplicate-segments/index.ts

@@ -1,5 +1,6 @@
 import { findDuplicateSegments, DuplicateSegmentsOptions } from "./findDuplicateSegments";
 import { Dependencies } from "../dependencies";
+import { Plugin } from "../cli";
 
 export async function findDuplicateSegmentsInProject(
   deps: Dependencies,
@@ -26,3 +27,30 @@ export async function findDuplicateSegmentsInProject(
     }
   });
 }
+
+export const findDuplicateSegmentsPlugin: Plugin = {
+  command: "find-duplicate-segments",
+  handler: async ({ rootDirectoryPath, projectConfig, datasource, parsed }) => {
+    await findDuplicateSegmentsInProject(
+      {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: parsed,
+      },
+      {
+        authors: parsed.authors,
+      },
+    );
+  },
+  examples: [
+    {
+      command: "find-duplicate-segments",
+      description: "Find duplicate segments in the project",
+    },
+    {
+      command: "find-duplicate-segments --authors",
+      description: "Find duplicate segments in the project and list authors",
+    },
+  ],
+};

package/src/find-usage/index.ts

@@ -1,6 +1,7 @@
 import { Condition, FeatureKey, SegmentKey, AttributeKey } from "@featurevisor/types";
 
 import { Dependencies } from "../dependencies";
+import { Plugin } from "../cli";
 import {
   extractAttributeKeysFromConditions,
   extractSegmentKeysFromGroupSegments,
@@ -371,3 +372,46 @@ export async function findUsageInProject(deps: Dependencies, options: FindUsageO
 
   console.log("Please specify a segment or attribute.");
 }
+
+export const findUsagePlugin: Plugin = {
+  command: "find-usage",
+  handler: async ({ rootDirectoryPath, projectConfig, datasource, parsed }) => {
+    await findUsageInProject(
+      {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: parsed,
+      },
+      {
+        segment: parsed.segment,
+        attribute: parsed.attribute,
+        unusedSegments: parsed.unusedSegments,
+        unusedAttributes: parsed.unusedAttributes,
+        authors: parsed.authors,
+      },
+    );
+  },
+  examples: [
+    {
+      command: "find-usage --segment=<segmentKey>",
+      description: "Find usage of a segment",
+    },
+    {
+      command: "find-usage --attribute=<attributeKey>",
+      description: "Find usage of an attribute",
+    },
+    {
+      command: "find-usage --unused-segments",
+      description: "Find unused segments",
+    },
+    {
+      command: "find-usage --unused-attributes",
+      description: "Find unused attributes",
+    },
+    {
+      command: "find-usage --authors",
+      description: "List authors of the usage",
+    },
+  ],
+};

package/src/generate-code/index.ts

@@ -5,6 +5,7 @@ import * as mkdirp from "mkdirp";
 
 import { generateTypeScriptCodeForProject } from "./typescript";
 import { Dependencies } from "../dependencies";
+import { Plugin } from "../cli";
 
 export const ALLOWED_LANGUAGES_FOR_CODE_GENERATION = ["typescript"];
 
@@ -50,3 +51,27 @@ export async function generateCodeForProject(
 
   throw new Error(`Language ${cliOptions.language} is not supported`);
 }
+
+export const generateCodePlugin: Plugin = {
+  command: "generate-code",
+  handler: async function ({ rootDirectoryPath, projectConfig, datasource, parsed }) {
+    await generateCodeForProject(
+      {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: parsed,
+      },
+      {
+        language: parsed.language,
+        outDir: parsed.outDir,
+      },
+    );
+  },
+  examples: [
+    {
+      command: "generate-code --language typescript --out-dir src/generated",
+      description: "Generate TypeScript code for the project",
+    },
+  ],
+};

package/src/index.ts

@@ -14,3 +14,4 @@ export * from "./benchmark";
 export * from "./evaluate";
 export * from "./assess-distribution";
 export * from "./info";
+export * from "./cli";

package/src/info/index.ts

@@ -1,5 +1,6 @@
 import { Dependencies } from "../dependencies";
 import { getMatrixCombinations } from "../tester/matrix";
+import { Plugin } from "../cli";
 
 export async function showProjectInfo(deps: Dependencies) {
   const { datasource } = deps;
@@ -52,3 +53,21 @@ export async function showProjectInfo(deps: Dependencies) {
 
   console.log("  - Total assertions: ", assertionsCount);
 }
+
+export const infoPlugin: Plugin = {
+  command: "info",
+  handler: async function ({ rootDirectoryPath, projectConfig, datasource, parsed }) {
+    await showProjectInfo({
+      rootDirectoryPath,
+      projectConfig,
+      datasource,
+      options: parsed,
+    });
+  },
+  examples: [
+    {
+      command: "info",
+      description: "show various stats for the project",
+    },
+  ],
+};

package/src/init/index.ts

@@ -1,6 +1,8 @@
 import axios from "axios";
 import * as tar from "tar";
 
+import { Plugin } from "../cli";
+
 export const DEFAULT_EXAMPLE = "example-yml";
 
 export const EXAMPLES_ORG_NAME = "fahad19";
@@ -42,3 +44,22 @@ export function initProject(
     });
   });
 }
+
+export const initPlugin: Plugin = {
+  command: "init",
+  handler: async function (options) {
+    const { rootDirectoryPath, parsed } = options;
+
+    await initProject(rootDirectoryPath, parsed.example);
+  },
+  examples: [
+    {
+      command: "init",
+      description: "scaffold a new project in current directory",
+    },
+    {
+      command: "init --example=exampleName",
+      description: "scaffold a new project in current directory from known example",
+    },
+  ],
+};

package/src/linter/lintProject.ts

@@ -13,6 +13,7 @@ import { checkForFeatureExceedingGroupSlotPercentage } from "./checkPercentageEx
 import { printZodError } from "./printError";
 import { Dependencies } from "../dependencies";
 import { CLI_FORMAT_RED, CLI_FORMAT_UNDERLINE } from "../tester/cliFormat";
+import { Plugin } from "../cli";
 
 export interface LintProjectOptions {
   keyPattern?: string;
@@ -340,3 +341,53 @@ export async function lintProject(
 
   return hasError;
 }
+
+export const lintPlugin: Plugin = {
+  command: "lint",
+  handler: async function (options) {
+    const { rootDirectoryPath, projectConfig, datasource, parsed } = options;
+
+    const hasError = await lintProject(
+      {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: parsed,
+      },
+      {
+        keyPattern: parsed.keyPattern,
+        entityType: parsed.entityType,
+      },
+    );
+
+    if (hasError) {
+      return false;
+    }
+  },
+  examples: [
+    {
+      command: "lint",
+      description: "lint all entities",
+    },
+    {
+      command: "lint --entityType=feature",
+      description: "lint only features",
+    },
+    {
+      command: "lint --entityType=segment",
+      description: "lint only segments",
+    },
+    {
+      command: "lint --entityType=group",
+      description: "lint only groups",
+    },
+    {
+      command: "lint --entityType=test",
+      description: "lint only tests",
+    },
+    {
+      command: 'lint --keyPattern="abc"',
+      description: `lint only entities with keys containing "abc"`,
+    },
+  ],
+};

package/src/restore/index.ts

@@ -2,6 +2,7 @@ import * as path from "path";
 import { execSync } from "child_process";
 
 import { Dependencies } from "../dependencies";
+import { Plugin } from "../cli";
 
 export async function restoreProject(deps: Dependencies) {
   const { rootDirectoryPath, projectConfig } = deps;
@@ -21,3 +22,21 @@ export async function restoreProject(deps: Dependencies) {
     throw new Error("Failed to restore state files.");
   }
 }
+
+export const restorePlugin: Plugin = {
+  command: "restore",
+  handler: async function ({ rootDirectoryPath, projectConfig, datasource, parsed }) {
+    await restoreProject({
+      rootDirectoryPath,
+      projectConfig,
+      datasource,
+      options: parsed,
+    });
+  },
+  examples: [
+    {
+      command: "restore",
+      description: "restore state files",
+    },
+  ],
+};

package/src/site/index.ts

@@ -1,2 +1,46 @@
-export * from "./exportSite";
-export * from "./serveSite";
+import { Plugin } from "../cli";
+import { exportSite } from "./exportSite";
+import { serveSite } from "./serveSite";
+
+export const sitePlugin: Plugin = {
+  command: "site [subcommand]",
+  handler: async function ({ rootDirectoryPath, projectConfig, datasource, parsed }) {
+    const deps = {
+      rootDirectoryPath,
+      projectConfig,
+      datasource,
+      options: parsed,
+    };
+
+    const allowedSubcommands = ["export", "serve"];
+
+    if (!allowedSubcommands.includes(parsed.subcommand)) {
+      console.log("Please specify a subcommand: `export` or `serve`");
+      return;
+    }
+
+    // export
+    if (parsed.subcommand === "export") {
+      const hasError = await exportSite(deps);
+
+      if (hasError) {
+        return false;
+      }
+    }
+
+    // serve
+    if (parsed.subcommand === "serve") {
+      serveSite(deps);
+    }
+  },
+  examples: [
+    {
+      command: "site export",
+      description: "generate static site with project data",
+    },
+    {
+      command: "site serve",
+      description: "serve already exported site locally",
+    },
+  ],
+};

package/src/tester/testProject.ts

@@ -11,6 +11,7 @@ import { printTestResult } from "./printTestResult";
 
 import { buildDatafile } from "../builder";
 import { SCHEMA_VERSION } from "../config";
+import { Plugin } from "../cli";
 
 export interface TestProjectOptions {
   keyPattern?: string;
@@ -211,3 +212,48 @@ export async function testProject(
 
   return hasError;
 }
+
+export const testPlugin: Plugin = {
+  command: "test",
+  handler: async function ({ rootDirectoryPath, projectConfig, datasource, parsed }) {
+    const hasError = await testProject(
+      {
+        rootDirectoryPath,
+        projectConfig,
+        datasource,
+        options: parsed,
+      },
+      parsed as TestProjectOptions,
+    );
+
+    if (hasError) {
+      return false;
+    }
+  },
+  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",
+    },
+  ],
+};