Merge pull request #3 from honmanyau/add-quiet-mode

Add a quiet mode

Author: honmanyau

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.1.3
+
+- Add the ability to run `smtpsaurus` under quiet mode, which stops `smtpsaurus`
+  from logging to STDOUT.
+
 ## v0.1.2
 
 - Implement the ability for `smtpsaurus` to optionally find an open port to

README.md

@@ -81,7 +81,11 @@ describe("SmtpServer", () => {
 		// Setting `findPortOnConflict` to `true` may be useful when running
 		// tests in parallel, as it allows `smtpsaurus` to find an open
 		// automatically if the one specified is in use.
-		server = new SmtpServer({ port: 42024, findPortOnConflict: true });
+		server = new SmtpServer({
+			port: 42024,
+			findPortOnConflict: true
+			quiet: true
+		});
 	});
 
 	afterEach(async () => {

deno.json

@@ -1,7 +1,7 @@
 {
 	"lock": true,
 	"name": "@smtpsaurus/smtpsaurus",
-	"version": "0.1.2",
+	"version": "0.1.3",
 	"license": "MIT",
 	"exports": "./src/mod.ts",
 	"publish": {

src/smtpsaurus.ts

@@ -37,6 +37,12 @@ export type ServerConfig = {
 	 * @default DEFAULT_PORT
 	 */
 	port?: number;
+
+	/**
+	 * Whether or prevent `smtpsaurus` from logging info to the console.
+	 * @default false
+	 */
+	quiet?: boolean;
 };
 
 /**
@@ -60,8 +66,12 @@ export type ServerConfig = {
  *     // Setting `findPortOnConflict` to `true` may be useful when running
  *     // tests in parallel, as it allows `smtpsaurus` to find an open
  *     // automatically if the one specified is in use.
- *     server = new SmtpServer({ port: 42024, findPortOnConflict: true });
- *	 });
+ *     server = new SmtpServer({
+ *       port: 42024,
+ *       findPortOnConflict: true,
+ *       quiet: true,
+ *     });
+ * 	 });
  *
  *   afterEach(async () => {
  *     await server.stop();
@@ -98,26 +108,28 @@ export type ServerConfig = {
  *     transporter.close();
  *   });
  * });
-```
- *
+ * ```
  */
 export class SmtpServer {
 	/**
 	 * Domain name associated with the server; for example, smtpsaurus.email.
 	 * This is the name that the server uses to identify itself, such as in
 	 * the initial greeting, to the sender during an SMTP transaction
+	 * @default DEFAULT_DOMAIN;
 	 */
 	domain: string;
 
 	/**
 	 * Hostname where the server is running; for example 127.0.0.1.
+	 * @default DEFAULT_HOSTNAME;
 	 */
 	hostname: string;
 
 	/**
 	 * Port number the server is listening on.
+	 * @default DEFAULT_PORT;
 	 */
-	port: number;
+	port: number = DEFAULT_PORT;
 
 	/**
 	 * Provides access to mailbox operations, such as retrieving emails.
@@ -151,6 +163,24 @@ export class SmtpServer {
 	 */
 	private mainLoopExitSignal: Promise<void>;
 
+	/**
+	 * @private
+	 * Whether or not `smtpsaurus` should log info to the console.
+	 * @default false
+	 */
+	private quiet: boolean = false;
+
+	/**
+	 * @private
+	 * A wrapper around `console.log` that only logs to the console when
+	 * `smtpsaurus` is not running under quiet mode.
+	 */
+	private log = (...data: Parameters<typeof console.log>) => {
+		if (this.quiet) return;
+
+		console.log(...data);
+	};
+
 	/**
 	 * Constructor for the SmtpServer class. Initializes server configuration
 	 * and starts listening for incoming connections.
@@ -161,6 +191,7 @@ export class SmtpServer {
 		this.domain = config?.domain ?? DEFAULT_DOMAIN;
 		this.port = config?.port ?? DEFAULT_PORT;
 		this.hostname = DEFAULT_HOSTNAME;
+		this.quiet = !!config?.quiet;
 
 		if (!config?.findPortOnConflict) {
 			this.listener = Deno.listen({
@@ -192,7 +223,7 @@ export class SmtpServer {
 			);
 		}
 
-		console.log(
+		this.log(
 			`🦕 smtpsaurus listening at ${this.listener.addr.hostname} on port ${this.port}.`,
 		);
 
@@ -212,7 +243,7 @@ export class SmtpServer {
 		const clientHostname = connection.remoteAddr.hostname;
 		const clientPort = connection.remoteAddr.port;
 
-		console.log(`🛜 New connection from ${clientHostname}:${clientPort}.`);
+		this.log(`🛜 New connection from ${clientHostname}:${clientPort}.`);
 
 		// Initial greeting
 		await writeMessage(