@jskit-ai/agent-docs 0.1.131 → 0.1.133

package/reference/autogen/tooling/create-app.md

@@ -1,317 +0,0 @@
-# tooling/create-app
-
-Generated by `npm run agent-docs:build`.
-Do not edit manually.
-
-Generated inventory for `tooling/create-app`.
-Use this on demand; do not load the full index at startup.
-
-## Scope
-- Source: `tooling/create-app/**/*{.js,.mjs,.cjs,.vue}`
-- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `.vitepress/cache/`, `.vitepress/dist/`
-
-## Sections
-
-### src
-
-### `src/client/index.js`
-Exports
-- None
-
-### `src/index.js`
-Exports
-- None
-
-### `src/server/cliEntrypoint.js`
-Exports
-- `shellQuote(value)`
-- `runCliEntrypoint(runCli, argv = process.argv.slice(2))`
-
-### `src/server/cliError.js`
-Exports
-- `createCliError(message, { showUsage = false, exitCode = 1 } = {})`
-
-### `src/server/index.js`
-Exports
-- `createApp({ appName, appTitle = null, template = DEFAULT_TEMPLATE, target = null, initialBundles = DEFAULT_INITIAL_BUNDLES, playwrightVersion = DEFAULT_PLAYWRIGHT_VERSION, tenancyMode = null, force = false, dryRun = false, cwd = process.cwd() })`
-- `runCli(argv, { stdout = process.stdout, stderr = process.stderr, stdin = process.stdin, cwd = process.cwd(), readlineFactory = createReadlineInterface } = {})`
-Local functions
-- `toAppTitle(appName)`
-- `normalizeInitialBundlesPreset(value, { showUsage = true } = {})`
-- `normalizeTenancyMode(value, { showUsage = true } = {})`
-- `normalizePlaywrightVersion(value, { showUsage = true } = {})`
-- `buildInitialSetupCommands(initialBundles)`
-- `validateAppName(appName, { showUsage = true } = {})`
-- `parseOptionWithValue(argv, index, optionName)`
-- `parseCliArgs(argv)`
-- `printUsage(stream = process.stderr)`
-- `applyPlaceholders(source, replacements)`
-- `isPathWithinRoot(rootPath, candidatePath)`
-- `normalizeTemplatePathSegments(templateName)`
-- `resolveTemplateDirectory(templateName)`
-- `ensureTargetDirectoryState(targetDirectory, { force = false, dryRun = false } = {})`
-- `sortEntriesByName(entries)`
-- `mapTemplatePathToTargetPath(relativePath)`
-- `writeTemplateFile(sourcePath, targetPath, replacements)`
-- `copyTemplateDirectory({ templateDirectory, targetDirectory, replacements, dryRun })`
-- `toRelativeTargetLabel(cwd, targetDirectory)`
-- `askQuestion(readline, label, defaultValue)`
-- `askYesNoQuestion(readline, label, defaultValue)`
-- `createReadlineInterface({ stdin = process.stdin, stdout = process.stdout } = {})`
-- `collectInteractiveOptions({ parsed, stdout = process.stdout, stderr = process.stderr, stdin = process.stdin, readlineFactory = createReadlineInterface })`
-
-### templates
-
-### `templates/base-shell/bin/server.js`
-Exports
-- None
-
-### `templates/base-shell/config/public.js`
-Exports
-- `config`
-
-### `templates/base-shell/config/server.js`
-Exports
-- `config`
-
-### `templates/base-shell/config/surfaceAccessPolicies.js`
-Exports
-- `surfaceAccessPolicies`
-
-### `templates/base-shell/eslint.config.mjs`
-Exports
-- None
-
-### `templates/base-shell/packages/main/src/client/index.js`
-Exports
-- `MainClientProvider`
-- `registerMainClientComponent`
-
-### `templates/base-shell/packages/main/src/client/providers/MainClientProvider.js`
-Exports
-- `MainClientProvider`
-- `registerMainClientComponent(token, resolveComponent)`
-
-### `templates/base-shell/packages/main/src/server/index.js`
-Exports
-- `MainServiceProvider`
-
-### `templates/base-shell/packages/main/src/server/loadAppConfig.js`
-Exports
-- `loadAppConfig({ moduleUrl = import.meta.url } = {})`
-
-### `templates/base-shell/packages/main/src/server/MainServiceProvider.js`
-Exports
-- `MainServiceProvider`
-
-### `templates/base-shell/packages/main/src/shared/index.js`
-Exports
-- None
-
-### `templates/base-shell/packages/main/src/shared/schemas/index.js`
-Exports
-- None
-
-### `templates/base-shell/playwright.config.mjs`
-Exports
-- None
-
-### `templates/base-shell/server.js`
-Exports
-- `createServer()`
-- `startServer(options = {})`
-Local functions
-- `toRequestPathname(urlValue)`
-- `isApiPath(pathname)`
-- `hasFileExtension(pathname)`
-- `resolveGlobalUiPaths(runtimeGlobalUiPaths = [])`
-- `resolveStaticFilePath(pathname)`
-- `canServeStaticFile(distRoot, relativePath)`
-
-### `templates/base-shell/server/lib/runtimeEnv.js`
-Exports
-- `resolveRuntimeEnv()`
-Local functions
-- `toPort(value, fallback = 3000)`
-- `ensureRuntimeEnvLoaded()`
-
-### `templates/base-shell/server/lib/surfaceRuntime.js`
-Exports
-- `surfaceRuntime`
-
-### `templates/base-shell/src/App.vue`
-Exports
-- None
-
-### `templates/base-shell/src/components/menus/MenuLinkItem.vue`
-Exports
-- None
-
-### `templates/base-shell/src/components/menus/SurfaceAwareMenuLinkItem.vue`
-Exports
-- None
-
-### `templates/base-shell/src/components/menus/TabLinkItem.vue`
-Exports
-- None
-
-### `templates/base-shell/src/components/ShellLayout.vue`
-Exports
-- `default`
-
-### `templates/base-shell/src/error.js`
-Exports
-- None
-
-### `templates/base-shell/src/main.js`
-Exports
-- None
-
-### `templates/base-shell/src/pages/home.vue`
-Exports
-- None
-
-### `templates/base-shell/src/pages/home/index.vue`
-Exports
-- None
-
-### `templates/base-shell/src/pages/home/settings.vue`
-Exports
-- None
-
-### `templates/base-shell/src/pages/home/settings/general/index.vue`
-Exports
-- None
-
-### `templates/base-shell/src/pages/home/settings/index.vue`
-Exports
-- None
-
-### `templates/base-shell/src/placement.js`
-Exports
-- `addPlacement`
-- `getPlacements()`
-
-### `templates/base-shell/src/placementTopology.js`
-Exports
-- `addPlacementTopology(value = {})`
-- `default`
-
-### `templates/base-shell/src/views/NotFound.vue`
-Exports
-- None
-
-### `templates/base-shell/vite.config.mjs`
-Exports
-- None
-Local functions
-- `clientEntry(()`
-
-### `templates/minimal-shell/bin/server.js`
-Exports
-- None
-
-### `templates/minimal-shell/config/public.js`
-Exports
-- `config`
-
-### `templates/minimal-shell/config/server.js`
-Exports
-- `config`
-
-### `templates/minimal-shell/config/surfaceAccessPolicies.js`
-Exports
-- `surfaceAccessPolicies`
-
-### `templates/minimal-shell/eslint.config.mjs`
-Exports
-- None
-
-### `templates/minimal-shell/packages/main/src/client/index.js`
-Exports
-- `MainClientProvider`
-- `registerMainClientComponent`
-
-### `templates/minimal-shell/packages/main/src/client/providers/MainClientProvider.js`
-Exports
-- `MainClientProvider`
-- `registerMainClientComponent(token, resolveComponent)`
-
-### `templates/minimal-shell/packages/main/src/server/index.js`
-Exports
-- `MainServiceProvider`
-
-### `templates/minimal-shell/packages/main/src/server/loadAppConfig.js`
-Exports
-- `loadAppConfig({ moduleUrl = import.meta.url } = {})`
-
-### `templates/minimal-shell/packages/main/src/server/MainServiceProvider.js`
-Exports
-- `MainServiceProvider`
-
-### `templates/minimal-shell/packages/main/src/shared/index.js`
-Exports
-- None
-
-### `templates/minimal-shell/packages/main/src/shared/schemas/index.js`
-Exports
-- None
-
-### `templates/minimal-shell/playwright.config.mjs`
-Exports
-- None
-
-### `templates/minimal-shell/server.js`
-Exports
-- `createServer()`
-- `startServer(options = {})`
-Local functions
-- `toRequestPathname(urlValue)`
-- `isApiPath(pathname)`
-- `hasFileExtension(pathname)`
-- `resolveGlobalUiPaths(runtimeGlobalUiPaths = [])`
-- `resolveStaticFilePath(pathname)`
-- `canServeStaticFile(distRoot, relativePath)`
-
-### `templates/minimal-shell/server/lib/runtimeEnv.js`
-Exports
-- `resolveRuntimeEnv()`
-Local functions
-- `toPort(value, fallback = 3000)`
-- `ensureRuntimeEnvLoaded()`
-
-### `templates/minimal-shell/server/lib/surfaceRuntime.js`
-Exports
-- `surfaceRuntime`
-
-### `templates/minimal-shell/src/App.vue`
-Exports
-- None
-
-### `templates/minimal-shell/src/main.js`
-Exports
-- None
-
-### `templates/minimal-shell/src/pages/home.vue`
-Exports
-- None
-
-### `templates/minimal-shell/src/pages/home/index.vue`
-Exports
-- None
-
-### `templates/minimal-shell/src/views/NotFound.vue`
-Exports
-- None
-
-### `templates/minimal-shell/vite.config.mjs`
-Exports
-- None
-Local functions
-- `clientEntry(()`
-
-### bin
-
-### `bin/jskit-create-app.js`
-Exports
-- None