Merge pull request #4 from codiga/feat/interactive-rulesets

Interactive ruleset selection (including multi inputs)

Author: dastrong-codiga

graphql/queries.js

@@ -27,12 +27,3 @@ export const GET_RULESETS_FOR_CLIENT = gql`
     }
   }
 `;
-
-export const GET_RULESET = gql`
-  query getRuleset($name: String!) {
-    ruleSet(name: $name) {
-      id
-      name
-    }
-  }
-`;

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@codiga/cli",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "A Codiga CLI used to integrate Codiga easily in your projects",
   "homepage": "https://github.com/codiga/codiga-cli",
   "repository": {

package.json

@@ -12,9 +12,11 @@ import {
   printEmptyLine,
   printFailure,
   printInfo,
+  printSubItem,
   printSuggestion,
 } from "../utils/print";
-import { convertRulesetsToString, getRuleset } from "../utils/ruleset";
+import { convertRulesetsToString } from "../utils/rulesets";
+import { getRulesetsByNames, getUserPromptedRulesets } from "../utils/rulesets";
 
 /**
  * Creates a codiga.yml file's content with the rulesets given
@@ -44,39 +46,65 @@ export async function createCodigaYml(codigaFileLocation, rulesets) {
  * Handles adding a ruleset to a codiga.yml file
  * @param {string[]} rulesetNames
  */
-export async function addRuleset(rulesetNames) {
-  // TODO - change to a prompt when no rulesets are given
-  const rulesetName = rulesetNames[0];
-  if (!rulesetName) {
+export async function addRuleset(rulesetNamesParams) {
+  let rulesetNames = rulesetNamesParams;
+
+  /**
+   * if `codiga ruleset-add` was called with no rulesets, we'll
+   * open an interactive menu for them to select suggested rulesets
+   */
+  if (rulesetNamesParams.length === 0) {
+    // prompt the user to choose some rulesets
+    rulesetNames = await getUserPromptedRulesets();
+    // if the user didn't choose any notify them and exit
+    if (rulesetNames.length === 0) {
+      printEmptyLine();
+      printInfo("No rulesets were chosen.");
+      printCommandSuggestion(
+        " ↳ Run the command again to get started:",
+        ACTION_RULESET_ADD
+      );
+      printSuggestion(
+        " ↳ Find all publically available rulesets here:",
+        "https://app.codiga.io/hub/rulesets"
+      );
+      printEmptyLine();
+      process.exit(1);
+    }
+  }
+
+  /**
+   * Here we take the ruleset names that were chosen through the interactive
+   * mode or were received from the command parameters, and validate which
+   * ones are valid and should be added to a `codiga.yml` file and which
+   * we should inform the user won't be added
+   */
+
+  const { found: validRulesets, notFound } = await getRulesetsByNames(
+    rulesetNames
+  );
+
+  if (notFound.length > 0) {
     printEmptyLine();
-    printFailure("You need to specify a ruleset to add");
-    printSuggestion(
-      " ↳ You can search for rulesets here:",
-      "https://app.codiga.io/hub/rulesets"
+    printFailure(
+      "The following rulesets either don't exist or you lack the permissions to access it:"
     );
+    notFound.forEach((notFoundRuleset) => {
+      printSubItem(`- ${notFoundRuleset}`);
+    });
     printCommandSuggestion(
-      " ↳ Then follow this command structure:",
-      `${ACTION_RULESET_ADD} <ruleset-name>`
+      "Ensure you have a Codiga API token set with one of the following commands:",
+      ACTION_TOKEN_ADD
     );
-    printEmptyLine();
-    process.exit(1);
   }
 
-  // Check if the ruleset exists before continuing onwards
-  const ruleset = await getRuleset({ name: rulesetName });
-  if (!ruleset) {
+  if (validRulesets.length === 0) {
     printEmptyLine();
-    printFailure(
-      "That ruleset either doesn't exist or you lack the permissions to access it"
-    );
+    printInfo("No valid rulesets were found to continue");
     printCommandSuggestion(
       " ↳ Ensure you have a Codiga API token set with one of the following commands:",
       ACTION_TOKEN_ADD
     );
-    printSuggestion(
-      " ↳ You can find more rulesets here:",
-      "https://app.codiga.io/hub/rulesets"
-    );
     printEmptyLine();
     process.exit(1);
   }
@@ -92,46 +120,71 @@ export async function addRuleset(rulesetNames) {
   const codigaFileContent = readFile(codigaFileLocation);
 
   /**
-   * If we found a `codiga.yml` file, add the rule to it
-   * If we don't find a `codiga.yml` file, create the file and add the rule to it
+   * If we found a `codiga.yml` file, add the new rulesets to it
+   * If we don't find a `codiga.yml` file, create the file and add the rulesets to it
    */
   if (codigaFileContent) {
     const parsedFile = parseYamlFile(codigaFileContent, codigaFileLocation);
     const codigaRulesets = parsedFile.rulesets;
-    if (codigaRulesets.includes(rulesetName)) {
+
+    // check which rulesets are new and which are already used in the `codiga.yml` file
+    const { usedRulesets, newRulesets } = validRulesets.reduce(
+      (acc, ruleset) => {
+        if (codigaRulesets.includes(ruleset)) {
+          acc.usedRulesets.push(ruleset);
+        } else {
+          acc.newRulesets.push(ruleset);
+        }
+        return acc;
+      },
+      {
+        usedRulesets: [],
+        newRulesets: [],
+      }
+    );
+
+    if (usedRulesets.length > 0) {
       printEmptyLine();
       printInfo(
-        `The ruleset (${rulesetName}) already exists in your \`codiga.yml\``
-      );
-      printSuggestion;
-      printEmptyLine();
-      process.exit(1);
-    } else {
-      // adding the new ruleset to the file
-      await createCodigaYml(codigaFileLocation, [
-        ...codigaRulesets,
-        rulesetName,
-      ]);
-      printSuggestion(
-        `We added ${rulesetName} to your codiga.yml file:`,
-        codigaFileLocation
-      );
-      printSuggestion(
-        " ↳ Find more rulesets to add here:",
-        "https://app.codiga.io/hub/rulesets"
+        `The following rulesets already exists in your \`codiga.yml\` file:`
       );
+      usedRulesets.forEach((ruleset) => {
+        printSubItem(`- ${ruleset}`);
+      });
     }
+
+    // adding the new ruleset to the file
+    await createCodigaYml(codigaFileLocation, [
+      ...codigaRulesets,
+      ...newRulesets,
+    ]);
+    printEmptyLine();
+    printSuggestion(
+      `We added ${newRulesets.length} ruleset${
+        newRulesets.length === 1 ? "" : "s"
+      } to your codiga.yml file:`,
+      codigaFileLocation
+    );
+    printSuggestion(
+      " ↳ Find more rulesets to add here:",
+      "https://app.codiga.io/hub/rulesets"
+    );
+    printEmptyLine();
   } else {
     // creating a new codiga.yml with the ruleset here
-    await createCodigaYml(codigaFileLocation, [rulesetName]);
+    await createCodigaYml(codigaFileLocation, validRulesets);
+    printEmptyLine();
     printSuggestion(
-      `No codiga.yml file found, so we created one and added ${rulesetName} to it:`,
+      `No codiga.yml file found, so we created one and added ${
+        validRulesets.length
+      } ruleset${validRulesets.length === 1 ? "" : "s"} to it:`,
       codigaFileLocation
     );
     printSuggestion(
       " ↳ Find more rulesets to add here:",
       "https://app.codiga.io/hub/rulesets"
     );
+    printEmptyLine();
   }
 
   process.exit(0);

src/addRuleset.js

@@ -52,7 +52,7 @@ function parseCommand(args) {
         },
       }
     )
-    .command(ACTION_RULESET_ADD, "Add a ruleset to a `codiga.yml` file")
+    .command(ACTION_RULESET_ADD, "Add rulesets to a `codiga.yml` file")
     .help(true).argv;
 
   // format any actions into a single object with default values

src/cli.js

@@ -42,7 +42,7 @@ exports.prompt = (prompts) => {
       a.choices.forEach((c, i) => {
         const expected = a.choices[i];
         if (expected) {
-          expect(prompt.choices[i].name).toContain(expected);
+          expect(prompt.choices[i]).toEqual(expected);
         }
       });
     }
@@ -54,12 +54,20 @@ exports.prompt = (prompts) => {
 
     if (a.choose != null) {
       expect(prompt.type).toBe("list");
-      setValue(prompt.choices[a.choose].value);
+      setValue(
+        prompt.choices.find((choice) => choice.value === a.choose)?.value
+      );
     }
 
     if (a.check != null) {
       expect(prompt.type).toBe("checkbox");
-      setValue(a.check.map((i) => prompt.choices[i].value));
+      setValue(
+        a.check
+          .map((check) => {
+            return prompt.choices.find((choice) => choice.name === check)?.name;
+          })
+          .filter((c) => c)
+      );
     }
 
     if (a.confirm != null) {