cli-test: 1.0 (#1857)

docs/content/reference/cli-test/classes/SlackCLIProcess.md

@@ -0,0 +1,150 @@
+# Class: SlackCLIProcess
+
+## Constructors
+
+### new SlackCLIProcess()
+
+```ts
+new SlackCLIProcess(
+   command, 
+   globalOptions?, 
+   commandOptions?): SlackCLIProcess
+```
+
+#### Parameters
+
+• **command**: `string`
+
+• **globalOptions?**: `SlackCLIGlobalOptions`
+
+• **commandOptions?**: `SlackCLICommandOptions`
+
+#### Returns
+
+[`SlackCLIProcess`](SlackCLIProcess.md)
+
+#### Defined in
+
+[cli/cli-process.ts:64](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L64)
+
+## Properties
+
+### command
+
+```ts
+command: string;
+```
+
+#### Description
+
+The CLI command to invoke
+
+#### Defined in
+
+[cli/cli-process.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L52)
+
+***
+
+### commandOptions
+
+```ts
+commandOptions: undefined | SlackCLICommandOptions;
+```
+
+#### Description
+
+The CLI command-specific options to pass to the command
+
+#### Defined in
+
+[cli/cli-process.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L62)
+
+***
+
+### globalOptions
+
+```ts
+globalOptions: undefined | SlackCLIGlobalOptions;
+```
+
+#### Description
+
+The global CLI options to pass to the command
+
+#### Defined in
+
+[cli/cli-process.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L57)
+
+## Methods
+
+### execAsync()
+
+```ts
+execAsync(shellOpts?): Promise<ShellProcess>
+```
+
+#### Parameters
+
+• **shellOpts?**: `Partial`\<`SpawnOptionsWithoutStdio`\>
+
+#### Returns
+
+`Promise`\<`ShellProcess`\>
+
+#### Description
+
+Executes the command asynchronously, returning the process details once the process finishes executing
+
+#### Defined in
+
+[cli/cli-process.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L76)
+
+***
+
+### execAsyncUntilOutputPresent()
+
+```ts
+execAsyncUntilOutputPresent(output, shellOpts?): Promise<ShellProcess>
+```
+
+#### Parameters
+
+• **output**: `string`
+
+• **shellOpts?**: `Partial`\<`SpawnOptionsWithoutStdio`\>
+
+#### Returns
+
+`Promise`\<`ShellProcess`\>
+
+#### Description
+
+Executes the command asynchronously, returning the process details once the process finishes executing
+
+#### Defined in
+
+[cli/cli-process.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L86)
+
+***
+
+### execSync()
+
+```ts
+execSync(shellOpts?): string
+```
+
+#### Parameters
+
+• **shellOpts?**: `Partial`\<`SpawnOptionsWithoutStdio`\>
+
+#### Returns
+
+`string`
+
+#### Description
+
+Executes the command synchronously, returning the process standard output
+
+#### Defined in
+
+[cli/cli-process.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L99)

docs/content/reference/cli-test/index.md

@@ -0,0 +1,12 @@
+# @slack/cli-test
+
+## Classes
+
+- [SlackCLIProcess](classes/SlackCLIProcess.md)
+
+## Variables
+
+- [SlackCLI](variables/SlackCLI.md)
+- [SlackProduct](variables/SlackProduct.md)
+- [SlackTracerId](variables/SlackTracerId.md)
+- [shell](variables/shell.md)

docs/content/reference/cli-test/typedoc-sidebar.cjs

@@ -0,0 +1,4 @@
+// @ts-check
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const typedocSidebar = { items: [{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/cli-test/classes/SlackCLIProcess","label":"SlackCLIProcess"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/cli-test/variables/SlackCLI","label":"SlackCLI"},{"type":"doc","id":"reference/cli-test/variables/SlackProduct","label":"SlackProduct"},{"type":"doc","id":"reference/cli-test/variables/SlackTracerId","label":"SlackTracerId"},{"type":"doc","id":"reference/cli-test/variables/shell","label":"shell"}]}]};
+module.exports = typedocSidebar.items;