feat: Introduce interactive update

Use `--interactive` or `-i` to select the dependencies you want to update.
peerigon · Jul 3, 2024 · d3975e2 · d3975e2
1 parent cb5cdda
commit d3975e2
Show file tree

Hide file tree

Showing 9 changed files with 13,503 additions and 9,568 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -31,6 +31,7 @@
     "pify": "^4.0.1",
     "semver": "^7.3.5",
     "string-width": "^4.2.0",
+    "inquirer": "7.0.0",
     "unicons": "0.0.3",
     "yargs": "^15.1.0"
   },

diff --git a/src/Updtr.js b/src/Updtr.js
@@ -95,6 +95,7 @@ export default class Updtr extends EventEmitter {
             registry,
             updateTo,
             save,
+            interactive: config.interactive,
         };
         this.cmds = cmds[packageManager];
         this.parse = parse[packageManager];

diff --git a/src/bin/argv.js b/src/bin/argv.js
@@ -35,6 +35,11 @@ export default yargs
         array: true,
         alias: "ex",
     })
+    .option("interactive", {
+        describe: "Let you select the packages you want to update",
+        alias: "i",
+        default: false,
+    })
     .option("update-to", {
         describe: "Specify which updates you want to install",
         choices: UPDATE_TO_OPTIONS,

diff --git a/src/run.js b/src/run.js
@@ -1,3 +1,5 @@
+import inquirer from "inquirer";
+import chalk from "chalk";
 import init from "./tasks/init";
 import sequentialUpdate from "./tasks/sequentialUpdate";
 import splitUpdateTasks from "./tasks/util/splitUpdateTasks";
@@ -46,14 +48,62 @@ async function runUpdateTasks(updtr, updateTasks) {
     return finish(updtr, results);
 }
 
+function generateChoices(tasks) {
+    let dims = [
+        "name".length,
+        "from".length,
+        // "to".length,
+    ];
+
+    dims = tasks.reduce((acc, {name, rollbackTo, updateTo}) => ([
+        name.length > acc[0] ? name.length : acc[0],
+        rollbackTo.length > acc[1] ? rollbackTo.length : acc[1],
+        // updateTo.length > acc[2] ? updateTo.length : acc[2],
+    ]), dims);
+
+    let choices = [
+        new inquirer.Separator(" "),
+        new inquirer.Separator(chalk`  {green.bold.underline name}${"".padEnd((dims[0] + 3) - "name".length, " ")}{green.bold.underline from}${"".padEnd((dims[1] + 5) - "from".length, " ")}{green.bold.underline to}`),
+    ];
+
+    choices = choices.concat(tasks.map(task => ({
+        name: chalk`{green ${task.name.padEnd(dims[0] + 3)}}{blue ${task.rollbackTo.padEnd(dims[1])}}  ❯  {blue ${task.updateTo}}`,
+        value: task,
+        short: `${task.name}@${task.updateTo}`,
+    })));
+
+    return choices;
+}
+
+async function selectUpdateTasks(tasks) {
+    const prompt = inquirer.createPromptModule();
+    const choices = generateChoices(tasks);
+    const {packagesToUpdate} = await prompt([
+        {
+            name: "packagesToUpdate",
+            type: "checkbox",
+            message: chalk`{white.bold Choose which packages to update.}`,
+            choices,
+            pageSize: choices.length,
+            validate: answer => Boolean(answer.length) || "You must choose at least one package.",
+        },
+    ]);
+
+    return packagesToUpdate;
+}
+
 export default (async function run(updtr) {
     const results = [];
 
     updtr.emit("start", {
         config: updtr.config,
     });
 
-    const {updateTasks} = await init(updtr);
+    let {updateTasks} = await init(updtr);
+
+    if (updtr.config.interactive === true) {
+        updateTasks = await selectUpdateTasks(updateTasks);
+    }
 
     if (updateTasks.length > 0) {
         results.push(...(await runUpdateTasks(updtr, updateTasks)));
@@ -67,3 +117,4 @@ export default (async function run(updtr) {
 
     return results;
 });
+
diff --git a/test/__snapshots__/Updtr.test.js.snap b/test/__snapshots__/Updtr.test.js.snap
@@ -4,6 +4,7 @@ exports[`new Updtr() .config should match the default shape 1`] = `
 Object {
   "cwd": "/updtr/test/cwd",
   "exclude": Array [],
+  "interactive": undefined,
   "registry": undefined,
   "save": "smart",
   "test": undefined,

diff --git a/test/__snapshots__/run.test.js.snap b/test/__snapshots__/run.test.js.snap
@@ -7,6 +7,7 @@ Array [
     "config": Object {
       "cwd": "/updtr/test/cwd",
       "exclude": Array [],
+      "interactive": undefined,
       "registry": undefined,
       "save": "smart",
       "test": undefined,
@@ -24,6 +25,7 @@ Array [
     "config": Object {
       "cwd": "/updtr/test/cwd",
       "exclude": Array [],
+      "interactive": undefined,
       "registry": undefined,
       "save": "smart",
       "test": undefined,
@@ -55,6 +57,7 @@ Array [
     "config": Object {
       "cwd": "/updtr/test/cwd",
       "exclude": Array [],
+      "interactive": undefined,
       "registry": undefined,
       "save": "smart",
       "test": undefined,
@@ -73,6 +76,7 @@ Array [
     "config": Object {
       "cwd": "/updtr/test/cwd",
       "exclude": Array [],
+      "interactive": undefined,
       "registry": undefined,
       "save": "smart",
       "test": undefined,
@@ -104,6 +108,7 @@ Array [
     "config": Object {
       "cwd": "/updtr/test/cwd",
       "exclude": Array [],
+      "interactive": undefined,
       "registry": undefined,
       "save": "smart",
       "test": undefined,
@@ -135,6 +140,7 @@ Array [
     "config": Object {
       "cwd": "/updtr/test/cwd",
       "exclude": Array [],
+      "interactive": undefined,
       "registry": undefined,
       "save": "smart",
       "test": undefined,

diff --git a/test/bin/__snapshots__/index.test.js.snap b/test/bin/__snapshots__/index.test.js.snap
@@ -14,6 +14,7 @@ Object {
       "b",
       "c",
     ],
+    "interactive": false,
     "save": "exact",
     "test": "jest -b",
     "updateTo": "non-breaking",
@@ -32,6 +33,7 @@ Object {
   "updtrConfig": Object {
     "cwd": "/test/bin",
     "exclude": Array [],
+    "interactive": false,
     "save": "smart",
     "updateTo": "latest",
     "use": "npm",

diff --git a/test/tasks/__snapshots__/init.test.js.snap b/test/tasks/__snapshots__/init.test.js.snap
@@ -22,6 +22,7 @@ Array [
           "updtr-test-module-1",
           "updtr-test-module-2",
         ],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -40,6 +41,7 @@ Array [
           "updtr-test-module-1",
           "updtr-test-module-2",
         ],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -58,6 +60,7 @@ Array [
           "updtr-test-module-1",
           "updtr-test-module-2",
         ],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -75,6 +78,7 @@ Array [
           "updtr-test-module-1",
           "updtr-test-module-2",
         ],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -120,6 +124,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -135,6 +140,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -150,6 +156,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -164,6 +171,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -196,6 +204,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -211,6 +220,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -226,6 +236,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -240,6 +251,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -283,6 +295,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -298,6 +311,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -313,6 +327,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,
@@ -327,6 +342,7 @@ Array [
       "config": Object {
         "cwd": "/updtr/test/cwd",
         "exclude": Array [],
+        "interactive": undefined,
         "registry": undefined,
         "save": "smart",
         "test": undefined,