@merkur/cli 0.44.0-rc.1 → 0.44.0-rc.2

package/README.md

@@ -40,6 +40,36 @@ Contribute to this project via [Pull-Requests](https://github.com/mjancarik/merk
 
 We are following [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/#summary). To simplify the commit process, you can use `npm run commit` command. It opens an interactive interface, which should help you with commit message composition.
 
+### Release
+
+To release a version you must have the right permissions, please contact one of the repo maintainers.
+
+
+#### Regular version release
+
+To do a regular release, in the root of the monorepo run:
+
+```
+npm run release
+```
+
+#### RC (preversion) release
+
+1. From the specific package directory, use this `lerna version` command to bump package versions:
+  ```
+  npx lerna version <preminor | prepatch | prerelease> --no-git-tag-version --no-push
+  // prerelease increments the pre* version's last number, e.g. v0.44.0-rc.0 => v0.44.0-rc.1
+  ```
+2. restore all files not related to the package you intend to release (the whole lerna repo, `@merkur/create-widget`, other dependent packages).
+3. Commit the changes. 
+4. Tag the commit with the version (e.g. `v0.44.0-rc.0`). 
+5. Push the commit to the repo.
+6. Push the tag to the repo: `git push origin tag <tagname>` (e.g. `git push origin tag v0.44.0-rc.0`).
+
+The packages are released from a GitHub Action that is triggered when a new version tag is pushed to the repository.
+
+---
+
 Thank you to all the people who already contributed to Merkur!
 
 <a href="https://github.com/mjancarik/merkur/graphs/contributors">

package/bin/merkur.mjs

@@ -110,6 +110,7 @@ program
   .description('Build a static version of the widget playground')
   .action(async (options, cmd) => {
   const args = {
+    ...{ writeToDisk: true, watch: false, hasRunWidgetServer: true, hasRunDevServer: true },
     ...cmd.optsWithGlobals(),
     ...options,
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@merkur/cli",
-  "version": "0.44.0-rc.1",
+  "version": "0.44.0-rc.2",
   "description": "Merkur is tiny and extensible library for creating front-end microservices.",
   "bin": {
     "merkur": "./bin/merkur.mjs"
@@ -65,5 +65,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "f7b9abe321ef98119eed488aced59ce60d55573b"
+  "gitHead": "f17c30471460f9d6281604580b915030f5a9e916"
 }

package/src/CLIConfig.mjs

@@ -24,7 +24,7 @@ export async function createCLIConfig({ args, command } = {}) {
     sourcemap: args?.sourcemap ?? !isProduction,
     staticFolder: args?.staticFolder ?? './build/static',
     staticPath: args?.staticPath ?? '/static',
-    staticPlayground: args?.staticPlayground ?? './playground-build',
+    staticPlayground: args?.staticPlayground ?? './build-playground',
     verbose: args.verbose ?? false,
     watch: args?.watch ?? !isProduction,
     writeToDisk: args?.writeToDisk ?? isProduction,

package/src/clearBuildFolder.mjs

@@ -1,10 +1,14 @@
 import { rm } from 'node:fs/promises';
 
-export async function clearBuildFolder({ merkurConfig }) {
+export async function clearFolder(folderPath) {
   try {
-    await rm(merkurConfig.widgetServer.buildFolder, {
+    await rm(folderPath, {
       recursive: true,
       force: true,
     });
   } catch {} //eslint-disable-line no-empty
 }
+
+export async function clearBuildFolder({ merkurConfig }) {
+  await clearFolder(merkurConfig.widgetServer.buildFolder);
+}

package/src/commands/buildPlayground.mjs

@@ -3,8 +3,8 @@ import { runDevServer } from '../devServer.mjs';
 import { runTask } from '../runTask.mjs';
 import { runSocketServer } from '../websocket.mjs';
 import { runWidgetServer } from '../widgetServer.mjs';
-import { handleExit } from '../handleExit.mjs';
-import { clearBuildFolder } from '../clearBuildFolder.mjs';
+import { handleExit, killProcesses } from '../handleExit.mjs';
+import { clearFolder, clearBuildFolder } from '../clearBuildFolder.mjs';
 import { time } from '../utils.mjs';
 import path from 'node:path';
 import chalk from 'chalk';
@@ -12,13 +12,6 @@ import fs from 'node:fs/promises';
 import process from 'node:process';
 import { createLogger } from '../logger.mjs';
 
-// this vs handleExit? it overlaps, it's not the same thing, wtf
-function killServers(context) {
-  context?.process?.widgetServer?.kill();
-  context?.server?.devServer?.close();
-  context?.server?.socketServer?.close();
-}
-
 function createServerTimer({ logger, cliConfig }) {
   return function waitForServerReady(url, timeout = 10000, interval = 500) {
     return new Promise((resolve, reject) => {
@@ -72,6 +65,9 @@ export async function buildPlayground({ args, command }) {
 
   const childProcessCliConfig = { ...cliConfig, silent: !cliConfig.verbose };
 
+  // TODO maybe skip building tasks, to be used in CI where there's a separate build step?
+
+  await clearFolder(cliConfig.staticPlayground);
   await clearBuildFolder({ merkurConfig, cliConfig: childProcessCliConfig });
 
   logger.info(`Running build tasks`);
@@ -106,7 +102,7 @@ export async function buildPlayground({ args, command }) {
     } catch (err) {
       logger.error(chalk.red.bold(`x Widget server failed to start:`));
       logger.error(chalk.red(err));
-      killServers(context);
+      killProcesses({ context });
       process.exit(1);
     }
   }
@@ -125,7 +121,7 @@ export async function buildPlayground({ args, command }) {
   } catch (err) {
     logger.error(chalk.red.bold('x Dev server failed to start:'));
     logger.error(chalk.red(err));
-    killServers(context);
+    killProcesses({ context });
     process.exit(1);
   }
 
@@ -162,10 +158,12 @@ export async function buildPlayground({ args, command }) {
       chalk.green.bold('Playground built successfully in: ') +
         chalk.green(playgroundFolderPath),
     );
+    killProcesses({ context });
+    process.exit(0);
   } catch (err) {
     logger.error(chalk.red.bold('x Failed to build static playground:'));
     logger.error(chalk.red(err));
-  } finally {
-    killServers(context);
+    killProcesses({ context });
+    process.exit(1);
   }
 }

package/src/handleExit.mjs

@@ -1,28 +1,32 @@
 import process from 'node:process';
 
-export async function handleExit({ context }) {
-  const handleExit = async () => {
-    Object.values(context.process).forEach((childProcess) => {
-      childProcess.kill('SIGTERM');
-    });
+export async function killProcesses({ context }) {
+  Object.values(context.process).forEach((childProcess) => {
+    childProcess.kill('SIGTERM');
+  });
 
-    Object.values(context.task).forEach((task) => {
-      task.dispose();
-    });
+  Object.values(context.task).forEach((task) => {
+    task.dispose();
+  });
 
-    await Promise.all(
-      Object.values(context.server).map((server) => {
-        return new Promise((resolve) => {
-          const timer = setTimeout(() => {
-            resolve();
-          }, 100);
-          server.close(() => {
-            clearTimeout(timer);
-            resolve();
-          });
+  await Promise.all(
+    Object.values(context.server).map((server) => {
+      return new Promise((resolve) => {
+        const timer = setTimeout(() => {
+          resolve();
+        }, 100);
+        server.close(() => {
+          clearTimeout(timer);
+          resolve();
         });
-      }),
-    );
+      });
+    }),
+  );
+}
+
+export async function handleExit({ context }) {
+  const handleExit = async () => {
+    await killProcesses({ context });
 
     process.exit(0);
   };