feat: add warn type to global context.logger (#3423)

* add `warn` type to logger in `getLogger`

* test: update test case `'Expose "error", "success" and "log" functions'`

* type: add `warn` to `logger` type interface

* doc: add available logger function to docs

* type: update type interface doc for `logger`

Author: babblebey

docs/developer-guide/plugin.md

@@ -241,7 +241,7 @@ if (env.GITHUB_TOKEN) {
 
 ## Logger
 
-Use `context.logger` to provide debug logging in the plugin.
+Use `context.logger` to provide debug logging in the plugin. Available logging functions: `log`, `warn`, `success`, `error`.
 
 ```js
 const { logger } = context;

index.d.ts

@@ -38,9 +38,9 @@ declare module "semantic-release" {
     /**
      * Signale console loger instance.
      *
-     * Has error, log and success methods.
+     * Has error, log, warn and success methods.
      */
-    logger: Signale<"error" | "log" | "success">;
+    logger: Signale<"error" | "log" | "success" | "warn">;
   }
 
   /**

lib/get-logger.js

@@ -14,5 +14,6 @@ export default ({ stdout, stderr }) =>
       error: { badge: figures.cross, color: "red", label: "", stream: [stderr] },
       log: { badge: figures.info, color: "magenta", label: "", stream: [stdout] },
       success: { badge: figures.tick, color: "green", label: "", stream: [stdout] },
+      warn: { badge: figures.warning, color: "yellow", label: "", stream: [stderr] },
     },
   });

test/get-logger.test.js

@@ -2,16 +2,18 @@ import test from "ava";
 import { spy } from "sinon";
 import getLogger from "../lib/get-logger.js";
 
-test('Expose "error", "success" and "log" functions', (t) => {
+test('Expose "error", "success", warn and "log" functions', (t) => {
   const stdout = spy();
   const stderr = spy();
   const logger = getLogger({ stdout: { write: stdout }, stderr: { write: stderr } });
 
   logger.log("test log");
   logger.success("test success");
   logger.error("test error");
+  logger.warn("test warn");
 
   t.regex(stdout.args[0][0], /.*test log/);
   t.regex(stdout.args[1][0], /.*test success/);
   t.regex(stderr.args[0][0], /.*test error/);
+  t.regex(stderr.args[1][0], /.*test warn/);
 });