task-script-support-cli 0.2.12 → 0.2.13

package/assets/yargs-template/task-runner/README.md

@@ -3,7 +3,7 @@
 To get started, first run `npm install`, then:
 
 ```
-npm start -- --help
+npm start
 ```
 
 ### Building the project

package/assets/yargs-template/task-runner/src/commands/help-command.ts

@@ -0,0 +1,8 @@
+import { singleton } from "tsyringe";
+import { Command } from "../wrappers/command";
+import ShowHelp from "../tasks/show-help";
+
+@singleton()
+export class HelpCommand extends Command {
+  tasks = [ShowHelp];
+}

package/assets/yargs-template/task-runner/src/index.ts

@@ -12,11 +12,18 @@ initializeInjectables();
 
 import { UtilService } from "./services/util-service";
 import { VerifyCommand } from "./commands/verify";
+import { HelpCommand } from "./commands/help-command";
 
 const name = UtilService.getAppName();
+const yargsInstance = yargs(hideBin(process.argv));
+container.registerInstance("yargs", yargsInstance);
 
-yargs(hideBin(process.argv))
+yargsInstance
   .usage(`${UtilService.titleizeAll(name)} CLI Client`)
+  .command({
+    command: "$0",
+    handler: container.resolve(HelpCommand).handler,
+  })
   .command(
     "verify",
     "check the app is working",

package/assets/yargs-template/task-runner/src/tasks/show-help.ts

@@ -0,0 +1,19 @@
+import { AppTask } from "../wrappers/app-task";
+import { autoInjectable, inject } from "tsyringe";
+import type { Yargs } from "../types/state";
+
+/**
+ * Show the yargs help menu
+ */
+@autoInjectable()
+export default class ShowHelp extends AppTask {
+  loggerName = "ShowHelp";
+
+  constructor(@inject("yargs") private yargs: Yargs) {
+    super();
+  }
+
+  async run() {
+    this.yargs.showHelp();
+  }
+}

package/assets/yargs-template/task-runner/src/types/state.ts

@@ -1,4 +1,5 @@
 import { AppState as State, TaskClass } from "task-script-support";
+import yargs from "yargs";
 
 // Add app data here as needed. Use readonly for immutable fields.
 //
@@ -31,3 +32,5 @@ export const EnvironmentConfigKeys = {
 };
 
 export type AppTaskClass = TaskClass<AppStateData, CLIArgs>;
+
+export type Yargs = typeof yargs;

package/assets/yargs-template/task-runner/tests/tasks/check-env.test.ts

@@ -1,30 +1,77 @@
-import { describe, it, expect, vi } from "vitest";
+import { describe, it, expect, vi, beforeEach } from "vitest";
 import CheckEnv from "../../src/tasks/check-env";
 import { LogService } from "../../src/services/log-service";
 import { CommandService } from "task-script-support";
 import { AppStateData, CLIArgs } from "../../src/types/state";
+import { container } from "tsyringe";
 
 describe("CheckEnv", () => {
-  it("should set environmentValidated to true", async () => {
-    const mockLogService = {
+  let mockLogService = {} as LogService;
+  let mockCommandService = {} as CommandService<AppStateData, CLIArgs>;
+
+  beforeEach(() => {
+    container.reset();
+
+    mockLogService = {
       info: vi.fn(),
       debug: vi.fn(),
+      error: vi.fn(),
     } as unknown as LogService;
-    const mockCommandService = {
+
+    mockCommandService = {
       setData: vi.fn((state, data) => ({
         ...state,
         data: { ...state.data, ...data },
       })),
     } as unknown as CommandService<AppStateData, CLIArgs>;
 
-    const checkEnv = Object.create(CheckEnv.prototype);
-    checkEnv._commandService = mockCommandService;
-    checkEnv._logService = mockLogService;
-    checkEnv.state = { id: "test", args: [], data: {} };
+    container.registerInstance(LogService, mockLogService);
+    container.registerInstance(
+      CommandService<AppStateData, CLIArgs>,
+      mockCommandService,
+    );
+  });
+
+  it("should set environmentValidated to true", async () => {
+    const checkEnv = container.resolve(CheckEnv);
+
     await checkEnv.run();
-    expect(mockLogService.info).toHaveBeenCalledWith(
+    expect(mockLogService.debug).toHaveBeenCalledWith(
       "Running Check Environment",
     );
     expect(checkEnv.state.data.environmentValidated).toBe(true);
   });
+
+  it("should call exit on missing required environment variable", async () => {
+    const testError = new Error("process.exit called");
+    const mockExit = vi.spyOn(process, "exit").mockImplementation(() => {
+      throw testError;
+    });
+    const checkEnv = container.resolve(CheckEnv);
+    checkEnv.requiredEnv = ["MISSING_ENV_VAR"];
+    try {
+      expect(await checkEnv.run()).toThrow(testError);
+    } catch (err) {
+      expect(`${err}`).toContain("process.exit");
+      expect(err).toBe(testError);
+    }
+    expect(mockLogService.error).toHaveBeenCalled();
+    mockExit.mockRestore();
+  });
+
+  it("should group environment issues into single error log", async () => {
+    const testError = new Error("process.exit called");
+    const mockExit = vi.spyOn(process, "exit").mockImplementation(() => {
+      throw testError;
+    });
+    const checkEnv = container.resolve(CheckEnv);
+    checkEnv.requiredEnv = ["MISSING_ENV_1", "MISSING_ENV_2", "MISSING_ENV_3"];
+    try {
+      await checkEnv.run();
+    } catch (err) {
+      expect(err).toBe(testError);
+    }
+    expect(mockLogService.error).toHaveBeenCalledOnce();
+    mockExit.mockRestore();
+  });
 });

package/dist/assets/yargs-template/task-runner/README.md

@@ -3,7 +3,7 @@
 To get started, first run `npm install`, then:
 
 ```
-npm start -- --help
+npm start
 ```
 
 ### Building the project

package/dist/assets/yargs-template/task-runner/src/commands/help-command.ts

@@ -0,0 +1,8 @@
+import { singleton } from "tsyringe";
+import { Command } from "../wrappers/command";
+import ShowHelp from "../tasks/show-help";
+
+@singleton()
+export class HelpCommand extends Command {
+  tasks = [ShowHelp];
+}

package/dist/assets/yargs-template/task-runner/src/index.ts

@@ -12,11 +12,18 @@ initializeInjectables();
 
 import { UtilService } from "./services/util-service";
 import { VerifyCommand } from "./commands/verify";
+import { HelpCommand } from "./commands/help-command";
 
 const name = UtilService.getAppName();
+const yargsInstance = yargs(hideBin(process.argv));
+container.registerInstance("yargs", yargsInstance);
 
-yargs(hideBin(process.argv))
+yargsInstance
   .usage(`${UtilService.titleizeAll(name)} CLI Client`)
+  .command({
+    command: "$0",
+    handler: container.resolve(HelpCommand).handler,
+  })
   .command(
     "verify",
     "check the app is working",

package/dist/assets/yargs-template/task-runner/src/tasks/show-help.ts

@@ -0,0 +1,19 @@
+import { AppTask } from "../wrappers/app-task";
+import { autoInjectable, inject } from "tsyringe";
+import type { Yargs } from "../types/state";
+
+/**
+ * Show the yargs help menu
+ */
+@autoInjectable()
+export default class ShowHelp extends AppTask {
+  loggerName = "ShowHelp";
+
+  constructor(@inject("yargs") private yargs: Yargs) {
+    super();
+  }
+
+  async run() {
+    this.yargs.showHelp();
+  }
+}

package/dist/assets/yargs-template/task-runner/src/types/state.ts

@@ -1,4 +1,5 @@
 import { AppState as State, TaskClass } from "task-script-support";
+import yargs from "yargs";
 
 // Add app data here as needed. Use readonly for immutable fields.
 //
@@ -31,3 +32,5 @@ export const EnvironmentConfigKeys = {
 };
 
 export type AppTaskClass = TaskClass<AppStateData, CLIArgs>;
+
+export type Yargs = typeof yargs;

package/dist/assets/yargs-template/task-runner/tests/tasks/check-env.test.ts

@@ -1,30 +1,77 @@
-import { describe, it, expect, vi } from "vitest";
+import { describe, it, expect, vi, beforeEach } from "vitest";
 import CheckEnv from "../../src/tasks/check-env";
 import { LogService } from "../../src/services/log-service";
 import { CommandService } from "task-script-support";
 import { AppStateData, CLIArgs } from "../../src/types/state";
+import { container } from "tsyringe";
 
 describe("CheckEnv", () => {
-  it("should set environmentValidated to true", async () => {
-    const mockLogService = {
+  let mockLogService = {} as LogService;
+  let mockCommandService = {} as CommandService<AppStateData, CLIArgs>;
+
+  beforeEach(() => {
+    container.reset();
+
+    mockLogService = {
       info: vi.fn(),
       debug: vi.fn(),
+      error: vi.fn(),
     } as unknown as LogService;
-    const mockCommandService = {
+
+    mockCommandService = {
       setData: vi.fn((state, data) => ({
         ...state,
         data: { ...state.data, ...data },
       })),
     } as unknown as CommandService<AppStateData, CLIArgs>;
 
-    const checkEnv = Object.create(CheckEnv.prototype);
-    checkEnv._commandService = mockCommandService;
-    checkEnv._logService = mockLogService;
-    checkEnv.state = { id: "test", args: [], data: {} };
+    container.registerInstance(LogService, mockLogService);
+    container.registerInstance(
+      CommandService<AppStateData, CLIArgs>,
+      mockCommandService,
+    );
+  });
+
+  it("should set environmentValidated to true", async () => {
+    const checkEnv = container.resolve(CheckEnv);
+
     await checkEnv.run();
-    expect(mockLogService.info).toHaveBeenCalledWith(
+    expect(mockLogService.debug).toHaveBeenCalledWith(
       "Running Check Environment",
     );
     expect(checkEnv.state.data.environmentValidated).toBe(true);
   });
+
+  it("should call exit on missing required environment variable", async () => {
+    const testError = new Error("process.exit called");
+    const mockExit = vi.spyOn(process, "exit").mockImplementation(() => {
+      throw testError;
+    });
+    const checkEnv = container.resolve(CheckEnv);
+    checkEnv.requiredEnv = ["MISSING_ENV_VAR"];
+    try {
+      expect(await checkEnv.run()).toThrow(testError);
+    } catch (err) {
+      expect(`${err}`).toContain("process.exit");
+      expect(err).toBe(testError);
+    }
+    expect(mockLogService.error).toHaveBeenCalled();
+    mockExit.mockRestore();
+  });
+
+  it("should group environment issues into single error log", async () => {
+    const testError = new Error("process.exit called");
+    const mockExit = vi.spyOn(process, "exit").mockImplementation(() => {
+      throw testError;
+    });
+    const checkEnv = container.resolve(CheckEnv);
+    checkEnv.requiredEnv = ["MISSING_ENV_1", "MISSING_ENV_2", "MISSING_ENV_3"];
+    try {
+      await checkEnv.run();
+    } catch (err) {
+      expect(err).toBe(testError);
+    }
+    expect(mockLogService.error).toHaveBeenCalledOnce();
+    mockExit.mockRestore();
+  });
 });

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "task-script-support-cli",
-    "version": "0.2.12",
+    "version": "0.2.13",
     "main": "index.js",
     "type": "commonjs",
     "preferGlobal": true,

package/dist/src/tasks/stdout/print-generated-results.js

@@ -19,7 +19,7 @@ const util_service_1 = require("../../services/util-service");
 const file_service_1 = require("../../services/file-service");
 const newProjectMessage = (dest) => `
    Try:
-         cd ${dest} && npm i && npm start -- help
+         cd ${dest} && npm i && npm start
 `;
 /**
  * Prints the generated output results

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "task-script-support-cli",
-  "version": "0.2.12",
+  "version": "0.2.13",
   "main": "index.js",
   "type": "commonjs",
   "preferGlobal": true,

package/src/tasks/stdout/print-generated-results.ts

@@ -6,7 +6,7 @@ import { FileService } from "../../services/file-service";
 
 const newProjectMessage = (dest: string) => `
    Try:
-         cd ${dest} && npm i && npm start -- help
+         cd ${dest} && npm i && npm start
 `;
 
 /**