github-update-submodule 1.2.0 → 1.2.2

package/bin/github-update-submodule.js

@@ -25,6 +25,8 @@
  *   --no-color           Disable colored output
  *   --no-progress        Disable the progress bar
  *   --make-config        Generate a submodule.config.json in the current repo and exit
+ *   --version  / -v     Print version and exit
+ *   --help     / -h     Print this help and exit
  */
 
 const { spawnSync, spawn } = require("child_process");
@@ -73,6 +75,8 @@ const options = {
   verbose:       false,
   color:         true,
   progress:      true,
+  showVersion:   false,
+  showHelp:      false,
 };
 
 // Collect positional repo path first so config is loaded from correct dir
@@ -108,6 +112,8 @@ for (let i = 0; i < cliArgs.length; i++) {
   else if (a === "--message")      options.commitMessage = cliArgs[++i];
   else if (a === "--depth")        options.maxDepth      = parseInt(cliArgs[++i], 10);
   else if (a === "--ignore")       options.ignore.push(cliArgs[++i]);
+  else if (a === "--version" || a === "-v") options.showVersion = true;
+  else if (a === "--help"    || a === "-h") options.showHelp    = true;
 }
 
 // ─── Colour helpers ──────────────────────────────────────────────────────────
@@ -604,9 +610,83 @@ async function runMakeConfig() {
   process.exit(0);
 }
 
+// ─── Version & help ──────────────────────────────────────────────────────────
+
+const VERSION = "2.0.0";
+
+function printVersion() {
+  console.log(`github-update-submodule ${VERSION}`);
+  process.exit(0);
+}
+
+function printHelp() {
+  const b  = C.bold;
+  const r  = C.reset;
+  const cy = C.cyan;
+  const ye = C.yellow;
+  const di = C.dim;
+  const gr = C.green;
+
+  console.log();
+  console.log(`${b}${C.blue}╔══════════════════════════════════════════╗${r}`);
+  console.log(`${b}${C.blue}║   github-update-submodule  v${VERSION}        ║${r}`);
+  console.log(`${b}${C.blue}╚══════════════════════════════════════════╝${r}`);
+  console.log();
+  console.log(`${b}USAGE${r}`);
+  console.log(`  github-update-submodule ${cy}[repo-path]${r} ${ye}[options]${r}`);
+  console.log();
+  console.log(`${b}DESCRIPTION${r}`);
+  console.log(`  Recursively pulls every Git submodule to the latest remote commit,`);
+  console.log(`  then commits and pushes the updated refs up every parent repo so`);
+  console.log(`  GitHub always points to the latest commit at every nesting level.`);
+  console.log();
+  console.log(`${b}OPTIONS${r}`);
+  const flags = [
+    ["--no-push",              "",       "Pull locally only — skip commit and push"],
+    ["--interactive",          "",       "Prompt yes/no before pushing each parent repo"],
+    ["--ignore",               "<name>", "Skip a submodule by name (repeatable)"],
+    ["--parallel",             "",       "Fetch all submodules concurrently (faster)"],
+    ["--dry-run",              "",       "Preview changes without modifying anything"],
+    ["--message",              "<msg>",  `Commit message ${di}(default: "chore: update submodule refs")${r}`],
+    ["--branch",               "<b>",   `Default branch if not in .gitmodules ${di}(default: main)${r}`],
+    ["--depth",                "<n>",   "Limit recursion depth"],
+    ["--verbose",              "",       "Show full git output"],
+    ["--no-color",             "",       "Disable colored output"],
+    ["--no-progress",          "",       "Disable the progress bar"],
+    ["--make-config",          "",       "Generate submodule.config.json with all defaults"],
+    ["--version, -v",          "",       "Print version and exit"],
+    ["--help,    -h",          "",       "Print this help and exit"],
+  ];
+  for (const [flag, arg, desc] of flags) {
+    const left = `  ${cy}${flag}${r}${arg ? " " + ye + arg + r : ""}`;
+    const pad  = " ".repeat(Math.max(1, 36 - flag.length - arg.length));
+    console.log(`${left}${pad}${desc}`);
+  }
+  console.log();
+  console.log(`${b}EXAMPLES${r}`);
+  console.log(`  ${gr}github-update-submodule${r}                          ${di}# pull + commit + push everything${r}`);
+  console.log(`  ${gr}github-update-submodule${r} ${ye}--dry-run${r}                 ${di}# preview only${r}`);
+  console.log(`  ${gr}github-update-submodule${r} ${ye}--parallel${r}               ${di}# concurrent fetch${r}`);
+  console.log(`  ${gr}github-update-submodule${r} ${ye}--interactive${r}            ${di}# confirm before each push${r}`);
+  console.log(`  ${gr}github-update-submodule${r} ${ye}--ignore frontend${r}        ${di}# skip a submodule${r}`);
+  console.log(`  ${gr}github-update-submodule${r} ${ye}--no-push${r}                ${di}# local update only${r}`);
+  console.log(`  ${gr}github-update-submodule${r} ${ye}--make-config${r}            ${di}# create config file${r}`);
+  console.log(`  ${gr}github-update-submodule${r} ${ye}--version${r}                ${di}# print version${r}`);
+  console.log();
+  console.log(`${b}CONFIG FILE${r}`);
+  console.log(`  Run ${cy}--make-config${r} to generate ${cy}submodule.config.json${r} in your repo root.`);
+  console.log(`  CLI flags always override config file values.`);
+  console.log();
+  process.exit(0);
+}
+
 // ─── Entry point ─────────────────────────────────────────────────────────────
 
 async function main() {
+  // early-exit flags
+  if (options.showVersion) { printVersion(); return; }
+  if (options.showHelp)    { printHelp();    return; }
+
   // --make-config: generate a config file and exit immediately
   if (options.makeConfig) {
     await runMakeConfig();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-update-submodule",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Recursively pull all Git submodules to their latest remote commit and push updated refs up every parent repo — so GitHub always points to the latest.",
   "main": "bin/github-update-submodule.js",
   "bin": {