scriptpal 1.3.0 → 1.4.0

package/README.md

@@ -8,7 +8,7 @@ A simple npm script palette for lazy people who want a quick way to look through
 
 - keyboard navigation
 - autocompletion
-- fussy finding
+- fuzzy finding
 
 <p align="center">
   <img width="580" src="assets/demo.gif" alt="Demo">
@@ -42,8 +42,26 @@ npx scriptpal
 - `--clipboard`, `-c` Copy command to clipboard
 - `--help` Help me 🙏
 
+### Subcommands
+
+`list` List all scripts found in local `package.json`.
+
+It's possible to also run arbitrary scripts from your `package.json` by passing them as sub-commands, similar to `yarn`.
+
+For example: `scriptpal test` will run `npm run test`.
+
+```bash
+
 ## Examples
 
 - `$ scriptpal --nowelcome`
 - `$ npx scriptpal`
 - `$ scriptpal --last --preset="emoji"`
+- `$ scriptpal list`
+- `$ scriptpal start`
+
+## You might also like...
+
+- [CommitPal](https://github.com/zeropoly/commitpal): A delightful CLI tool for building complex commit messages
+- [Enquirer](https://github.com/enquirer/enquirer): Stylish, intuitive and user-friendly prompts
+```

package/bin/detect-pkg-manager.js

@@ -0,0 +1,25 @@
+const { hasFile } = require("./file-manager");
+
+function getPackageManager() {
+  const packageManagers = [
+    { id: "yarn", file: hasFile("yarn.lock") },
+    { id: "bun", file: hasFile("bun.lockb") },
+    { id: "pnpm", file: hasFile("pnpm-lock.yaml") },
+    { id: "npm", file: hasFile("package-lock.json") },
+  ];
+
+  let largest = packageManagers[0];
+
+  for (let i = 0; i < packageManagers.length; i++) {
+    if (
+      packageManagers[i].file &&
+      packageManagers[i].file.split("/").length > largest
+    ) {
+      largest = i;
+    }
+  }
+
+  return packageManagers[largest] || "npm";
+}
+
+module.exports = { getPackageManager };

package/bin/file-manager.js

