Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli: Interactive setup for code quality tools and test frameworks #33269

Open
1 of 2 tasks
ren-yamanashi opened this issue Feb 2, 2025 · 0 comments
Open
1 of 2 tasks
Labels
feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. package/tools Related to AWS CDK Tools or CLI

Comments

@ren-yamanashi
Copy link
Contributor

ren-yamanashi commented Feb 2, 2025

Describe the feature

Add interactive CLI prompts for setting up code quality tools and test frameworks during project initialization for TypeScript / JavaScript.

⬇️ sample

sample-image

Similar issues: #32136

Use Case

Currently, the CLI automatically installs preset tools like Jest for testing. However, developers often have different preferences for their development tooling. An interactive setup would allow users to:

  • Choose their preferred package manager (e.g, npm, yarn, pnpm)
  • Choose their preferred code formatter (e.g., Prettier, biome)
  • Select linting tools (e.g., ESLint, biome)
  • Pick testing frameworks (e.g., Jest, Vitest)

Proposed Solution

Implement an interactive CLI setup similar to create-next-app or vue create:

1. Add prompts during cdk init for:

  • package manager selection (npm/yarn/pnpm)
  • Formatter selection (Prettier/Biome/none)
  • Linter configuration (ESLint/Biome/none)
  • Testing framework (Jest/Vitest/none)

2. Generate appropriate configuration files based on user selections

3. Add selected dependencies to package.json

4. install dependencies based on the selected package manager

Other Information

Reference implementations:

This would make the tool more flexible and suitable for different development preferences while maintaining the ease of setup.

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

CDK version used

2.171.1

Environment details (OS name and version, etc.)

macOS Sonoma 14.0

@ren-yamanashi ren-yamanashi added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Feb 2, 2025
@github-actions github-actions bot added the package/tools Related to AWS CDK Tools or CLI label Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. package/tools Related to AWS CDK Tools or CLI
Projects
None yet
Development

No branches or pull requests

1 participant