feat(storm-stack): Major updates to project structure

Author: sullivanpj

.vscode/settings.json

@@ -50,7 +50,7 @@
   "prettier.bracketSameLine": true,
   "prettier.configPath": "./node_modules/@storm-software/prettier/config.json",
   "prettier.ignorePath": "./node_modules/@storm-software/prettier/.prettierignore",
-  "prettier.enableDebugLogs": true,
+  "prettier.enableDebugLogs": false,
   "prettier.enable": true,
   "markdownlint.config": {
     "extends": "./node_modules/@storm-software/markdownlint/config/config.json"

eslint.config.mjs

@@ -20,8 +20,5 @@ import { getStormConfig } from "@storm-software/eslint";
 Error.stackTraceLimit = Number.POSITIVE_INFINITY;
 
 export default getStormConfig({
-  repositoryName: "storm-stack",
-  nx: {
-    depsCheck: false
-  }
+  repositoryName: "storm-stack"
 });

examples/cloudflare-worker/docs/dotenv.md

@@ -3,7 +3,7 @@
 # Environment variables configuration
 
 Below is a list of environment variables used by the
-[@storm-stack/examples-cloudflare-app](https://www.npmjs.com/package/@storm-stack/examples-cloudflare-app)
+[@storm-stack/examples-cloudflare-worker](https://www.npmjs.com/package/@storm-stack/examples-cloudflare-worker)
 package. These values can be updated in the `.env` file in the root of the
 project.
 

examples/cloudflare-worker/package.json

@@ -11,10 +11,7 @@
   "private": true,
   "devDependencies": {
     "@storm-stack/nx": "workspace:*",
-    "@storm-stack/plugin-cloudflare-worker": "workspace:*",
+    "@storm-stack/plugin-cloudflare": "workspace:*",
     "storm-stack": "workspace:*"
-  },
-  "storm": {
-    "name": "examples-cloudflare-worker"
   }
 }

examples/cloudflare-worker/project.json

@@ -4,11 +4,26 @@
   "projectType": "application",
   "sourceRoot": "examples/cloudflare-worker/src",
   "targets": {
+    "prepare": {
+      "executor": "@storm-stack/nx:prepare",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "entry": "{sourceRoot}/index.ts#handler",
+        "outputPath": "dist/examples/cloudflare-worker",
+        "plugins": ["@storm-stack/plugin-cloudflare"],
+        "skipCache": true,
+        "skipInstalls": true,
+        "mode": "development"
+      }
+    },
     "build": {
-      "executor": "@storm-stack/nx:cloudflare-worker-build",
+      "executor": "@storm-stack/nx:build",
       "outputs": ["{options.outputPath}"],
+      "dependsOn": ["prepare"],
       "options": {
+        "entry": "{sourceRoot}/index.ts#handler",
         "outputPath": "dist/examples/cloudflare-worker",
+        "plugins": ["@storm-stack/plugin-cloudflare"],
         "skipCache": true,
         "skipInstalls": true,
         "mode": "development"

examples/cloudflare-worker/src/index.ts

@@ -17,7 +17,7 @@
 
 import type { ExamplePayload } from "./types";
 
-export function handler(event: StormEvent<"Request", ExamplePayload>) {
+export function handler(event: StormRequest<ExamplePayload>) {
   const payload = event.data;
 
   return payload.address.city;

examples/cloudflare-worker/wrangler.toml

@@ -0,0 +1,6 @@
+
+name = 'examples-cloudflare-worker'
+compatibility_date = '2025-03-13'
+main = '/.storm/entry-oqFxRJ2G.ts'
+account_id = 'undefined'
+compatibility_flags = ['nodejs_als']

examples/node-app/package.json

@@ -16,8 +16,5 @@
     "@storm-stack/nx": "workspace:*",
     "@storm-stack/plugin-node": "workspace:*",
     "storm-stack": "workspace:*"
-  },
-  "storm": {
-    "name": "examples-node-app"
   }
 }

examples/node-app/project.json

@@ -4,12 +4,26 @@
   "projectType": "application",
   "sourceRoot": "examples/node-app/src",
   "targets": {
+    "prepare": {
+      "executor": "@storm-stack/nx:prepare",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "entry": "{sourceRoot}/index.ts#getCity",
+        "outputPath": "dist/examples/node-app",
+        "plugins": ["@storm-stack/plugin-node"],
+        "skipCache": true,
+        "skipInstalls": true,
+        "mode": "development"
+      }
+    },
     "build": {
-      "executor": "@storm-stack/nx:node-build",
+      "executor": "@storm-stack/nx:build",
       "outputs": ["{options.outputPath}"],
+      "dependsOn": ["prepare"],
       "options": {
         "entry": "{sourceRoot}/index.ts#getCity",
         "outputPath": "dist/examples/node-app",
+        "plugins": ["@storm-stack/plugin-node"],
         "skipCache": true,
         "skipInstalls": true,
         "mode": "development"

package.json

@@ -72,13 +72,15 @@
     "@nx/workspace": "catalog:",
     "@storm-software/config": "catalog:",
     "@storm-software/cspell": "catalog:",
+    "@storm-software/esbuild": "catalog:",
     "@storm-software/eslint": "catalog:",
     "@storm-software/git-tools": "catalog:",
     "@storm-software/linting-tools": "catalog:",
     "@storm-software/markdownlint": "catalog:",
     "@storm-software/prettier": "catalog:",
     "@storm-software/testing-tools": "catalog:",
     "@storm-software/tsconfig": "catalog:",
+    "@storm-software/unbuild": "catalog:",
     "@storm-software/untyped": "catalog:",
     "@storm-software/workspace-tools": "catalog:",
     "@swc-node/register": "catalog:",

packages/eslint-plugin-storm-stack/src/configs/globals.ts

@@ -22,5 +22,8 @@ export const globals = {
   StormError: "readonly",
   StormRequest: "readonly",
   StormResponse: "readonly",
-  StormJSON: "readonly"
+  StormEvent: "readonly",
+  StormJSON: "readonly",
+  id: "readonly",
+  getRandom: "readonly"
 } as Record<string, ESLintGlobalsPropValue>;

packages/log-console/src/formatter.ts

@@ -42,9 +42,8 @@ const logLevelStyles: Record<LogLevel, string> = {
 /**
  * The default console formatter.
  *
- * @param record The log record to format.
- * @returns The formatted log record, as an array of arguments for
- *          {@link console.log}.
+ * @param record - The log record to format.
+ * @returns The formatted log record, as an array of arguments for {@link console.log}.
  */
 export function defaultConsoleFormatter(record: LogRecord): readonly unknown[] {
   let msg = "";

packages/log-console/src/types.ts

@@ -20,10 +20,10 @@ import type { LogRecord } from "storm-stack/types";
 /**
  * A console formatter is a function that accepts a log record and returns an array of arguments to pass to {@link console.log}.
  *
- * @param record The log record to format.
+ * @param record - The log record to format.
  * @returns The formatted log record, as an array of arguments for {@link console.log}.
  */
-export type ConsoleFormatter = (record: LogRecord) => readonly unknown[];
+export type ConsoleFormatter = (record: LogRecord) => readonly any[];
 
 /**
  * Options for the {@link getConsoleSink} function.

packages/log-sentry/README.md packages/log-sentry-node/README.md

@@ -1,9 +1,9 @@
 <!-- START header -->
 <!-- END header -->
 
-# Storm Stack - Sentry Log Adapters
+# Storm Stack - Sentry NodeJs Log Adapter
 
-A package containing a Storm Stack log adapter to write log messages to [Sentry](https://sentry.io/).
+A package containing a Storm Stack log adapter to write log messages to [Sentry](https://sentry.io/) in NodeJs applications.
 
 <!-- START doctoc -->
 <!-- END doctoc -->
@@ -13,14 +13,14 @@ A package containing a Storm Stack log adapter to write log messages to [Sentry]
 Using [pnpm](http://pnpm.io):
 
 ```bash
-pnpm add @storm-stack/log-sentry
+pnpm add @storm-stack/log-sentry-node
 ```
 
 <details>
   <summary>Using npm</summary>
 
 ```bash
-npm install @storm-stack/log-sentry
+npm install @storm-stack/log-sentry-node
 ```
 
 </details>
@@ -29,7 +29,7 @@ npm install @storm-stack/log-sentry
   <summary>Using yarn</summary>
 
 ```bash
-yarn add @storm-stack/log-sentry
+yarn add @storm-stack/log-sentry-node
 ```
 
 </details>
@@ -48,16 +48,16 @@ commands are available to assist in development.
 
 ### Building
 
-Run `nx build log-sentry` to build the library.
+Run `nx build log-sentry-node` to build the library.
 
 ### Running unit tests
 
-Run `nx test log-sentry` to execute the unit tests via
+Run `nx test log-sentry-node` to execute the unit tests via
 [Jest](https://jestjs.io).
 
 ### Linting
 
-Run `nx lint log-sentry` to run [ESLint](https://eslint.org/) on the package.
+Run `nx lint log-sentry-node` to run [ESLint](https://eslint.org/) on the package.
 
 <!-- START footer -->
 <!-- END footer -->

packages/log-sentry/docs/dotenv.md packages/log-sentry-node/docs/dotenv.md

@@ -3,7 +3,7 @@
 # Environment variables configuration
 
 Below is a list of environment variables used by the
-[@storm-stack/log-sentry](https://www.npmjs.com/package/@storm-stack/log-sentry)
+[@storm-stack/log-sentry-node](https://www.npmjs.com/package/@storm-stack/log-sentry-node)
 package. These values can be updated in the `.env` file in the root of the
 project.
 

packages/log-sentry-node/jest.config.ts

@@ -0,0 +1,3 @@
+import { getJestConfig } from '@storm-software/testing-tools';
+
+export default getJestConfig('packages/log-sentry-node', true, 'log-sentry-node');

packages/log-sentry/package.json packages/log-sentry-node/package.json

@@ -1,25 +1,30 @@
 {
-  "name": "@storm-stack/log-sentry",
+  "name": "@storm-stack/log-sentry-node",
   "version": "0.0.1",
   "type": "module",
-  "description": "A package containing a Storm Stack log adapter to write log messages to Sentry",
+  "description": "A package containing a Storm Stack log adapter to write log messages to Sentry in a NodeJS application",
   "repository": {
     "type": "github",
     "url": "https://github.com/storm-software/storm-stack.git",
-    "directory": "packages/log-sentry"
+    "directory": "packages/log-sentry-node"
   },
   "private": false,
   "dependencies": {
     "@sentry/core": "catalog:",
+    "@sentry/node": "catalog:",
     "@stryke/json": "catalog:"
   },
   "devDependencies": {
-    "@sentry/types": "catalog:",
     "@storm-stack/nx": "workspace:*",
     "@types/node": "catalog:",
     "storm-stack": "workspace:*"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "storm": {
+    "adapter": "log",
+    "init": "src/instrument.ts",
+    "sink": "src/index.ts"
   }
 }

packages/log-sentry/project.json packages/log-sentry-node/project.json

@@ -1,8 +1,8 @@
 {
-  "name": "log-sentry",
+  "name": "log-sentry-node",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "projectType": "library",
-  "sourceRoot": "packages/log-sentry/src",
+  "sourceRoot": "packages/log-sentry-node/src",
   "targets": {
     "nx-release-publish": {
       "executor": "@storm-software/workspace-tools:npm-publish"

packages/log-sentry/src/index.ts packages/log-sentry-node/src/index.ts

@@ -16,10 +16,10 @@
  ------------------------------------------------------------------- */
 
 /**
- * The log-sentry library used by Storm Software for building NodeJS applications.
+ * The log-sentry-node library used by Storm Software for building NodeJS applications.
  *
  * @remarks
- * A package containing a Storm Stack log adapter to write log messages to Sentry
+ * A package containing a Storm Stack log adapter to write log messages to Sentry in a NodeJS application.
  *
  * @packageDocumentation
  */

packages/nx/src/executors/node-build/executor.ts packages/log-sentry-node/src/instrument.ts

@@ -15,23 +15,14 @@
 
  ------------------------------------------------------------------- */
 
-import { withRunExecutor } from "@storm-software/workspace-tools";
-import { createBuildExecutor } from "../../base/build-executor";
-import type { StormStackNodeBuildExecutorSchema } from "./schema";
-
-export const executorFn = createBuildExecutor(["@storm-stack/plugin-node"]);
-
-export default withRunExecutor<StormStackNodeBuildExecutorSchema>(
-  "Storm Stack NodeJs build executor",
-  executorFn,
-  {
-    skipReadingConfig: false,
-    hooks: {
-      applyDefaultOptions: (options: StormStackNodeBuildExecutorSchema) => {
-        options.entry ??= "{sourceRoot}/index.ts";
-
-        return options;
-      }
-    }
-  }
-);
+import * as Sentry from "@sentry/node";
+
+Sentry.init({
+  dsn: $storm.env.SENTRY_DSN,
+  environment: $storm.env.ENVIRONMENT,
+  release: $storm.env.RELEASE_ID,
+  debug: $storm.env.DEBUG,
+  enabled: true,
+  attachStacktrace: $storm.env.STACKTRACE,
+  sendClientReports: true
+});

packages/log-sentry/src/sink.ts packages/log-sentry-node/src/sink.ts

@@ -48,7 +48,7 @@ function getParameterizedString(record: LogRecord): ParameterizedString {
 /**
  * A platform-specific inspect function. In Deno, this is {@link Deno.inspect}, and in Node.js/Bun it is {@link util.inspect}. If neither is available, it falls back to {@link StormJSON.stringify}.
  *
- * @param value The value to inspect.
+ * @param value - The value to inspect.
  * @returns The string representation of the value.
  */
 const inspect: (value: unknown) => string =
@@ -78,12 +78,12 @@ const inspect: (value: unknown) => string =
  *
  * @see https://sentry.io/
  *
- * @param client The Sentry client. If omitted, the global default client is used.
+ * @param client - The Sentry client. If omitted, the global default client is used.
  * @returns A LogTape sink that sends logs to Sentry.
  */
 export function getSink(client?: Client): LogSink {
   return (record: LogRecord) => {
-    if (client == null) {
+    if (!client) {
       client = getClient();
     }
 

packages/log-sentry/tsconfig.json packages/log-sentry-node/tsconfig.json

@@ -27,11 +27,9 @@ import type {
 /**
  * Get a platform-independent file sink.
  *
- * @typeParam TFile The type of the file descriptor.
- * @param path A path to the file to write to.
- * @param options The options for the sink and the file driver.
- * @returns A sink that writes to the file.  The sink is also a disposable
- *          object that closes the file when disposed.
+ * @param path - A path to the file to write to.
+ * @param options - The options for the sink and the file driver.
+ * @returns A sink that writes to the file. The sink is also a disposable object that closes the file when disposed.
  */
 export function getBaseFileSink<TFile>(
   path: string,
@@ -56,8 +54,8 @@ export function getBaseFileSink<TFile>(
  * followed by a dot and a number, starting from 1.  The number is incremented
  * for each rotation, and the maximum number of files to keep is `maxFiles`.
  *
- * @param path A path to the file to write to.
- * @param options The options for the sink and the file driver.
+ * @param path - A path to the file to write to.
+ * @param options - The options for the sink and the file driver.
  * @returns A sink that writes to the file.  The sink is also a disposable
  *          object that closes the file when disposed.
  */