feat: add --log-level flag

Author: luwes

.github/workflows/cd.yml

@@ -56,7 +56,7 @@ jobs:
       - run: npm ci
       - run: npm test
       - run: npm link # consumers should use npm link wet-run or below npx wet-run ...
-      - run: wet release ${{ inputs.version }} ${{ inputs.dryrun && '--dry-run' || '' }} ${{ inputs.prerelease && format('--prerelease {0}', inputs.prerelease) || '' }} --provenance --changelog --github-release --verbose
+      - run: wet release ${{ inputs.version }} ${{ inputs.dryrun && '--dry-run' || '' }} ${{ inputs.prerelease && format('--prerelease {0}', inputs.prerelease) || '' }} --provenance --changelog --github-release --log-level verbose
       - name: Get NPM version
         id: npm-version
         uses: martinbeentjes/npm-get-version-action@v1.3.1

README.md

@@ -23,7 +23,7 @@ wet serve
 
 - Positional: `<path>`  
 - Flags: `--port`, `--cors`, `--redirect`, `--livereload`, `--ssl-cert`,
-`--ssl-key`, `--ssl-pass`
+`--ssl-key`, `--ssl-pass`, `--log-level`
 
 ## Test Run
 
@@ -35,7 +35,7 @@ wet test
 
 - Positional: `<path>`  
 - Flags: `--port`, `--cors`, `--redirect`, `--servedir`, `--browser`, 
-`--channel`, `--no-headless`, `--timeout`, `--coverage`
+`--channel`, `--no-headless`, `--timeout`, `--coverage`, `--log-level`
 
 ## Release
 
@@ -46,7 +46,8 @@ wet release patch --changelog --github-release
 ```
 
 - Positional: `[<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git | from-package]`   
-- Flags: `--prerelease`, `--preid`, `--tag`, `--access`, `--provenance`, `--changelog`, `--github-release`, `--dry-run`, `--verbose`  
+- Flags: `--prerelease`, `--preid`, `--tag`, `--access`, `--provenance`, `--changelog`, `--github-release`, `--dry-run`, `--log-level`  
+
 
 ### Continuous deployment (CD)
 

src/client/livereload.js

@@ -9,6 +9,11 @@ websocket.onmessage = (event) => {
   let { data } = event;
   let { command } = JSON.parse(data);
 
+  if (command === 'hello') {
+    websocket.send(JSON.stringify({ command: 'hello' }));
+    return;
+  }
+
   if (command === 'reload') {
     globalThis.location.reload();
   }

src/release.js

@@ -34,8 +34,9 @@ export function cliRelease() {
     'dry-run': {
       type: 'boolean',
     },
-    verbose: {
-      type: 'boolean',
+    'log-level': {
+      type: 'string',
+      default: 'info',
     },
   };
 
@@ -54,7 +55,7 @@ export function cliRelease() {
 export async function release(bump = 'conventional', opts) {
   let { prerelease, preid, access, tag, provenance } = opts;
 
-  console.log(`Creating a ${bump}${prerelease ? ` ${prerelease}` : ''} release!`);
+  log(`Creating a ${bump}${prerelease ? ` ${prerelease}` : ''} release!`, opts);
 
   const dryRun = opts['dry-run'] ? '--dry-run' : '';
 
@@ -84,14 +85,14 @@ export async function release(bump = 'conventional', opts) {
 
     if (version !== pkg.version) {
       await wetCmd(`npm --no-git-tag-version version ${version}`, opts);
-      console.log(`${version}`);
+      log(`${version}`, opts);
     }
     else {
-      console.log(`${version} (no change)`);
+      log(`${version} (no change)`, opts);
     }
   }
   else {
-    console.log(`${version} (from package)`);
+    log(`${version} (from package)`, opts);
   }
 
   // Canaries don't have Git commits, Github releases or changelogs by default.
@@ -111,8 +112,10 @@ export async function release(bump = 'conventional', opts) {
       try {
         await wetCmd(`npx --yes conventional-github-releaser@3.1.5 -p angular`, opts);
       } catch (err) {
-        console.log('Failed to create a Github release');
-        console.error(err);
+        if (opts['log-level'] !== 'silent') {
+          log('Failed to create a Github release', opts);
+          console.error(err);
+        }
       }
     }
   }
@@ -179,7 +182,7 @@ async function commitChangelog(version, dryRun, opts) {
   await wetCmd(changelogCmd, opts);
 
   if (await wetCmd(`git status --porcelain CHANGELOG.md`, opts) === '') {
-    console.log('No changes to CHANGELOG.md');
+    log('No changes to CHANGELOG.md', opts);
     return;
   }
 
@@ -192,7 +195,13 @@ function wetCmd(command, opts) {
   if (!opts['dry-run']) {
     return cmd(command, opts);
   }
-  console.log(command);
+  log(command, opts);
+}
+
+function log(msg, opts = {}) {
+  if (['info', 'verbose'].includes(opts['log-level'])) {
+    console.log(msg);
+  }
 }
 
 async function getpkg(key) {

src/server.js

@@ -18,7 +18,8 @@ import { getMimeType } from 'hono/utils/mime';
 import { serve as honoServe } from '@hono/node-server';
 import { serveStatic } from '@hono/node-server/serve-static';
 
-import { isCli, getFreePort, resolvePair, sizeToString, lastModifiedToString } from './utils.js';
+import { isCli, getFreePort, resolvePair, sizeToString,
+  lastModifiedToString, getNetworkAddress } from './utils.js';
 
 if (await isCli(import.meta.url)) cliServe();
 
@@ -50,6 +51,10 @@ export function cliServe() {
     'ssl-pass': {
       type: 'string',
     },
+    'log-level': {
+      type: 'string',
+      default: 'info',
+    },
   };
 
   const {
@@ -104,7 +109,10 @@ export async function serve(root = '.', opts = {}) {
 
   const app = new Hono();
   app.use('*', etag());
-  app.use('*', logger());
+
+  if (['info', 'verbose'].includes(opts['log-level'])) {
+    app.use('*', logger());
+  }
 
   if (cors) app.use('*', honoCors());
 
@@ -175,12 +183,17 @@ export async function serve(root = '.', opts = {}) {
   });
 
   if (livereload) {
-    createLivereload(root, livereloadExts, { port, server });
+    createLivereload(root, livereloadExts, { port, server, opts });
   }
 
   const protocol = useSsl ? 'https' : 'http';
   const url = `${protocol}://localhost:${port}`;
