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

[FEATURE] Enable Custom Project Naming Directly with 'asyncapi new glee' Command #844

Open
2 tasks done
techmannih opened this issue Sep 15, 2024 · 4 comments
Open
2 tasks done
Labels
enhancement New feature or request

Comments

@techmannih
Copy link

Why do we need this improvement?

I propose an enhancement to the asyncapi new glee command to allow users to specify a custom project name directly as a command argument. This change aims to streamline the project creation process and improve user experience.

How will this change help?

Benefits:

Streamlined Workflow: Users can create a project with their desired name in a single step, enhancing efficiency and reducing manual steps.

Enhanced Usability: Aligns with common CLI practices, making the tool more intuitive and easier to use.

Clearer Process: Avoids the need to navigate into a default directory and simplifies the project setup.

Directory Validation: Ensure the provided project name is valid and does not conflict with existing directories.

Current Behavior:

Currently, the asyncapi new glee command creates a new project within a default project directory, which requires additional navigation steps to reach the newly created project.

Proposed Enhancement:

Allow the asyncapi new glee command to accept a custom project name as an argument, simplifying the command and reducing the number of steps required. For example:

asyncapi new glee awesome-api

This command would directly create a new project named awesome-api, setting up all necessary files and configurations within this directory.

Screenshots

No response

How could it be implemented/designed?

  1. Command-Line Parsing: Modify the CLI to accept a custom project name argument, allowing users to specify the desired project name directly when running the asyncapi new glee command.
  2. Directory Creation: Update the project creation logic to create a new directory with the given project name, initializing the project files and configurations within this directory.
  3. Directory Validation: Implement validation to ensure the provided project name adheres to naming conventions and does not conflict with existing directories.

🚧 Breaking changes

Yes

👀 Have you checked for similar open issues?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

@techmannih techmannih added the enhancement New feature or request label Sep 15, 2024
Copy link
Contributor

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@techmannih
Copy link
Author

@KhudaDad414 @Souvikns please assign me this issue

@AayushSaini101
Copy link

@techmannih
Copy link
Author

techmannih commented Oct 1, 2024

@AayushSaini101 Okay thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants