feat(core): Added the state built-in module

Author: sullivanpj

eslint.config.mjs

@@ -25,5 +25,8 @@ export default defineConfig({
   name: "shell-shock",
   nx: {
     depsCheck: false
+  },
+  tsdoc: {
+    configFile: "@powerlines/tsdoc/recommended.json"
   }
 });

package.json

@@ -64,6 +64,7 @@
     "@nx/workspace": "catalog:",
     "@powerlines/nx": "catalog:",
     "@powerlines/tsconfig": "catalog:",
+    "@powerlines/tsdoc": "catalog:",
     "@storm-software/config": "catalog:",
     "@storm-software/config-tools": "catalog:",
     "@storm-software/cspell": "catalog:",

packages/core/package.json

@@ -138,6 +138,34 @@
         "default": "./dist/components/options-parser-logic.mjs"
       }
     },
+    "./components/spawn-builtin": {
+      "require": {
+        "types": "./dist/components/spawn-builtin.d.cts",
+        "default": "./dist/components/spawn-builtin.cjs"
+      },
+      "import": {
+        "types": "./dist/components/spawn-builtin.d.mts",
+        "default": "./dist/components/spawn-builtin.mjs"
+      },
+      "default": {
+        "types": "./dist/components/spawn-builtin.d.mts",
+        "default": "./dist/components/spawn-builtin.mjs"
+      }
+    },
+    "./components/state-builtin": {
+      "require": {
+        "types": "./dist/components/state-builtin.d.cts",
+        "default": "./dist/components/state-builtin.cjs"
+      },
+      "import": {
+        "types": "./dist/components/state-builtin.d.mts",
+        "default": "./dist/components/state-builtin.mjs"
+      },
+      "default": {
+        "types": "./dist/components/state-builtin.d.mts",
+        "default": "./dist/components/state-builtin.mjs"
+      }
+    },
     "./components/usage": {
       "require": {
         "types": "./dist/components/usage.d.cts",
@@ -334,20 +362,6 @@
         "types": "./dist/types/options.d.mts",
         "default": "./dist/types/options.mjs"
       }
-    },
-    "./types/runtime": {
-      "require": {
-        "types": "./dist/types/runtime.d.cts",
-        "default": "./dist/types/runtime.cjs"
-      },
-      "import": {
-        "types": "./dist/types/runtime.d.mts",
-        "default": "./dist/types/runtime.mjs"
-      },
-      "default": {
-        "types": "./dist/types/runtime.d.mts",
-        "default": "./dist/types/runtime.mjs"
-      }
     }
   },
   "main": "./dist/index.cjs",

packages/core/src/api.ts

@@ -22,10 +22,9 @@ import type {
   DocsInlineConfig,
   LintInlineConfig,
   PluginConfig,
-  PowerlinesAPI,
   PrepareInlineConfig
 } from "powerlines";
-import { createPowerlines } from "powerlines";
+import { createPowerlines, PowerlinesAPI } from "powerlines";
 import { plugin } from "./plugin";
 import type { UserConfig } from "./types/config";
 
