@vlandoss/run-run 0.0.6-git-0c9069c.0 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vlandoss/run-run",
-  "version": "0.0.6-git-0c9069c.0",
+  "version": "0.0.6",
   "description": "The CLI toolbox to fullstack common scripts in Variable Land",
   "homepage": "https://github.com/variableland/dx/tree/main/packages/run-run#readme",
   "bugs": {
@@ -33,7 +33,7 @@
     "is-ci": "4.1.0",
     "rimraf": "6.0.1",
     "typescript": "5.8.2",
-    "@vlandoss/clibuddy": "0.0.4-git-0c9069c.0",
+    "@vlandoss/clibuddy": "0.0.4",
     "@vlandoss/loggy": "0.0.3"
   },
   "publishConfig": {

package/src/program/__tests__/__snapshots__/snapshots.test.ts.snap

@@ -10,13 +10,12 @@ Options:
   -h, --help                   display help for command
 
 Commands:
-  format|fmt [options]         format the code 🎨
+  check|test:static [options]  check format and lint issues 🔍
   lint [options]               lint the code 🧹
-  check|test:static [options]  check format and lint issues ✅
+  fmt|format [options]         format the code 🎨
+  tsc|typecheck                check if TypeScript code is well typed 🎨
   clean [options]              delete dirty folders or files such as
                                node_modules, etc 🗑️
-  typecheck|tsc                check if TypeScript code is well typed 🎨
-  info:pkg [options]           display run-run package.json ℹ️
   help [command]               display help for command
 
 Acknowledgment:
@@ -38,13 +37,12 @@ Options:
   -h, --help                   display help for command
 
 Commands:
-  format|fmt [options]         format the code 🎨
+  check|test:static [options]  check format and lint issues 🔍
   lint [options]               lint the code 🧹
-  check|test:static [options]  check format and lint issues ✅
+  fmt|format [options]         format the code 🎨
+  tsc|typecheck                check if TypeScript code is well typed 🎨
   clean [options]              delete dirty folders or files such as
                                node_modules, etc 🗑️
-  typecheck|tsc                check if TypeScript code is well typed 🎨
-  info:pkg [options]           display run-run package.json ℹ️
   help [command]               display help for command
 
 Acknowledgment:
@@ -66,17 +64,17 @@ exports[`should match command: "-v" 1`] = `
 "
 `;
 
-exports[`should match help message for command "format" 1`] = `
-"Usage: rr format|fmt [options]
+exports[`should match help message for command "check" 1`] = `
+"Usage: rr check|test:static [options]
 
-format the code 🎨
+check format and lint issues 🔍
 
 Options:
-  -c, --check  check if the code is formatted (default: true)
-  -f, --fix    format all the code
-  -h, --help   display help for command
+  -f, --fix     try to fix issues automatically
+  --fix-staged  try to fix staged files only
+  -h, --help    display help for command
 
-Under the hood, this command uses the biome CLI to format the code.
+Under the hood, this command uses the biome CLI to check the code.
 "
 `;
 
@@ -94,36 +92,22 @@ Under the hood, this command uses the biome CLI to lint the code.
 "
 `;
 
-exports[`should match help message for command "check" 1`] = `
-"Usage: rr check|test:static [options]
-
-check format and lint issues ✅
-
-Options:
-  -f, --fix     try to fix issues automatically
-  --fix-staged  try to fix staged files only
-  -h, --help    display help for command
-
-Under the hood, this command uses the biome CLI to check the code.
-"
-`;
-
-exports[`should match help message for command "clean" 1`] = `
-"Usage: rr clean [options]
+exports[`should match help message for command "fmt" 1`] = `
+"Usage: rr fmt|format [options]
 
-delete dirty folders or files such as node_modules, etc 🗑️
+format the code 🎨
 
 Options:
-  --only-dist  delete 'dist' folders only
-  --dry-run    outputs the paths that would be deleted
+  -c, --check  check if the code is formatted (default: true)
+  -f, --fix    format all the code
   -h, --help   display help for command
 
-Under the hood, this command uses the rimraf.js to delete dirty folders or files.
+Under the hood, this command uses the biome CLI to format the code.
 "
 `;
 
-exports[`should match help message for command "typecheck" 1`] = `
-"Usage: rr typecheck|tsc [options]
+exports[`should match help message for command "tsc" 1`] = `
+"Usage: rr tsc|typecheck [options]
 
 check if TypeScript code is well typed 🎨
 
@@ -134,15 +118,17 @@ Under the hood, this command uses the TypeScript CLI to check the code.
 "
 `;
 
-exports[`should match help message for command "info:pkg" 1`] = `
-"Usage: rr info:pkg [options]
+exports[`should match help message for command "clean" 1`] = `
+"Usage: rr clean [options]
 
-display run-run package.json ℹ️
+delete dirty folders or files such as node_modules, etc 🗑️
 
 Options:
-  -f, --filter <filter>  lodash get id like to filter info by
-  -c, --current          display package.json where run-run will be executed
-  -h, --help             display help for command
+  --only-dist  delete 'dist' folders only
+  --dry-run    outputs the paths that would be deleted
+  -h, --help   display help for command
+
+Under the hood, this command uses the rimraf.js to delete dirty folders or files.
 "
 `;
 
@@ -156,16 +142,14 @@ Options:
 
 Commands:
   biome
-  tsc
-  rimraf
   help [command]  display help for command
 "
 `;
 
-exports[`should match "format" command 1`] = `"biome format --no-errors-on-unmatched --colors=force"`;
+exports[`should match "check" command 1`] = `"biome check --colors=force"`;
 
 exports[`should match "lint" command 1`] = `"biome check --colors=force --formatter-enabled=false"`;
 
-exports[`should match "check" command 1`] = `"biome check --colors=force"`;
+exports[`should match "fmt" command 1`] = `"biome format --no-errors-on-unmatched --colors=force"`;
 
-exports[`should match "typecheck" command 1`] = `"tsc --noEmit"`;
+exports[`should match "tsc" command 1`] = `"tsc --noEmit"`;

package/src/program/commands/{test-static.ts → check.ts}

@@ -1,15 +1,16 @@
 import { createCommand } from "commander";
 import isCI from "is-ci";
+import { BiomeService } from "~/services/biome";
 import type { Context } from "~/services/ctx";
 
-export function createTestStaticCommand(ctx: Context) {
+export function createCheckCommand(ctx: Context) {
   return createCommand("check")
     .alias("test:static")
-    .description("check format and lint issues ✅")
+    .description("check format and lint issues 🔍")
     .option("-f, --fix", "try to fix issues automatically")
     .option("--fix-staged", "try to fix staged files only")
-    .action(async function testStaticAction(options) {
-      const $ = ctx.shell.$;
+    .action(async function checkAction(options) {
+      const { $ } = new BiomeService(ctx.shell);
       const toolCmd = (cmd = "check") => `biome ${cmd} --colors=force`;
 
       if (options.fix) {

package/src/program/commands/format.ts

@@ -1,14 +1,15 @@
 import { createCommand } from "commander";
+import { BiomeService } from "~/services/biome";
 import type { Context } from "~/services/ctx";
 
 export function createFormatCommand(ctx: Context) {
-  return createCommand("format")
-    .alias("fmt")
+  return createCommand("fmt")
+    .alias("format")
     .description("format the code 🎨")
     .option("-c, --check", "check if the code is formatted", true)
     .option("-f, --fix", "format all the code")
     .action(async function formatAction(options) {
-      const $ = ctx.shell.$;
+      const { $ } = new BiomeService(ctx.shell);
       const toolCmd = "biome format --no-errors-on-unmatched --colors=force";
 
       if (options.fix) {

package/src/program/commands/lint.ts

@@ -1,4 +1,5 @@
 import { createCommand } from "commander";
+import { BiomeService } from "~/services/biome";
 import type { Context } from "~/services/ctx";
 
 export function createLintCommand(ctx: Context) {
@@ -7,7 +8,7 @@ export function createLintCommand(ctx: Context) {
     .option("-c, --check", "check if the code is valid", true)
     .option("-f, --fix", "try to fix all the code")
     .action(async function lintAction(options) {
-      const $ = ctx.shell.$;
+      const { $ } = new BiomeService(ctx.shell);
       const toolCmd = "biome check --colors=force --formatter-enabled=false";
 
       if (options.fix) {

package/src/program/commands/tools.ts

@@ -1,50 +1,23 @@
-import fs from "node:fs";
-import path from "node:path";
-import type { Shell } from "@vlandoss/clibuddy";
 import { createCommand } from "commander";
+import { BiomeService } from "~/services/biome";
 import type { Context } from "~/services/ctx";
-import { logger } from "~/services/logger";
 
-function gracefullBinDir(binPathResolver: () => string) {
-  try {
-    const binPath = binPathResolver();
-    const isDir = fs.statSync(binPath).isDirectory();
-    return isDir ? binPath : path.dirname(binPath);
-  } catch (error) {
-    logger.error("Error getting bin directory:", error);
-    process.exit(1);
-  }
+function createToolCommand(toolBin: string) {
+  // biome-ignore format: I prefer multi-line
+  return createCommand(toolBin)
+    .helpCommand(false)
+    .helpOption(false)
+    .allowExcessArguments(true)
+    .allowUnknownOption(true);
 }
 
 export function createToolsCommand(ctx: Context) {
-  function createToolCommandAction(toolBin: string, binResolver?: () => string) {
-    return async function toolAction(_: unknown, { args }: { args: string[] }) {
-      let $: Shell;
-
-      if (!binResolver) {
-        $ = ctx.shell.$;
-      } else {
-        $ = ctx.shell.child({
-          preferLocal: [gracefullBinDir(binResolver)],
-        }).$;
-      }
-
-      await $`${toolBin} ${args.join(" ")}`;
-    };
-  }
-
-  function createToolCommand(toolBin: string, binResolver?: () => string) {
-    return createCommand(toolBin)
-      .helpCommand(false)
-      .helpOption(false)
-      .allowExcessArguments(true)
-      .allowUnknownOption(true)
-      .action(createToolCommandAction(toolBin, binResolver));
-  }
-
   return createCommand("tools")
     .description("expose the internal tools 🛠️")
-    .addCommand(createToolCommand("biome", () => require.resolve("@biomejs/biome/bin/biome")))
-    .addCommand(createToolCommand("tsc"))
-    .addCommand(createToolCommand("rimraf"));
+    .addCommand(
+      createToolCommand("biome").action((_: unknown, { args }: { args: string[] }) => {
+        const biomeService = new BiomeService(ctx.shell);
+        biomeService.execute(args);
+      }),
+    );
 }

package/src/program/commands/typecheck.ts

@@ -4,8 +4,8 @@ import type { Context } from "~/services/ctx";
 import { logger } from "~/services/logger";
 
 export function createTypecheckCommand(ctx: Context) {
-  return createCommand("typecheck")
-    .alias("tsc")
+  return createCommand("tsc")
+    .alias("typecheck")
     .description("check if TypeScript code is well typed 🎨")
     .action(async function typecheckAction() {
       const { appPkg, shell } = ctx;

package/src/program/index.ts

@@ -1,11 +1,10 @@
 import { getVersion } from "@vlandoss/clibuddy";
 import { Command } from "commander";
 import { createContext } from "~/services/ctx";
+import { createCheckCommand } from "./commands/check";
 import { createCleanCommand } from "./commands/clean";
 import { createFormatCommand } from "./commands/format";
-import { createInfoPkgCommand } from "./commands/info-pkg";
 import { createLintCommand } from "./commands/lint";
-import { createTestStaticCommand } from "./commands/test-static";
 import { createToolsCommand } from "./commands/tools";
 import { createTypecheckCommand } from "./commands/typecheck";
 import { BANNER_TEXT, CREDITS_TEXT } from "./ui";
@@ -22,12 +21,11 @@ export async function createProgram(options: Options) {
     .version(getVersion(ctx.binPkg), "-v, --version")
     .addHelpText("before", BANNER_TEXT)
     .addHelpText("after", CREDITS_TEXT)
-    .addCommand(createFormatCommand(ctx))
+    .addCommand(createCheckCommand(ctx))
     .addCommand(createLintCommand(ctx))
-    .addCommand(createTestStaticCommand(ctx))
-    .addCommand(createCleanCommand())
+    .addCommand(createFormatCommand(ctx))
     .addCommand(createTypecheckCommand(ctx))
-    .addCommand(createInfoPkgCommand(ctx))
+    .addCommand(createCleanCommand())
     .addCommand(createToolsCommand(ctx), {
       hidden: true,
     });

package/src/services/biome.ts

@@ -0,0 +1,25 @@
+import type { ShellService } from "@vlandoss/clibuddy";
+import { gracefullBinDir } from "~/utils/gracefullBinDir";
+import type { ToolService } from "./models";
+
+export class BiomeService implements ToolService {
+  #shellService: ShellService;
+
+  constructor(shellService: ShellService) {
+    this.#shellService = shellService;
+  }
+
+  get $() {
+    return this.#shellService.child({
+      preferLocal: this.#getBinDir(),
+    }).$;
+  }
+
+  async execute(args: string[]): Promise<void> {
+    this.$`biome ${args.join(" ")}`;
+  }
+
+  #getBinDir() {
+    return gracefullBinDir(() => require.resolve("@biomejs/biome/bin/biome"));
+  }
+}

package/src/services/models.ts

@@ -0,0 +1,6 @@
+import type { Shell } from "@vlandoss/clibuddy";
+
+export interface ToolService {
+  $: Shell;
+  execute(args: string[]): Promise<void>;
+}

package/src/utils/gracefullBinDir.ts

@@ -0,0 +1,14 @@
+import fs from "node:fs";
+import path from "node:path";
+import { logger } from "~/services/logger";
+
+export function gracefullBinDir(binPathResolver: () => string) {
+  try {
+    const binPath = binPathResolver();
+    const isDir = fs.statSync(binPath).isDirectory();
+    return isDir ? binPath : path.dirname(binPath);
+  } catch (error) {
+    logger.error("Error getting bin directory:", error);
+    process.exit(1);
+  }
+}

package/src/program/commands/info-pkg.ts

@@ -1,31 +0,0 @@
-import { createCommand } from "commander";
-import type { Context } from "~/services/ctx";
-import { logger } from "~/services/logger";
-import { get } from "~/utils/get";
-
-export function createInfoPkgCommand(ctx: Context) {
-  return createCommand("info:pkg")
-    .description("display run-run package.json ℹ️")
-    .option("-f, --filter <filter>", "lodash get id like to filter info by")
-    .option("-c, --current", "display package.json where run-run will be executed")
-    .action(async function pkgAction(options) {
-      const { appPkg, binPkg } = ctx;
-
-      const infoObject = options.current ? appPkg.info() : binPkg.info();
-
-      if (!options.filter) {
-        logger.info("%O", infoObject);
-        return;
-      }
-
-      const { filter } = options;
-      const subInfoObject = get(infoObject.packageJson, filter);
-
-      if (!subInfoObject) {
-        logger.info("No info found");
-        return;
-      }
-
-      logger.info("%O", { [filter]: subInfoObject });
-    });
-}