-  console.log(`Server running at ${url}\n`);
+  const publicUrl = `${protocol}://${getNetworkAddress()}:${port}`;
+
+  if (opts['log-level'] !== 'silent') {
+    console.log(`  Local:    ${url}`);
+    console.log(`  Network:  ${publicUrl}\n`);
+  }
 
   return {
     server,
@@ -189,19 +202,24 @@ export async function serve(root = '.', opts = {}) {
   };
 }
 
-function createLivereload(root, exts, { server }) {
+function createLivereload(root, exts, { server, opts }) {
 
   const wss = new WebSocketServer({
     server,
   });
 
   wss.on('connection', (ws) => {
-    ws.on('error', console.error);
+
+    if (opts['log-level'] !== 'silent') {
+      ws.on('error', console.error);
+    }
 
     ws.on('message', (data) => {
       const message = JSON.parse(data);
       if (message.command === 'hello') {
-        console.log('Livereload client connected');
+        if (['verbose'].includes(opts['log-level'])) {
+          console.log('Livereload client connected');
+        }
       }
     });
 
@@ -227,7 +245,10 @@ function createLivereload(root, exts, { server }) {
       if (filename) {
         const ext = path.extname(filename).slice(1);
         if (exts.includes(ext)) {
-          console.log(`  <-- WS  /${filename}`);
+
+          if (['info', 'verbose'].includes(opts['log-level'])) {
+            console.log(`  <-- WS  /${filename}`);
+          }
 
           for (const client of wss.clients) {
             if (client.readyState === WebSocket.OPEN) {
@@ -243,11 +264,15 @@ function createLivereload(root, exts, { server }) {
       }
     });
 
-    fileWatcher.on('error', console.error);
+    if (opts['log-level'] !== 'silent') {
+      fileWatcher.on('error', console.error);
+    }
     fileWatcher.unref();
   }
   catch (err) {
-    console.error(err);
+    if (opts['log-level'] !== 'silent') {
+      console.error(err);
+    }
   }
 }
 

src/test.js

@@ -41,8 +41,9 @@ export function cliTest() {
     timeout: {
       type: 'string',
     },
-    verbose: {
-      type: 'boolean',
+    'log-level': {
+      type: 'string',
+      default: 'info',
     },
   };
 

src/utils.js

@@ -2,6 +2,7 @@ import { argv } from 'node:process';
 import { realpath } from 'node:fs/promises'
 import { fileURLToPath } from 'node:url';
 import net from 'node:net';
+import { networkInterfaces } from 'node:os';
 import child_process from 'node:child_process';
 import { promisify } from 'node:util';
 
@@ -13,6 +14,18 @@ export async function isCli(metaUrl) {
   return nodePath === modulePath;
 }
 
+export function getNetworkAddress() {
+  const interfaces = networkInterfaces();
+  for (const name of Object.keys(interfaces)) {
+    for (const ifc of interfaces[name]) {
+      const { address, family, internal } = ifc;
+      if (family === 'IPv4' && !internal) {
+        return address;
+      }
+    }
+  }
+}
+
 export async function getFreePort(base = 8000) {
   for (let port = base; port < base + 10; port++) {
     if (await isPortAvailable(port)) return port;
@@ -41,12 +54,16 @@ export function isPortAvailable(port) {
 export async function cmd(command, opts) {
   command = command.trim().replace(/\s+/g, ' ');
 
-  if (opts.verbose) console.log(`${command}`);
+  if (opts['log-level'] === 'verbose') {
+    console.log(`${command}`);
+  }
 
   const { stdout, stderr } = await exec(command);
 
   if (stderr) {
-    console.error(`\n${stderr}`);
+    if (opts['log-level'] !== 'silent') {
+      console.error(`\n${stderr}`);
+    }
   }
 
   return stdout.trim();