feat: allow greet to take a string (#11)

Author: JoshuaKGoldberg

README.md

@@ -16,9 +16,7 @@ npm i template-typescript-node-package
 ```ts
 import { greet } from "template-typescript-node-package";
 
-greet({
-  message: "Hello, world!",
-});
+greet("Hello, world!");
 ```
 
 ## Development

src/greet.test.ts

@@ -4,7 +4,25 @@ import { greet } from "./greet.js";
 const message = "Yay, testing!";
 
 describe("greet", () => {
-  it("logs once when times is not provided", () => {
+  it("logs to the console once when message is provided as a string", () => {
+    const logger = vi.spyOn(console, "log").mockImplementation(() => undefined);
+
+    greet(message);
+
+    expect(logger).toHaveBeenCalledWith(message);
+    expect(logger).toHaveBeenCalledTimes(1);
+  });
+
+  it("logs to the console once when message is provided as an object", () => {
+    const logger = vi.spyOn(console, "log").mockImplementation(() => undefined);
+
+    greet({ message });
+
+    expect(logger).toHaveBeenCalledWith(message);
+    expect(logger).toHaveBeenCalledTimes(1);
+  });
+
+  it("logs once when times is not provided in an object", () => {
     const logger = vi.fn();
 
     greet({ logger, message });

src/greet.ts

@@ -1,10 +1,12 @@
 import { GreetOptions } from "./types";
 
-export function greet({
-  logger = console.log.bind(console),
-  message,
-  times = 1,
-}: GreetOptions) {
+export function greet(options: GreetOptions | string) {
+  const {
+    logger = console.log.bind(console),
+    message,
+    times = 1,
+  } = typeof options === "string" ? { message: options } : options;
+
   for (let i = 0; i < times; i += 1) {
     logger(message);
   }