@@ -38,12 +37,19 @@ import type { UserConfig } from "./types/config";
 export class ShellShockAPI {
   #powerlines: PowerlinesAPI;
 
-  public static async from(config: UserConfig = {}): Promise<ShellShockAPI> {
-    const powerlines = await createPowerlines({
+  public static async from(
+    config: UserConfig,
+    workspaceRoot?: string
+  ): Promise<ShellShockAPI> {
+    const userConfig = {
       framework: "shell-shock",
       ...config,
       plugins: [plugin(), ...(config.plugins ?? [])] as PluginConfig<any>[]
-    });
+    };
+
+    const powerlines = await (workspaceRoot
+      ? PowerlinesAPI.from(workspaceRoot, userConfig)
+      : createPowerlines(userConfig));
 
     return new ShellShockAPI(powerlines);
   }
@@ -86,7 +92,5 @@ export class ShellShockAPI {
 export async function createShellShock(
   options: Partial<UserConfig> = {}
 ): Promise<ShellShockAPI> {
-  options.root ??= process.cwd();
-
-  return ShellShockAPI.from(options);
+  return ShellShockAPI.from({ root: process.cwd(), ...options });
 }

packages/core/src/components/helpers.tsx

@@ -119,10 +119,6 @@ export function CommandParameterType(props: { parameter: CommandParameter }) {
           ? "number"
           : "string"
   }${
-    (parameter.kind === CommandParameterKinds.string ||
-      parameter.kind === CommandParameterKinds.number) &&
-    parameter.variadic
-      ? "[]"
-      : ""
+    parameter.variadic ? "[]" : ""
   }${parameter.optional ? " | undefined" : ""}`;
 }

packages/core/src/components/index.ts

@@ -20,5 +20,7 @@ export * from "./command-validation-logic";
 export * from "./docs";
 export * from "./helpers";
 export * from "./options-parser-logic";
+export * from "./spawn-builtin";
+export * from "./state-builtin";
 export * from "./usage";
 export * from "./utils-builtin";

packages/core/src/components/options-parser-logic.tsx

@@ -212,22 +212,20 @@ export function ArgumentsParserLogic(props: ArgumentsParserLogicProps) {
                 type={<CommandParameterType parameter={arg} />}
                 initializer={
                   <>
+                    {code` ( `}
                     <Show when={isSetString(arg.env)}>
                       {code`env.${appSpecificEnvPrefix}_${constantCase(String(arg.env))} ?? `}
                     </Show>
                     <Show
                       when={arg.default !== undefined}
-                      fallback={
-                        (arg.kind === CommandParameterKinds.string ||
-                          arg.kind === CommandParameterKinds.number) &&
-                        arg.variadic
-                          ? code`[]`
-                          : code`undefined;`
-                      }>
+                      fallback={arg.variadic ? code`[]` : code`undefined`}>
                       {arg.kind === CommandParameterKinds.string
                         ? code`"${arg.default}"`
                         : code`${arg.default}`}
                     </Show>
+                    {code`) as `}
+                    <CommandParameterType parameter={arg} />
+                    {code`; `}
                   </>
                 }
               />
@@ -247,16 +245,12 @@ export function ArgumentsParserLogic(props: ArgumentsParserLogicProps) {
                   />
                 }>
                 <Show
-                  when={
-                    (arg.kind === CommandParameterKinds.string ||
-                      arg.kind === CommandParameterKinds.number) &&
-                    arg.variadic
-                  }
+                  when={arg.variadic}
                   fallback={
                     <Show
                       when={arg.kind === CommandParameterKinds.number}
-                      fallback={code`args[argsIndex + ${index}]; `}>
-                      {code`Number(args[argsIndex + ${index}]); `}
+                      fallback={code`args[argsIndex + ${index}] `}>
+                      {code`Number(args[argsIndex + ${index}]) `}
                     </Show>
                   }>
                   {code`args.slice(argsIndex + ${
@@ -266,6 +260,9 @@ export function ArgumentsParserLogic(props: ArgumentsParserLogicProps) {
                   }).join(" ").split(",").map(item => item.trim().replace(/^("|')/, "").replace(/("|')$/, "")).filter(Boolean)`}
                 </Show>
               </Show>
+              {code` as `}
+              <CommandParameterType parameter={arg} />
+              {code`; `}
             </IfStatement>
             <Spacing />
           </>
@@ -654,10 +651,20 @@ export function OptionsMemberParserCondition(
 export function OptionsInterfaceDeclaration(props: { command: CommandTree }) {
   const { command } = props;
 
-  const options = computed(() => computedOptions(command));
+  const options = computed(() =>
+    computedOptions(
+      Object.entries(command.options).map(([name, option]) => ({
+        ...option,
+        name
+      }))
+    )
+  );
 
   return (
-    <InterfaceDeclaration export name={`${pascalCase(command.name)}Options`}>
+    <InterfaceDeclaration
+      export
+      name={`${pascalCase(command.name)}Options`}
+      extends="GlobalOptions">
       <For each={Object.values(options.value)} hardline>
         {option => <OptionsMember option={option} />}
       </For>
@@ -690,7 +697,14 @@ export interface OptionsParserLogicProps {
 export function OptionsParserLogic(props: OptionsParserLogicProps) {
   const { command, appSpecificEnvPrefix, isCaseSensitive = false } = props;
 
-  const options = computed(() => computedOptions(command));
+  const options = computed(() =>
+    computedOptions(
+      Object.entries(command.options).map(([name, option]) => ({
+        ...option,
+        name
+      }))
+    )
+  );
 
   return (
     <>
@@ -755,7 +769,7 @@ export function OptionsParserLogic(props: OptionsParserLogicProps) {
               return "";
             })
             .join("")}
-          } as ${pascalCase(command.name)}Options;`}
+          } as unknown as ${pascalCase(command.name)}Options;`}
       />
       <Spacing />
       {code`for (let i = 0; i < args.slice(${