{ "id": "@kbn/pm", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project", "type": "Class", "tags": [], "label": "Project", "description": [], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.fromPath", "type": "Function", "tags": [], "label": "fromPath", "description": [], "signature": [ "(path: string) => Promise<", { "pluginId": "@kbn/pm", "scope": "server", "docId": "kibKbnPmPluginApi", "section": "def-server.Project", "text": "Project" }, ">" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.fromPath.$1", "type": "string", "tags": [], "label": "path", "description": [], "signature": [ "string" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.json", "type": "Object", "tags": [], "label": "json", "description": [ "parsed package.json" ], "signature": [ "IPackageJson" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.packageJsonLocation", "type": "string", "tags": [], "label": "packageJsonLocation", "description": [ "absolute path to the package.json file in the project" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.nodeModulesLocation", "type": "string", "tags": [], "label": "nodeModulesLocation", "description": [ "absolute path to the node_modules in the project (might not actually exist)" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.targetLocation", "type": "string", "tags": [], "label": "targetLocation", "description": [ "absolute path to the target directory in the project (might not actually exist)" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.path", "type": "string", "tags": [], "label": "path", "description": [ "absolute path to the directory containing the project" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.version", "type": "string", "tags": [], "label": "version", "description": [ "the version of the project" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.allDependencies", "type": "Object", "tags": [], "label": "allDependencies", "description": [ "merged set of dependencies of the project, [name => version range]" ], "signature": [ "IPackageDependencies" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.productionDependencies", "type": "Object", "tags": [], "label": "productionDependencies", "description": [ "regular dependencies of the project, [name => version range]" ], "signature": [ "IPackageDependencies" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.devDependencies", "type": "Object", "tags": [], "label": "devDependencies", "description": [ "development dependencies of the project, [name => version range]" ], "signature": [ "IPackageDependencies" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.scripts", "type": "Object", "tags": [], "label": "scripts", "description": [ "scripts defined in the package.json file for the project [name => body]" ], "signature": [ "IPackageScripts" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.bazelPackage", "type": "boolean", "tags": [], "label": "bazelPackage", "description": [ "states if this project is a Bazel package" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.isSinglePackageJsonProject", "type": "boolean", "tags": [], "label": "isSinglePackageJsonProject", "description": [], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.Unnamed.$1", "type": "Object", "tags": [], "label": "packageJson", "description": [], "signature": [ "IPackageJson" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.Unnamed.$2", "type": "string", "tags": [], "label": "projectPath", "description": [], "signature": [ "string" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.ensureValidProjectDependency", "type": "Function", "tags": [], "label": "ensureValidProjectDependency", "description": [], "signature": [ "(project: ", { "pluginId": "@kbn/pm", "scope": "server", "docId": "kibKbnPmPluginApi", "section": "def-server.Project", "text": "Project" }, ") => void" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.ensureValidProjectDependency.$1", "type": "Object", "tags": [], "label": "project", "description": [], "signature": [ { "pluginId": "@kbn/pm", "scope": "server", "docId": "kibKbnPmPluginApi", "section": "def-server.Project", "text": "Project" } ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.getBuildConfig", "type": "Function", "tags": [], "label": "getBuildConfig", "description": [], "signature": [ "() => BuildConfig" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.getIntermediateBuildDirectory", "type": "Function", "tags": [], "label": "getIntermediateBuildDirectory", "description": [ "\nReturns the directory that should be copied into the Kibana build artifact.\nThis config can be specified to only include the project's build artifacts\ninstead of everything located in the project directory." ], "signature": [ "() => string" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.getCleanConfig", "type": "Function", "tags": [], "label": "getCleanConfig", "description": [], "signature": [ "() => CleanConfig" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.isBazelPackage", "type": "Function", "tags": [], "label": "isBazelPackage", "description": [], "signature": [ "() => boolean" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.isFlaggedAsDevOnly", "type": "Function", "tags": [], "label": "isFlaggedAsDevOnly", "description": [], "signature": [ "() => boolean" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.hasScript", "type": "Function", "tags": [], "label": "hasScript", "description": [], "signature": [ "(name: string) => boolean" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.hasScript.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.getExecutables", "type": "Function", "tags": [], "label": "getExecutables", "description": [], "signature": [ "() => { [key: string]: string; }" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.runScript", "type": "Function", "tags": [], "label": "runScript", "description": [], "signature": [ "(scriptName: string, args?: string[]) => Promise" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.runScript.$1", "type": "string", "tags": [], "label": "scriptName", "description": [], "signature": [ "string" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.runScript.$2", "type": "Array", "tags": [], "label": "args", "description": [], "signature": [ "string[]" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.runScriptStreaming", "type": "Function", "tags": [], "label": "runScriptStreaming", "description": [], "signature": [ "(scriptName: string, options?: { args?: string[] | undefined; debug?: boolean | undefined; }) => ", "ExecaChildProcess", "" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.runScriptStreaming.$1", "type": "string", "tags": [], "label": "scriptName", "description": [], "signature": [ "string" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.runScriptStreaming.$2", "type": "Object", "tags": [], "label": "options", "description": [], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.runScriptStreaming.$2.args", "type": "Array", "tags": [], "label": "args", "description": [], "signature": [ "string[] | undefined" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.runScriptStreaming.$2.debug", "type": "CompoundType", "tags": [], "label": "debug", "description": [], "signature": [ "boolean | undefined" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false } ] } ], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.hasDependencies", "type": "Function", "tags": [], "label": "hasDependencies", "description": [], "signature": [ "() => boolean" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.isEveryDependencyLocal", "type": "Function", "tags": [], "label": "isEveryDependencyLocal", "description": [], "signature": [ "() => boolean" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.installDependencies", "type": "Function", "tags": [], "label": "installDependencies", "description": [], "signature": [ "(options?: { extraArgs?: string[] | undefined; }) => Promise" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.installDependencies.$1", "type": "Object", "tags": [], "label": "options", "description": [], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.Project.installDependencies.$1.extraArgs", "type": "Array", "tags": [], "label": "extraArgs", "description": [], "signature": [ "string[] | undefined" ], "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false } ] } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "@kbn/pm", "id": "def-server.buildBazelProductionProjects", "type": "Function", "tags": [], "label": "buildBazelProductionProjects", "description": [], "signature": [ "({\n kibanaRoot,\n buildRoot,\n onlyOSS,\n}: { kibanaRoot: string; buildRoot: string; onlyOSS?: boolean | undefined; }) => Promise" ], "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.buildBazelProductionProjects.$1", "type": "Object", "tags": [], "label": "{\n kibanaRoot,\n buildRoot,\n onlyOSS,\n}", "description": [], "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.buildBazelProductionProjects.$1.kibanaRoot", "type": "string", "tags": [], "label": "kibanaRoot", "description": [], "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.buildBazelProductionProjects.$1.buildRoot", "type": "string", "tags": [], "label": "buildRoot", "description": [], "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.buildBazelProductionProjects.$1.onlyOSS", "type": "CompoundType", "tags": [], "label": "onlyOSS", "description": [], "signature": [ "boolean | undefined" ], "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", "deprecated": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.buildNonBazelProductionProjects", "type": "Function", "tags": [], "label": "buildNonBazelProductionProjects", "description": [], "signature": [ "({\n kibanaRoot,\n buildRoot,\n onlyOSS,\n}: { kibanaRoot: string; buildRoot: string; onlyOSS?: boolean | undefined; }) => Promise" ], "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.buildNonBazelProductionProjects.$1", "type": "Object", "tags": [], "label": "{\n kibanaRoot,\n buildRoot,\n onlyOSS,\n}", "description": [], "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.buildNonBazelProductionProjects.$1.kibanaRoot", "type": "string", "tags": [], "label": "kibanaRoot", "description": [], "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.buildNonBazelProductionProjects.$1.buildRoot", "type": "string", "tags": [], "label": "buildRoot", "description": [], "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", "deprecated": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.buildNonBazelProductionProjects.$1.onlyOSS", "type": "CompoundType", "tags": [], "label": "onlyOSS", "description": [], "signature": [ "boolean | undefined" ], "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", "deprecated": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.getProjectPaths", "type": "Function", "tags": [], "label": "getProjectPaths", "description": [ "\nReturns all the paths where plugins are located" ], "signature": [ "({ rootPath, ossOnly, skipKibanaPlugins }: Options) => string[]" ], "path": "packages/kbn-pm/src/config.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.getProjectPaths.$1", "type": "Object", "tags": [], "label": "{ rootPath, ossOnly, skipKibanaPlugins }", "description": [], "signature": [ "Options" ], "path": "packages/kbn-pm/src/config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.getProjects", "type": "Function", "tags": [], "label": "getProjects", "description": [], "signature": [ "(rootPath: string, projectsPathsPatterns: string[], { include = [], exclude = [] }: ", "IProjectsOptions", ", bazelOnly: boolean) => Promise<", "ProjectMap", ">" ], "path": "packages/kbn-pm/src/utils/projects.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.getProjects.$1", "type": "string", "tags": [], "label": "rootPath", "description": [], "signature": [ "string" ], "path": "packages/kbn-pm/src/utils/projects.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/pm", "id": "def-server.getProjects.$2", "type": "Array", "tags": [], "label": "projectsPathsPatterns", "description": [], "signature": [ "string[]" ], "path": "packages/kbn-pm/src/utils/projects.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/pm", "id": "def-server.getProjects.$3", "type": "Object", "tags": [], "label": "{ include = [], exclude = [] }", "description": [], "signature": [ "IProjectsOptions" ], "path": "packages/kbn-pm/src/utils/projects.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/pm", "id": "def-server.getProjects.$4", "type": "boolean", "tags": [], "label": "bazelOnly", "description": [], "signature": [ "boolean" ], "path": "packages/kbn-pm/src/utils/projects.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.run", "type": "Function", "tags": [], "label": "run", "description": [], "signature": [ "(argv: string[]) => Promise" ], "path": "packages/kbn-pm/src/cli.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.run.$1", "type": "Array", "tags": [], "label": "argv", "description": [], "signature": [ "string[]" ], "path": "packages/kbn-pm/src/cli.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/pm", "id": "def-server.transformDependencies", "type": "Function", "tags": [], "label": "transformDependencies", "description": [ "\nReplaces `link:` dependencies with `file:` dependencies. When installing\ndependencies, these `file:` dependencies will be copied into `node_modules`\ninstead of being symlinked.\n\nThis will allow us to copy packages into the build and run `yarn`, which\nwill then _copy_ the `file:` dependencies into `node_modules` instead of\nsymlinking like we do in development.\n\nAdditionally it also taken care of replacing `link:bazel-bin/` with\n`file:` so we can also support the copy of the Bazel packages dist already into\nbuild/packages to be copied into the node_modules" ], "signature": [ "(dependencies: ", "IPackageDependencies", ") => ", "IPackageDependencies" ], "path": "packages/kbn-pm/src/utils/package_json.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/pm", "id": "def-server.transformDependencies.$1", "type": "Object", "tags": [], "label": "dependencies", "description": [], "signature": [ "IPackageDependencies" ], "path": "packages/kbn-pm/src/utils/package_json.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }