Merge pull request #335 from underctrl-io/docs

twlite · web-flow · commit 938105406288 · 2025-07-10T09:01:23.000+05:45
docs: generate api docs
diff --git a/.prettierignore b/.prettierignore
@@ -31,4 +31,5 @@ pnpm-debug.log*
 turbo-lint.log
 .source
 
-turbo/generators/templates/**/*.hbs
+turbo/generators/templates/**/*.hbs
+routeTree.gen.ts
diff --git a/apps/website/docs/api-reference/commandkit/functions/bootstrap-commandkit-cli.mdx b/apps/website/docs/api-reference/commandkit/functions/bootstrap-commandkit-cli.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## bootstrapCommandkitCLI
 
-<GenerationInfo sourceFile="packages/commandkit/src/cli/init.ts" sourceLine="18" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/cli/init.ts" sourceLine="19" packageName="commandkit" />
 
 Creates a command line interface for CommandKit.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/create-proxy.mdx b/apps/website/docs/api-reference/commandkit/functions/create-proxy.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## createProxy
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="189" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="192" packageName="commandkit" />
 
 Creates a simple proxy object that mirrors the target object.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/debounce.mdx b/apps/website/docs/api-reference/commandkit/functions/debounce.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## debounce
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="89" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="92" packageName="commandkit" />
 
 Debounces a function.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/defer.mdx b/apps/website/docs/api-reference/commandkit/functions/defer.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## defer
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="127" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="130" packageName="commandkit" />
 
 Defers the execution of a function.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/dev-only.mdx b/apps/website/docs/api-reference/commandkit/functions/dev-only.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## devOnly
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="159" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="162" packageName="commandkit" />
 
 Creates a function from the given function that runs only in development mode.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/find-app-directory.mdx b/apps/website/docs/api-reference/commandkit/functions/find-app-directory.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## findAppDirectory
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="56" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="59" packageName="commandkit" />
 
 Returns the path to the app directory.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/get-current-directory.mdx b/apps/website/docs/api-reference/commandkit/functions/get-current-directory.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## getCurrentDirectory
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="26" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="29" packageName="commandkit" />
 
 Returns the current working directory of the CommandKit application.
 This is typically the directory where the source code is located.
diff --git a/apps/website/docs/api-reference/commandkit/functions/get-source-directories.mdx b/apps/website/docs/api-reference/commandkit/functions/get-source-directories.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## getSourceDirectories
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="43" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="46" packageName="commandkit" />
 
 Returns the possible source directories for the CommandKit application.
 This includes the `src`, `.commandkit`, and the distribution directory.
diff --git a/apps/website/docs/api-reference/commandkit/functions/json-serialize.mdx b/apps/website/docs/api-reference/commandkit/functions/json-serialize.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## JsonSerialize
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="139" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="142" packageName="commandkit" />
 
 Serializes a value to JSON.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/load-config-file.mdx b/apps/website/docs/api-reference/commandkit/functions/load-config-file.mdx
@@ -13,12 +13,12 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## loadConfigFile
 
-<GenerationInfo sourceFile="packages/commandkit/src/config/loader.ts" sourceLine="44" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/config/loader.ts" sourceLine="45" packageName="commandkit" />
 
 Load the configuration file from the given entrypoint.
 
 ```ts title="Signature"
-function loadConfigFile(entrypoint:  = process.cwd()): void
+function loadConfigFile(entrypoint:  = COMMANDKIT_CWD): void
 ```
 Parameters
 
diff --git a/apps/website/docs/api-reference/commandkit/interfaces/simple-proxy.mdx b/apps/website/docs/api-reference/commandkit/interfaces/simple-proxy.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## SimpleProxy
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="172" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/utilities.ts" sourceLine="175" packageName="commandkit" />
 
 Represents a simple proxy object that mirrors a target object.
 
diff --git a/apps/website/docs/api-reference/commandkit/types/hmrevent-type.mdx b/apps/website/docs/api-reference/commandkit/types/hmrevent-type.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## HMREventType
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="44" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="49" packageName="commandkit" />
 
 The type for HMR events.
 
diff --git a/apps/website/docs/api-reference/commandkit/variables/commandkit_bootstrap_mode.mdx b/apps/website/docs/api-reference/commandkit/variables/commandkit_bootstrap_mode.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## COMMANDKIT_BOOTSTRAP_MODE
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="20" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="25" packageName="commandkit" />
 
 The current bootstrap mode of CommandKit.
 This can be 'development' or 'production'.
diff --git a/apps/website/docs/api-reference/commandkit/variables/commandkit_cwd.mdx b/apps/website/docs/api-reference/commandkit/variables/commandkit_cwd.mdx
@@ -0,0 +1,19 @@
+---
+title: "COMMANDKIT_CWD"
+isDefaultIndex: false
+generated: true
+---
+
+import MemberInfo from '@site/src/components/MemberInfo';
+import GenerationInfo from '@site/src/components/GenerationInfo';
+import MemberDescription from '@site/src/components/MemberDescription';
+
+<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
+
+
+## COMMANDKIT_CWD
+
+<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="4" packageName="commandkit" />
+
+The current working directory of the CommandKit instance.
+
diff --git a/apps/website/docs/api-reference/commandkit/variables/commandkit_is_cli.mdx b/apps/website/docs/api-reference/commandkit/variables/commandkit_is_cli.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## COMMANDKIT_IS_CLI
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="9" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="14" packageName="commandkit" />
 
 Indicates whether CommandKit is running in CLI thread.
 
diff --git a/apps/website/docs/api-reference/commandkit/variables/commandkit_is_dev.mdx b/apps/website/docs/api-reference/commandkit/variables/commandkit_is_dev.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## COMMANDKIT_IS_DEV
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="4" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="9" packageName="commandkit" />
 
 Indicates whether CommandKit is running in development mode.
 
diff --git a/apps/website/docs/api-reference/commandkit/variables/commandkit_is_test.mdx b/apps/website/docs/api-reference/commandkit/variables/commandkit_is_test.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## COMMANDKIT_IS_TEST
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="14" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="19" packageName="commandkit" />
 
 Indicates whether CommandKit is running in test mode.
 
diff --git a/apps/website/docs/api-reference/commandkit/variables/hmrevent-type.mdx b/apps/website/docs/api-reference/commandkit/variables/hmrevent-type.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## HMREventType
 
-<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="26" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/utils/constants.ts" sourceLine="31" packageName="commandkit" />
 
 Types of Hot Module Replacement events
 
diff --git a/apps/website/docs/api-reference/i18n/classes/i18n-plugin.mdx b/apps/website/docs/api-reference/i18n/classes/i18n-plugin.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## I18nPlugin
 
-<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="149" packageName="@commandkit/i18n" />
+<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="150" packageName="@commandkit/i18n" />
 
 
 
diff --git a/apps/website/docs/api-reference/i18n/functions/use-i18n.mdx b/apps/website/docs/api-reference/i18n/functions/use-i18n.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## useI18n
 
-<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="137" packageName="@commandkit/i18n" />
+<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="138" packageName="@commandkit/i18n" />
 
 Retrieves the i18n instance from the commandkit store.
 
diff --git a/apps/website/docs/api-reference/i18n/interfaces/command-localization-context.mdx b/apps/website/docs/api-reference/i18n/interfaces/command-localization-context.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandLocalizationContext
 
-<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="69" packageName="@commandkit/i18n" />
+<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="70" packageName="@commandkit/i18n" />
 
 
 
diff --git a/apps/website/docs/api-reference/i18n/interfaces/localization-plugin-options.mdx b/apps/website/docs/api-reference/i18n/interfaces/localization-plugin-options.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## LocalizationPluginOptions
 
-<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="56" packageName="@commandkit/i18n" />
+<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="57" packageName="@commandkit/i18n" />
 
 Options for the localization plugin.
 This interface defines the options that can be passed to the localization plugin.
diff --git a/apps/website/docs/api-reference/i18n/types/dynamic-localization-module.mdx b/apps/website/docs/api-reference/i18n/types/dynamic-localization-module.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## DynamicLocalizationModule
 
-<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="49" packageName="@commandkit/i18n" />
+<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="50" packageName="@commandkit/i18n" />
 
 Represents a dynamic localization module that can be used with the i18next plugin.
 
diff --git a/apps/website/docs/api-reference/i18n/types/localization-module.mdx b/apps/website/docs/api-reference/i18n/types/localization-module.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## LocalizationModule
 
-<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="41" packageName="@commandkit/i18n" />
+<GenerationInfo sourceFile="packages/i18n/src/i18n.ts" sourceLine="42" packageName="@commandkit/i18n" />
 
 Represents a localization module that can be used with the i18next plugin.
 
diff --git a/apps/website/docs/api-reference/legacy/classes/legacy-commands-cliplugin.mdx b/apps/website/docs/api-reference/legacy/classes/legacy-commands-cliplugin.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## LegacyCommandsCLIPlugin
 
-<GenerationInfo sourceFile="packages/legacy/src/cli.ts" sourceLine="22" packageName="@commandkit/legacy" />
+<GenerationInfo sourceFile="packages/legacy/src/cli.ts" sourceLine="27" packageName="@commandkit/legacy" />
 
 LegacyCommandsCLIPlugin is a CommandKit compiler plugin that provides a CLI
 interface for creating legacy commands and events.
diff --git a/packages/devtools-ui/src/routeTree.gen.ts b/packages/devtools-ui/src/routeTree.gen.ts
