Amplify Prompts Utility

Common errors

• TypeError: (0, amplify_prompts__WEBPACK_IMPORTED_MODULE_0__.input) is not a function

  cause Incorrectly importing named exports, often due to a default import when none exists, or incorrect pathing in a bundler context.
  fix Ensure you are using named imports with curly braces: `import { input } from 'amplify-prompts';`. Verify your bundler configuration correctly handles module resolution.

• Process hangs, waiting for input indefinitely in CI/CD pipeline.

  cause An interactive prompt function (e.g., `input`, `confirm`, `select`) was invoked in a non-interactive environment without a mechanism to provide input.
  fix Review the calling Amplify CLI command for options to provide non-interactive answers (e.g., `--yes`, `--force`). If directly using `amplify-prompts`, ensure logic bypasses interactive prompts when `process.stdout.isTTY` is false or use a mocking library for tests.

• Error: stdout is not a TTY

  cause The prompt library detects that `process.stdout` is not connected to a terminal, which is necessary for interactive prompts to function correctly.
  fix This is often an environmental issue when running in a debugger or an IDE's output window that doesn't fully simulate a TTY. Try running the script directly from your system's terminal.

Warnings

• gotcha The `amplify-prompts` package is primarily an internal utility of the AWS Amplify CLI. While it's published, direct consumption by end-user applications is generally not the intended use case. Its API might change more fluidly with CLI internal refactors.
  Fix: Consider if you truly need to use this package directly. For application-level prompts, a general-purpose library like `inquirer` or `prompts` might be more appropriate and stable. If extending the Amplify CLI, follow official contribution guidelines.
• breaking Changes in underlying Node.js versions supported by the Amplify CLI can lead to unexpected behavior or incompatibilities with prompt rendering, especially concerning `stdin`/`stdout` handling.
  Fix: Ensure your Node.js environment matches the recommended version for the Amplify CLI you are targeting. Regularly update your Node.js and npm versions. Verify behavior in a controlled environment before deployment.
• gotcha Running `amplify-prompts` in non-interactive environments (e.g., CI/CD pipelines) without providing default answers or mocking inputs will cause processes to hang indefinitely, awaiting user input.
  Fix: For automation, ensure all prompts are either bypassed with CLI flags (if available in the calling Amplify command) or pre-configured with answers. When testing, use mocking libraries to simulate user input.
• deprecated Older versions of the Amplify CLI or internal utilities might have relied on CommonJS (`require`) for module loading. Modern Amplify CLI development primarily uses ESM (`import`).
  Fix: For new development within the Amplify CLI ecosystem, prefer ES Module imports (`import { ... } from 'pkg';`). Ensure your project's `tsconfig.json` and `package.json` are configured for ESM if necessary.

Install

• npm install amplify-prompts npm
• yarn add amplify-prompts yarn
• pnpm add amplify-prompts pnpm

Imports

• input
  wrong:

  const { input } = require('amplify-prompts');

  correct:

  import { input } from 'amplify-prompts';

  CommonJS require style might work for older Node.js environments or specific build configurations, but ESM import is preferred in modern Amplify CLI development.
• confirm
  wrong:

  import confirm from 'amplify-prompts';

  correct:

  import { confirm } from 'amplify-prompts';

  Functions are named exports; there is no default export for this utility.
• select
  wrong:

  import { Select } from 'amplify-prompts';

  correct:

  import { select } from 'amplify-prompts';

  Ensure correct casing for named exports, as most prompts are lowercase function names.

Quickstart

Demonstrates basic interactive terminal input, confirmation, and selection using amplify-prompts utilities.

import { input, confirm, select } from 'amplify-prompts';

async function runAmplifyPromptsDemo() {
  console.log('Starting Amplify Prompts Demo...');

  const projectName = await input('Enter your project name:');
  console.log(`Project name entered: ${projectName}`);

  const needsAuth = await confirm('Does your project require authentication?');
  console.log(`Authentication required: ${needsAuth ? 'Yes' : 'No'}`);

  if (needsAuth) {
    const authType = await select(
      'Select an authentication type:',
      [
        { name: 'Email/Password', value: 'email_password' },
        { name: 'Social Login', value: 'social_login' },
        { name: 'API Key', value: 'api_key' }
      ]
    );
    console.log(`Authentication type selected: ${authType}`);
  }

  console.log('Amplify Prompts Demo finished.');
}

runAmplifyPromptsDemo().catch(console.error);