@howells/boundaries 0.1.2 → 0.1.3

package/README.md

@@ -15,8 +15,9 @@ pnpm add -D @howells/boundaries
 Try without installing:
 
 ```sh
-npx @howells/boundaries --help
+npx @howells/boundaries
 npx @howells/boundaries init --dry-run
+npx @howells/boundaries --help
 ```
 
 Initialize boundary config:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@howells/boundaries",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Opinionated Turborepo package boundary conventions.",
   "type": "module",
   "bin": {
@@ -16,7 +16,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/howells/boundaries.git"
+    "url": "git+https://github.com/howells/boundaries.git"
   },
   "bugs": {
     "url": "https://github.com/howells/boundaries/issues"

package/scripts/smoke-install.mjs

@@ -24,7 +24,7 @@ await execFileAsync("npm", ["init", "-y"], { cwd: temp });
 await execFileAsync("npm", ["install", tarball, "--ignore-scripts"], { cwd: temp });
 
 const { stdout } = await execFileAsync("npx", ["boundaries", "--help"], { cwd: temp });
-if (!stdout.includes("Usage: boundaries <command>")) {
+if (!stdout.includes("Usage: boundaries [command]")) {
   throw new Error("Installed boundaries binary did not print expected help.");
 }
 

package/src/cli.js

@@ -15,7 +15,9 @@ import {
 } from "./output.js";
 import { commandSchema } from "./schema.js";
 
-const HELP = `Usage: boundaries <command>
+const HELP = `Usage: boundaries [command]
+
+Default command: check
 
 Commands:
   init                 Add Howells boundary conventions to a Turborepo workspace
@@ -28,13 +30,15 @@ async function main(argv) {
   const [command, ...args] = argv;
   const json = hasFlag(argv, "--json");
   const schema = hasFlag(argv, "--schema");
+  const effectiveCommand = !command || command.startsWith("-") ? "check" : command;
+  const effectiveArgs = !command || command.startsWith("-") ? argv : args;
 
   if (schema) {
     writeJson(process.stdout, success(commandSchema));
     return EXIT_CODES.OK;
   }
 
-  if (!command || command === "help" || command === "--help" || command === "-h") {
+  if (command === "help" || command === "--help" || command === "-h") {
     if (json) {
       writeJson(process.stdout, success(commandSchema));
       return EXIT_CODES.OK;
@@ -43,8 +47,8 @@ async function main(argv) {
     return EXIT_CODES.OK;
   }
 
-  if (command === "init") {
-    const result = await initRepository({ dryRun: hasFlag(args, "--dry-run") });
+  if (effectiveCommand === "init") {
+    const result = await initRepository({ dryRun: hasFlag(effectiveArgs, "--dry-run") });
     if (json) {
       writeJson(process.stdout, success(summarizeInitResult(result)));
     } else {
@@ -55,9 +59,9 @@ async function main(argv) {
     return EXIT_CODES.OK;
   }
 
-  if (command === "check") {
+  if (effectiveCommand === "check") {
     const result = await checkRepository({
-      runTurbo: !args.includes("--no-turbo"),
+      runTurbo: !effectiveArgs.includes("--no-turbo"),
       quiet: json,
     });
     if (json) {
@@ -65,7 +69,7 @@ async function main(argv) {
         writeJson(process.stdout, success({
           ok: true,
           workspaceCount: result.workspaces?.length ?? 0,
-          ranTurbo: !args.includes("--no-turbo"),
+          ranTurbo: !effectiveArgs.includes("--no-turbo"),
           turbo: result.turbo
             ? { exitCode: result.turbo.exitCode, stdout: result.turbo.stdout, stderr: result.turbo.stderr }
             : undefined,
@@ -88,8 +92,8 @@ async function main(argv) {
     return result.exitCode;
   }
 
-  if (command === "explain") {
-    return explain(stripFlags(args, ["--json"]), { json });
+  if (effectiveCommand === "explain") {
+    return explain(stripFlags(effectiveArgs, ["--json"]), { json });
   }
 
   const error = {

package/src/schema.js

@@ -1,6 +1,7 @@
 export const commandSchema = {
   name: "boundaries",
   description: "Opinionated Turborepo package boundary conventions.",
+  defaultCommand: "check",
   commands: [
     {
       name: "init",