@@ -6,9 +6,7 @@ const findConfig = require("find-config");
 
 function getPackageJson(path = "package.json") {
   if (!hasFile(path)) {
-    throw new Error(`${chalk.bgRed(path)} ${chalk.red(
-      "not found"
-    )}\n`);
+    throw new Error(`${chalk.bgRed(path)} ${chalk.red("not found")}\n`);
   }
 
   const configRaw = findConfig.read(path);
@@ -26,5 +24,5 @@ function hasFile(path) {
 
 module.exports = {
   getPackageJson,
-  hasFile
+  hasFile,
 };

package/bin/index.js

@@ -2,59 +2,42 @@
 "use strict";
 
 const { spawnSync } = require("child_process");
-const { AutoComplete, Snippet, Confirm } = require("enquirer");
 const clipboardy = require("clipboardy");
-const meow = require("meow");
 const Conf = require("conf");
 const chalk = require("chalk");
+const { Command, Option, CommanderError } = require("commander");
 
+const { version } = require("../package.json");
 const welcome = require("./welcome");
-const { getPackageJson, hasFile } = require("./file-manager");
-
-const promptShouldRerunPrevious = async previous => {
-  const previousCommand = `${previous.script} ${previous.parameters ||
-    ""}`.trim();
-
-  return await new Confirm({
-    message: `Would you like to rerun the previous command?\n${chalk.greenBright(
-      previousCommand
-    )}`
-  }).run();
-};
-
-const promptGetCommand = async choices => {
-  const script = await new AutoComplete({
-    message: "Which script would you like to run? 🤷‍♂️",
-    limit: 18,
-    choices
-  }).run();
-
-  const {
-    values: { parameters }
-  } = await new Snippet({
-    message: "Would you like to add parameters?",
-    required: false,
-    fields: [
-      {
-        name: "parameters",
-        message: "parameters"
-      }
-    ],
-    template: `${script} \${parameters}`
-  }).run();
-
-  return {
-    script,
-    parameters
-  };
-};
-
-async function main(input, flags) {
+const { getPackageJson } = require("./file-manager");
+const { promptShouldRerunPrevious, promptGetCommand } = require("./prompts");
+const { getPackageManager } = require("./detect-pkg-manager");
+
+let packageJson;
+
+try {
+  packageJson = getPackageJson();
+
+  if (!packageJson.scripts) {
+    throw new Error(chalk.red('No "scripts" found in package.json'));
+  }
+} catch (error) {
+  console.error(error);
+  process.exit(1);
+}
+
+function spawnScript(pkgManager, args) {
+  const spawn = spawnSync(pkgManager, args, { stdio: "inherit" });
+
+  if (spawn.error) {
+    throw new Error(spawn.error);
+  }
+}
+
+async function main(flags) {
   if (!flags.nowelcome) welcome();
 
-  const packageJson = getPackageJson();
   const choices = Object.keys(packageJson.scripts);
-
   const config = new Conf();
   const previous = config.get(`${process.cwd()}.previous`);
 
@@ -73,63 +56,81 @@ async function main(input, flags) {
       ? previous
       : await promptGetCommand(choices);
 
-  const isYarn = hasFile("yarn.lock");
-  const packageManager = isYarn ? "yarn" : "npm";
-  let args = !isYarn ? ["run", script] : [script];
-
+  const pkgManager = getPackageManager();
+  let args = !pkgManager === "npm" ? ["run", script] : [script];
   args = parameters ? [...args, parameters] : args;
 
   if (flags.clipboard) {
-    await clipboardy.write(`${packageManager} ${args.join(" ")}`);
+    await clipboardy.write(`${pkgManager} ${args.join(" ")}`);
     console.log("Copied to clipboard 👉 📋");
-  } else {
-    const spawn = spawnSync(packageManager, args, { stdio: "inherit" });
-
-    if (spawn.error) {
-      console.error(spawn.error);
-      return 1;
-    }
+    return 0;
   }
 
-  config.set(`${process.cwd()}.previous`, {
-    script,
-    parameters
+  spawnScript(pkgManager, args);
+
+  config.set(`${process.cwd()}.previous`, { script, parameters });
+}
+
+async function runLocalScript(script) {
+  const pkgManager = getPackageManager();
+  const args = !pkgManager === "npm" ? ["run", script] : [script];
+
+  spawnScript(pkgManager, args);
+}
+
+async function list() {
+  const packageJson = getPackageJson();
+  Object.entries(packageJson.scripts).forEach(([key, value]) => {
+    console.log(`· ${chalk.greenBright(key)}: ${value}`);
   });
 }
 
-const cli = meow(
-  `
-  Usage
-    $ scriptpal
-
-  Options
-    --nowelcome, -n  Omit welcome message
-    --help  Help me
-    --last, -l  Run previous command
-    --version, -v  Version number
-    --clipboard, -c Copy command to clipboard
-
-  Examples
-    $ scriptpal --nowelcome
-    $ npx scriptpal
-    $ scriptpal --last --preset="emoji"
-`,
-  {
-    flags: {
-      nowelcome: {
-        type: "boolean",
-        alias: "n"
-      },
-      clipboard: {
-        type: "boolean",
-        alias: "c"
-      },
-      last: {
-        type: "boolean",
-        alias: "l"
-      }
-    }
-  }
-);
+const program = new Command();
+
+program
+  .enablePositionalOptions()
+  .name("scriptpal")
+  .version(version, "-v, --version")
+  .option("-l, --last", "Run previous command")
+  .option("-c, --clipboard", "Copy command to clipboard")
+  .option("-n, --nowelcome", "Omit welcome message")
+  .addHelpText(
+    "after",
+    `
+Examples
+  $ scriptpal --last
+  $ scriptpal --clipboard
+  $ scriptpal --last --clipboard
+  $ scriptpal -lcn
+  $ scriptpal --nowelcome
+  $ npx scriptpal
+  $ scriptpal --last --preset="emoji"`
+  )
+  .action(async (options) => await main(options));
+
+program
+  .command("list")
+  .description("List available scripts from package.json")
+  .action(() => list());
+
+// console.log(packageJson.scripts);
+Object.keys(packageJson.scripts)
+  .filter((script) => !["list"].includes(script))
+  .forEach((script) => {
+    program
+      .usage("[global options] <file-paths>...")
+      .command(script)
+      .description(
+        `Runs local script "${script}" detected in local package.json`
+      )
+      .action(() => runLocalScript(script));
+  });
 
-main(cli.input[0], cli.flags);
+(async () => {
+  try {
+    await program.parseAsync(process.argv);
+  } catch (error) {
+    console.error(chalk.red(error));
+    process.exit(1);
+  }
+})();

package/bin/main.js

@@ -0,0 +1,45 @@
+"use strict";
+const clipboardy = require("clipboardy");
+const Conf = require("conf");
+const welcome = require("./welcome");
+const { promptShouldRerunPrevious, promptGetCommand } = require("./prompts");
+const { getPackageManager } = require("./detect-pkg-manager");
+const { packageJson } = require(".");
+
+async function main(flags) {
+  if (!flags.nowelcome) welcome();
+
+  const choices = Object.keys(packageJson.scripts);
+
+  const config = new Conf();
+  const previous = config.get(`${process.cwd()}.previous`);
+
+  let shouldRerunPrevious = false;
+
+  if (!previous && flags.last) {
+    console.log("Previous command not found, continuing...\n");
+  } else if (previous && !flags.last) {
+    shouldRerunPrevious = await promptShouldRerunPrevious(previous);
+  } else {
+    shouldRerunPrevious = true;
+  }
+
+  const { script, parameters } =
+    (previous || flags.last) && shouldRerunPrevious
+      ? previous
+      : await promptGetCommand(choices);
+
+  const pkgManager = getPackageManager();
+  let args = !pkgManager === "npm" ? ["run", script] : [script];
+  args = parameters ? [...args, parameters] : args;
+
+  if (flags.clipboard) {
+    await clipboardy.write(`${pkgManager} ${args.join(" ")}`);
+    console.log("Copied to clipboard 👉 📋");
+    return 0;
+  }
+
+  // spawnScript(pkgManager, args);
+  config.set(`${process.cwd()}.previous`, { script, parameters });
+}
+exports.main = main;

package/bin/prompts.js

@@ -0,0 +1,46 @@
+const chalk = require("chalk");
+const { AutoComplete, Snippet, Confirm } = require("enquirer");
+
+const promptShouldRerunPrevious = async (previous) => {
+  const previousCommand = `${previous.script} ${
+    previous.parameters || ""
+  }`.trim();
+
+  return await new Confirm({
+    message: `Would you like to rerun the previous command?\n${chalk.greenBright(
+      previousCommand
+    )}`,
+  }).run();
+};
+
+const promptGetCommand = async (choices) => {
+  const script = await new AutoComplete({
+    message: "Which script would you like to run? 🤷‍♂️",
+    limit: 18,
+    choices,
+  }).run();
+
+  const {
+    values: { parameters },
+  } = await new Snippet({
+    message: "Would you like to add parameters?",
+    required: false,
+    fields: [
+      {
+        name: "parameters",
+        message: "parameters",
+      },
+    ],
+    template: `${script} \${parameters}`,
+  }).run();
+
+  return {
+    script,
+    parameters,
+  };
+};
+
+module.exports = {
+  promptShouldRerunPrevious,
+  promptGetCommand,
+};

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "scriptpal",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "A simple npm script palette for lazy people (like me)",
   "main": "./bin/index.js",
   "bin": {
-    "scriptpal": "./bin/index.js"
+    "scriptpal": "./bin/index.js",
+    "spal": "./bin/index.js"
   },
   "scripts": {
     "start": "node ./bin/index",
@@ -29,10 +30,10 @@
   "dependencies": {
     "chalk": "^3.0.0",
     "clipboardy": "^2.1.0",
+    "commander": "^8.2.0",
     "conf": "^6.2.1",
     "enquirer": "^2.3.2",
     "find-config": "^1.0.0",
-    "gradient-string": "^1.2.0",
-    "meow": "^6.0.0"
+    "gradient-string": "^1.2.0"
   }
 }