enhancement/issue 1518 split side effect from CLI entry point to dedicated bin file (#1520)

Author: thescientist13

greenwood.config.test-types.ts

@@ -1,4 +1,4 @@
-import type { Config, ExternalSourcePage } from "@greenwood/cli";
+import { type Config, type ExternalSourcePage, run } from "@greenwood/cli";
 import { greenwoodPluginAdapterAws } from "@greenwood/plugin-adapter-aws";
 import { greenwoodPluginAdapterVercel } from "@greenwood/plugin-adapter-vercel";
 import { greenwoodPluginAdapterNetlify } from "@greenwood/plugin-adapter-netlify";
@@ -18,7 +18,8 @@ import { greenwoodPluginRendererPuppeteer } from "@greenwood/plugin-renderer-pup
 import { getContentByRoute } from "@greenwood/cli/src/data/client.js";
 
 const foo = await getContentByRoute("foo");
-console.log(foo);
+
+console.log({ run, foo });
 
 import ChildrenQuery from "@greenwood/plugin-graphql/src/queries/children.gql";
 import CollectionQuery from "@greenwood/plugin-graphql/src/queries/collection.gql";

package.json

@@ -5,7 +5,6 @@
   "repository": "https://github.com/ProjectEvergreen/greenwood",
   "author": "Owen Buckley <[email protected]>",
   "license": "MIT",
-  "main": "./packages/cli/src/index.js",
   "type": "module",
   "workspaces": {
     "packages": [
@@ -17,9 +16,9 @@
     "lerna": "lerna",
     "clean": "rimraf --glob ./packages/**/.greenwood/** ./packages/**/public/** ./coverage",
     "clean:deps": "rimraf **/node_modules/**",
-    "build": "cross-env __GWD_ROLLUP_MODE__=strict node . build",
-    "serve": "node . serve",
-    "develop": "node . develop",
+    "build": "cross-env __GWD_ROLLUP_MODE__=strict greenwood build",
+    "serve": "greenwood serve",
+    "develop": "greenwood develop",
     "test": "cross-env BROWSERSLIST_IGNORE_OLD_DATA=true __GWD_ROLLUP_MODE__=strict NODE_NO_WARNINGS=1 c8 mocha --exclude \"./packages/**/test/cases/loaders-*/**\" --exclude \"./packages/**/test/cases/*.typescript*/**\" \"./packages/**/**/*.spec.js\"",
     "test:loaders": "cross-env BROWSERSLIST_IGNORE_OLD_DATA=true __GWD_ROLLUP_MODE__=strict NODE_NO_WARNINGS=1 node --import $(pwd)/test/test-register.js ./node_modules/mocha/bin/mocha --exclude \"./packages/**/test/cases/*.typescript*/**\" \"./packages/**/**/*.spec.js\"",
     "test:loaders:win": "cross-env BROWSERSLIST_IGNORE_OLD_DATA=true __GWD_ROLLUP_MODE__=strict NODE_NO_WARNINGS=1 node --import file:\\\\%cd%\\test\\test-register.js ./node_modules/mocha/bin/mocha --exclude \"./packages/init/test/cases/**\" --exclude \"./packages/**/test/cases/*.typescript*/**\" \"./packages/**/**/*.spec.js\"",

packages/cli/package.json

@@ -38,7 +38,7 @@
     "./src/*": "./src/*"
   },
   "bin": {
-    "greenwood": "./src/index.js"
+    "greenwood": "./src/bin.js"
   },
   "files": [
     "src/"

packages/cli/src/bin.js

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+
+import program from "commander";
+import { run } from "./index.js";
+
+const greenwoodPackageJson = (
+  await import(new URL("../package.json", import.meta.url), { with: { type: "json" } })
+).default;
+
+let command = "";
+
+console.info("-------------------------------------------------------");
+console.info(`Welcome to Greenwood (v${greenwoodPackageJson.version}) ♻️`);
+console.info("-------------------------------------------------------");
+
+program
+  .version(greenwoodPackageJson.version)
+  .arguments("<script-mode>")
+  .usage("<script-mode> [options]");
+
+program
+  .command("build")
+  .description("Build a static site for production.")
+  .action((cmd) => {
+    command = cmd._name;
+  });
+
+program
+  .command("develop")
+  .description("Start a local development server.")
+  .action((cmd) => {
+    command = cmd._name;
+  });
+
+program
+  .command("serve")
+  .description("View a production build locally with a basic web server.")
+  .action((cmd) => {
+    command = cmd._name;
+  });
+
+program
+  .command("eject")
+  .option("-a, --all", "eject all configurations including babel, postcss, browserslistrc")
+  .description("Eject greenwood configurations.")
+  .action((cmd) => {
+    command = cmd._name;
+  });
+
+program.parse(process.argv);
+
+if (program.parse.length === 0) {
+  program.help();
+}
+
+run(command);

packages/cli/src/index.js

@@ -1,61 +1,6 @@
-#!/usr/bin/env node
-
 import { generateCompilation } from "./lifecycles/compile.js";
-import fs from "node:fs/promises";
-import program from "commander";
-
-const greenwoodPackageJson = JSON.parse(
-  await fs.readFile(new URL("../package.json", import.meta.url), "utf-8"),
-);
-let cmdOption = {};
-let command = "";
-
-console.info("-------------------------------------------------------");
-console.info(`Welcome to Greenwood (v${greenwoodPackageJson.version}) ♻️`);
-console.info("-------------------------------------------------------");
-
-program
-  .version(greenwoodPackageJson.version)
-  .arguments("<script-mode>")
-  .usage("<script-mode> [options]");
-
-program
-  .command("build")
-  .description("Build a static site for production.")
-  .action((cmd) => {
-    command = cmd._name;
-  });
-
-program
-  .command("develop")
-  .description("Start a local development server.")
-  .action((cmd) => {
-    command = cmd._name;
-  });
 
-program
-  .command("serve")
-  .description("View a production build locally with a basic web server.")
-  .action((cmd) => {
-    command = cmd._name;
-  });
-
-program
-  .command("eject")
-  .option("-a, --all", "eject all configurations including babel, postcss, browserslistrc")
-  .description("Eject greenwood configurations.")
-  .action((cmd) => {
-    command = cmd._name;
-    cmdOption.all = cmd.all;
-  });
-
-program.parse(process.argv);
-
-if (program.parse.length === 0) {
-  program.help();
-}
-
-const run = async () => {
+async function run(command) {
   process.env.__GWD_COMMAND__ = command;
 
   try {
@@ -92,6 +37,6 @@ const run = async () => {
     console.error(err);
     process.exit(1);
   }
-};
+}
 
-run();
+export { run };

packages/cli/src/types/index.d.ts

@@ -57,3 +57,9 @@ export type {
   GetLayout,
   GetFrontmatter,
 };
+
+export type CLI_COMMAND = "develop" | "build" | "serve";
+
+declare module "@greenwood/cli" {
+  export const run: (CLI_COMMAND) => Promise<void>;
+}

packages/cli/test/cases/build.config.active-frontmatter/build.config.active-frontmatter.spec.js

@@ -34,7 +34,7 @@ const expect = chai.expect;
 
 describe("Build Greenwood With: ", function () {
   const LABEL = "Active Frontmatter";
-  const cliPath = path.join(process.cwd(), "packages/cli/src/index.js");
+  const cliPath = path.join(process.cwd(), "packages/cli/src/bin.js");
   const outputPath = fileURLToPath(new URL(".", import.meta.url));
   let runner;
 

packages/cli/test/cases/build.config.default/build.config.default.spec.js

@@ -22,7 +22,7 @@ import { fileURLToPath } from "node:url";
 
 describe("Build Greenwood With: ", function () {
   const LABEL = "Empty Configuration and Default Workspace";
-  const cliPath = path.join(process.cwd(), "packages/cli/src/index.js");
+  const cliPath = path.join(process.cwd(), "packages/cli/src/bin.js");
   const outputPath = fileURLToPath(new URL(".", import.meta.url));
   let runner;
 

packages/cli/test/cases/build.config.error-dev-server-extensions/build.config.error-dev-server-extensions.spec.js

@@ -26,7 +26,7 @@ import { fileURLToPath } from "node:url";
 const expect = chai.expect;
 
 describe("Build Greenwood With: ", function () {
-  const cliPath = path.join(process.cwd(), "packages/cli/src/index.js");
+  const cliPath = path.join(process.cwd(), "packages/cli/src/bin.js");
   const outputPath = fileURLToPath(new URL(".", import.meta.url));
   let runner;
 

packages/cli/test/cases/build.config.error-dev-server-hud/build.config.error-dev-server-hud.spec.js

@@ -26,7 +26,7 @@ import { fileURLToPath } from "node:url";
 const expect = chai.expect;
 
 describe("Build Greenwood With: ", function () {
-  const cliPath = path.join(process.cwd(), "packages/cli/src/index.js");
+  const cliPath = path.join(process.cwd(), "packages/cli/src/bin.js");
   const outputPath = fileURLToPath(new URL(".", import.meta.url));
   let runner;