fix(core): Resolve issue with runtime env type serialization

Author: sullivanpj

devenv.lock

@@ -3,11 +3,11 @@
     "devenv": {
       "locked": {
         "dir": "src/modules",
-        "lastModified": 1777372895,
-        "narHash": "sha256-PGesjpeDbEPigEP7tdRw8Sm0mmOmonUdOOthBY+nhJA=",
+        "lastModified": 1777911862,
+        "narHash": "sha256-Vi3Zpj4M9hRhsOhMvbZMaYr0LC0NvG2cekJMrpaChGo=",
         "owner": "cachix",
         "repo": "devenv",
-        "rev": "cb344e4a5ab9241ae49739352c24268d5f8be13b",
+        "rev": "5297dd928c090440d90b9277d5113847b1edef19",
         "type": "github"
       },
       "original": {
@@ -55,11 +55,11 @@
     },
     "nixpkgs-unstable": {
       "locked": {
-        "lastModified": 1777270315,
-        "narHash": "sha256-yKB4G6cKsQsWN7M6rZGk6gkJPDNPIzT05y4qzRyCDlI=",
+        "lastModified": 1777826146,
+        "narHash": "sha256-wQ/iN5Zp5VIa3ebBibijPnLyKhor+xEbDy4d0goa9Zs=",
         "owner": "nixos",
         "repo": "nixpkgs",
-        "rev": "6368eda62c9775c38ef7f714b2555a741c20c72d",
+        "rev": "73c703c22422b8951895a960959dbbaca7296492",
         "type": "github"
       },
       "original": {
@@ -81,11 +81,11 @@
     "storm-ops": {
       "flake": false,
       "locked": {
-        "lastModified": 1777208622,
-        "narHash": "sha256-zdhbPgEEHfcdsBw/Pln6SuQ05h67yqTs90WoixuhiZ0=",
+        "lastModified": 1777487475,
+        "narHash": "sha256-Z6QbKN3uUu9NYub6DQf0dEP6iQ4SDZbhZYPF9eS/i5Q=",
         "owner": "storm-software",
         "repo": "storm-ops",
-        "rev": "53d2ed234e902be71b97a3f927d2613f1a15731f",
+        "rev": "945c02883fb239cad660662aec70ca7e2a5621f7",
         "type": "github"
       },
       "original": {

packages/core/package.json

@@ -374,6 +374,7 @@
     "@alloy-js/markdown": "catalog:",
     "@alloy-js/typescript": "catalog:",
     "@powerlines/deepkit": "catalog:",
+    "@powerlines/engine": "catalog:",
     "@powerlines/plugin-alloy": "catalog:",
     "@powerlines/plugin-automd": "catalog:",
     "@powerlines/plugin-deepkit": "catalog:",

packages/core/powerlines.config.ts

@@ -24,8 +24,7 @@ import { defineConfig } from "powerlines/config";
 
 const config: UserConfig = defineConfig({
   input: [
-    "./src/*.ts",
-    "./src/*.tsx",
+    "./src/*.{ts,tsx}",
     "./src/types/*.ts",
     "./src/components/*.{ts,tsx}",
     "./src/contexts/*.{ts,tsx}",

packages/core/src/api.ts

@@ -16,18 +16,17 @@
 
  ------------------------------------------------------------------- */
 
-import type { PartialKeys } from "@stryke/types";
 import type {
   BuildInlineConfig,
   CleanInlineConfig,
   DocsInlineConfig,
-  EngineOptions,
   LintInlineConfig,
-  PowerlinesAPI,
   PrepareInlineConfig
 } from "powerlines";
-import { createAPI } from "powerlines";
+import { PowerlinesAPI } from "powerlines/api";
+import type { PowerlinesExecutionContext } from "powerlines/context";
 import { plugin } from "./plugin";
+import type { EngineOptions } from "./types/config";
 
 /**
  * The Shell Shock API class.
@@ -44,13 +43,32 @@ export class ShellShockAPI {
    * @param options - The user configuration options.
    * @returns A promise that resolves to a {@link ShellShockAPI} instance.
    */
-  public static async fromOptions(
-    options: EngineOptions
-  ): Promise<ShellShockAPI> {
-    const powerlines = await createAPI(
-      { ...options, framework: "shell-shock" },
+  public static async from(options: EngineOptions): Promise<ShellShockAPI> {
+    const {
+      name,
+      root,
+      cwd,
+      mode,
+      logLevel,
+      organization,
+      configFile,
+      ...pluginOptions
+    } = options;
+
+    const powerlines = await PowerlinesAPI.from(
       {
-        plugins: [plugin()]
+        name,
+        root,
+        cwd: cwd || process.cwd(),
+        mode,
+        logLevel,
+        organization,
+        configFile,
+        framework: "shell-shock"
+      },
+      {
+        plugins: [plugin(pluginOptions)],
+        framework: "shell-shock"
       }
     );
 
@@ -62,7 +80,7 @@ export class ShellShockAPI {
    *
    * @returns The current build context.
    */
-  public get context() {
+  public get context(): PowerlinesExecutionContext {
     return this.#powerlines.context;
   }
 
@@ -137,11 +155,7 @@ export class ShellShockAPI {
  * @returns A promise that resolves to a {@link ShellShockAPI} instance.
  */
 export async function createShellShock(
-  options: PartialKeys<EngineOptions, "cwd" | "framework">
+  options: EngineOptions
 ): Promise<ShellShockAPI> {
-  return ShellShockAPI.fromOptions({
-    framework: "shell-shock",
-    cwd: process.cwd(),
-    ...options
-  });
+  return ShellShockAPI.from(options);
 }

packages/core/src/helpers/update-package-json.ts

@@ -37,64 +37,74 @@ export function formatBinaryPath(
 
 export async function updatePackageJsonBinary(context: Context): Promise<void> {
   const packageJsonPath = joinPaths(
-    context.config.cwd || process.cwd(),
+    context.config.cwd,
     context.config.root,
     "package.json"
   );
-  if (
-    context.config.bin &&
-    Array.isArray(context.config.bin) &&
-    context.config.bin.length > 0
-  ) {
-    context.packageJson.bin = Object.fromEntries(
-      getUnique(toArray(context.config.bin)).map(bin => [
-        bin,
-        formatBinaryPath(context.config.output.format)
-      ])
-    );
 
-    await context.fs.write(
-      packageJsonPath,
-      StormJSON.stringify(context.packageJson)
-    );
-  } else {
+  if (!context.packageJson) {
+    const packageJson = await context.fs.read(packageJsonPath);
+    if (packageJson) {
+      context.packageJson ??= JSON.parse(packageJson);
+    }
+  }
+
+  if (context.packageJson) {
     if (
-      Array.isArray(context.config.output.format) &&
-      context.config.output.format.length > 1
+      context.config.bin &&
+      Array.isArray(context.config.bin) &&
+      context.config.bin.length > 0
     ) {
-      context.packageJson.bin = {
-        [kebabCase(getAppName(context))]: formatBinaryPath(
-          toArray(context.config.output.format)[0]
-        )
-      };
-      context.packageJson.bin = toArray(context.config.output.format).reduce(
-        (ret, format) => {
-          ret[`${kebabCase(getAppName(context))}-${format}`] =
-            formatBinaryPath(format);
+      context.packageJson.bin = Object.fromEntries(
+        getUnique(toArray(context.config.bin)).map(bin => [
+          bin,
+          formatBinaryPath(context.config.output.format)
+        ])
+      );
 
-          return ret;
-        },
-        context.packageJson.bin
+      await context.fs.write(
+        packageJsonPath,
+        StormJSON.stringify(context.packageJson)
       );
     } else {
-      context.packageJson.bin = {
-        [kebabCase(getAppName(context))]: formatBinaryPath(
-          context.config.output.format
-        )
-      };
+      if (
+        Array.isArray(context.config.output.format) &&
+        context.config.output.format.length > 1
+      ) {
+        context.packageJson.bin = {
+          [kebabCase(getAppName(context))]: formatBinaryPath(
+            toArray(context.config.output.format)[0]
+          )
+        };
+        context.packageJson.bin = toArray(context.config.output.format).reduce(
+          (ret, format) => {
+            ret[`${kebabCase(getAppName(context))}-${format}`] =
+              formatBinaryPath(format);
+
+            return ret;
+          },
+          context.packageJson.bin
+        );
+      } else {
+        context.packageJson.bin = {
+          [kebabCase(getAppName(context))]: formatBinaryPath(
+            context.config.output.format
+          )
+        };
+      }
+
+      await context.fs.write(
+        packageJsonPath,
+        StormJSON.stringify(context.packageJson)
+      );
     }
 
-    await context.fs.write(
-      packageJsonPath,
-      StormJSON.stringify(context.packageJson)
-    );
-  }
+    if (!isSetObject(context.packageJson.bin)) {
+      throw new Error(
+        "Unable to determine the CLI binary name. Please specify the `bin` option in your Shell Shock configuration or ensure that the `name` field is set in your package.json."
+      );
+    }
 
-  if (!isSetObject(context.packageJson.bin)) {
-    throw new Error(
-      "Unable to determine the CLI binary name. Please specify the `bin` option in your Shell Shock configuration or ensure that the `name` field is set in your package.json."
-    );
+    context.config.bin = context.packageJson.bin;
   }
-
-  context.config.bin = context.packageJson.bin;
 }

packages/core/src/plugin.tsx

@@ -18,7 +18,6 @@
 
 import { For, Show } from "@alloy-js/core/components";
 import { ReflectionVisibility } from "@powerlines/deepkit/vendor/type";
-import alloy from "@powerlines/plugin-alloy";
 import { render } from "@powerlines/plugin-alloy/render";
 import automd from "@powerlines/plugin-automd";
 import { writeEnvTypeReflection } from "@powerlines/plugin-env/helpers";
@@ -88,7 +87,6 @@ export const plugin = <TContext extends Context = Context>(
   options: Options = {}
 ): Plugin<TContext>[] => {
   return [
-    ...alloy<TContext>(),
     tsdown<TContext>(),
     automd<TContext>(),
     {

packages/core/src/types/config.ts

@@ -20,19 +20,20 @@ import type { AlloyPluginResolvedConfig } from "@powerlines/plugin-alloy/types/p
 import type { AutoMDPluginResolvedConfig } from "@powerlines/plugin-automd";
 import type {
   NodeJsPluginOptions,
-  NodeJsPluginResolvedConfig,
-  NodeJsPluginUserConfig
+  NodeJsPluginResolvedConfig
 } from "@powerlines/plugin-nodejs/types/plugin";
+import type { TsdownPluginResolvedConfig } from "@powerlines/plugin-tsdown/types/plugin";
+import type { RequiredKeys } from "@stryke/types/base";
 import type {
-  TsdownPluginResolvedConfig,
-  TsdownPluginUserConfig
-} from "@powerlines/plugin-tsdown/types/plugin";
-import type { OutputConfig as PowerlinesOutputConfig } from "powerlines";
+  EngineOptions as PowerlinesEngineOptions,
+  OutputConfig as PowerlinesOutputConfig,
+  UserConfig as PowerlinesUserConfig
+} from "powerlines";
 import type { CommandBase, CommandOption } from "./command";
 import type { Context } from "./context";
 
 type BuildOptions = Pick<
-  TsdownPluginUserConfig,
+  PowerlinesUserConfig,
   | "root"
   | "name"
   | "title"
@@ -61,7 +62,7 @@ export interface ReferenceOptions {
   commands?: string;
 }
 
-type BaseOptions = Partial<BuildOptions> & {
+interface BaseOptions {
   /**
    * A set of global command options to apply to each command.
    *
@@ -110,7 +111,7 @@ type BaseOptions = Partial<BuildOptions> & {
    * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the application. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{reference}/command/subcommand`.
    */
   reference?: ReferenceOptions | string;
-};
+}
 
 /**
  * The plugin options for Shell Shock.
@@ -134,14 +135,19 @@ export type OutputConfig = Pick<
  * The user configuration options for Shell Shock.
  */
 export type UserConfig = BaseOptions &
-  Partial<NodeJsPluginUserConfig> &
-  Pick<NodeJsPluginUserConfig, "root"> & {
+  RequiredKeys<BuildOptions, "root" | "name"> & {
     /**
      * Configuration for the output of the build process
      */
     output?: OutputConfig;
   };
 
+export type EngineOptions = Omit<
+  PowerlinesEngineOptions,
+  "root" | "name" | "framework"
+> &
+  UserConfig;
+
 /**
  * The resolved configuration options for Shell Shock.
  */

packages/core/src/types/env.ts

@@ -17,7 +17,7 @@
  ------------------------------------------------------------------- */
 
 // eslint-disable-next-line ts/consistent-type-imports
-import { EnvInterface } from "@powerlines/plugin-env/types/runtime";
+import { EnvInterface } from "@powerlines/plugin-env/types/env";
 
 export interface ShellShockEnv extends EnvInterface {
   /**

packages/nx/src/base/base-executor.ts

@@ -101,6 +101,7 @@ export function withExecutor<
       }>(jiti.esmResolve("@shell-shock/core"));
 
       const api = await createShellShock({
+        name: context.projectName,
         root: projectConfig.root,
         cwd: workspaceConfig.workspaceRoot,
         configFile: options.configFile

packages/plugin-help/src/components/help-command.tsx

@@ -62,7 +62,7 @@ export function TemporaryHelpCommand() {
 }
 
 export interface HelpCommandsProps {
-  segments: string[][];
+  commands: string[][];
 }
 
 /**
@@ -72,8 +72,8 @@ export function HelpCommand(props: HelpCommandsProps) {
   const context = usePowerlines<HelpPluginContext>();
 
   const helpImports = computed(() =>
-    props.segments
-      ? props.segments.reduce(
+    props.commands
+      ? props.commands.reduce(
           (ret, segments) => {
             ret[joinPaths("help", ...segments)] = [
               {
@@ -90,7 +90,7 @@ export function HelpCommand(props: HelpCommandsProps) {
       : {}
   );
 
-  const commandSegmentsList = props.segments ?? [];
+  const commandSegmentsList = props.commands ?? [];
 
   return (
     <TypescriptFile