[EPIC] Enhance CLI init Command with Interactive Setup, Config Automation, and Default Project Structure

[gregsantos]

Issue To Be Solved

This feature request aims to enhance the user setup experience for our CLI tool by introducing a series of interactive prompts during the initialization (init) process. The goal is to enable users to tailor their setup process by making key decisions about their environment, specifically:

1. Choosing between testnet or mainnet for their network configuration.
2. Deciding whether to run an emulator for local development purposes. If yes, the tool should automatically use a service account key for authentication and integrate this key into the flow.json configuration file, simplifying the process.
3. Offering the option to create a new account/s for immediate use in testing.

The problem addressed here is the current lack of guided setup, which can lead to a cumbersome and error-prone configuration process for users, particularly those new to the platform.

Solution

Network Configuration Prompt

Technical Implementation: During the init process, implement a series of prompts asking users to select their desired network, accounts, deployment, and contracts configuration. Store their responses in the flow.json configuration file.

Emulator Usage and Configuration Automation

Technical Implementation: Introduce a prompt asking users if they wish to enable the emulator. If the user opts in, automatically retrieve a service account key and update the flow.json configuration file to include this key. This process should be automated to reduce setup complexity and user error.

Account Creation Option

Technical Implementation: In addition to the service account configuration, offer users the option to create a new account/s during the init process. This should include storing generated keys in the flow.json

Default Directory Structure and Project Bootstrapping

Technical Implementation: Enhance the init command to also create a default directory structure that follows best practices for Flow project organization. This structure should be automatically generated upon initialization and include:

• A flow.json file populated with all sensible defaults relevant to the chosen network configuration (testnet or mainnet) and any accounts, deployments, or contracts created during the initialization process.
• A cadence directory containing subdirectories for contracts, scripts, and transactions. Each of these subdirectories will contain a starter Cadence file (HelloWorld.cdc in contracts, QueryHelloMessage.cdc in scripts, and SetHelloMessage.cdc in transactions) to help users get started with development immediately.
  A tests directory containing a basic test file (TestHello.cdc) to encourage testing from the outset of the project.
  Considerations: This structure aims to provide a solid foundation for project development, encouraging best practices in organization and testing. While the default files and structure are designed to be universally applicable, users should have the flexibility to modify or extend this structure as needed for their specific projects.

Tradeoffs: Introducing a default directory structure increases the CLI's complexity and the assumptions it makes about user needs. However, it significantly benefits by providing a clear path forward for new users and reducing the initial setup time for a new project.

Context

The lack of an intuitive setup process seems a significant barrier to entry for new users of our CLI tool. By addressing this issue, we can lower the hurdles for engaging with our platform, thereby increasing adoption and user satisfaction. This feature request is part of a broader initiative to enhance user experience and streamline developer workflows.

Tasks

Beta Give feedback

1. flow dev should start flow emulator #1392
   Feedback Improvement +2
   
2. Allow adding alias when adding a contract with Dependency Manager #1363
   Feature Feedback +2
   
3. Add dependencies from Dependency Manager to a deployment account #1362
   Feature +1
   
4. flow test configuration and default behaviour #1378
   Feature Feedback +2
   
5. Generate tests from flow generate contract #1394
   Feature Feedback +2
   
6. flow init should generate all files required #1481
   Feature +1
   
7. flow init should ask what core contracts you'd like installed with dependency manager #1482
   Feature +1
   
8. flow dev should run tests #1493
   Feature +1
   
9. Change messaging at end of install #1502
   +0
   
10. Change setup to init #1503
    +0
    
11. Create docs for interactive setup #1505
    +0
    
12. Embedded flags work in tests but not manually #1519
    +0
    
13. Create new select option and refactor to have separate prompt package and files #1520
    +0
    
14. Make sure in setup deployments prompt happens for dependency manager #1522
    +0
    
15. Add new text input and refactor for reusability #1526
    +0
    
16. Keep any project creation from saving until completion in case of cancellation #1531
    +0
    
17. Change paths in flow.json to relative #1532
    +0
    
18. Add progress indicator to slow sections #1541
    +0
    
19. Disable logs in generate for setup #1554
    +0
    
20. Use HelloWorld as default contract #1587
    +0
    
21. Setup project for flow dev #1575
    +0
    
22. flow dev should run emulator without flag #1579
    +0
    
23. Add target directory option for emulator key generation #1583
    +0
    
24. Fix issue with flow dev/emulator running simultaneously #1585
    +0
25. Prompt yes/no if you'd like to install core contracts #1586
    +0
    
26. Add config only flag to init to just generate flow.json #1588
    +0