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

chore(create-vite): add current directory description #8501

Merged
merged 7 commits into from
Jun 9, 2022

Conversation

sapphi-red
Copy link
Member

@sapphi-red sapphi-red commented Jun 8, 2022

Description

  • Added description for initializing in the current directory.
    image
    • Maybe we could change project name to directory name?
  • Derive package name from the current directory if . is used for project name
  • Add description about initializing in the current directory in README.

closes #8448

Additional context


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@sapphi-red sapphi-red added the p2-nice-to-have Not breaking anything but nice to have (priority) label Jun 8, 2022
@patak-dev
Copy link
Member

Description

  • Added description for initializing in the current directory.

I think that this may be too long in the UI. I prefer we use documentation instead. IMO most users wont use this option.

  • Maybe we could change project name to directory name?

It would help users to discover . and to know they can use any kind of char, but at least to me, most of the users will use and expect a project name here. We may confuse more people by changing to directory name.

  • Derive package name from the current directory if . is used for project name

Nice! I think for now, I vote to only leave this change to merge the PR.

@sapphi-red
Copy link
Member Author

Thanks for the suggestions.
I agree that this is too long. I'll move it to the README.md.

@patak-dev patak-dev merged commit 8d08220 into vitejs:main Jun 9, 2022
@sapphi-red sapphi-red deleted the docs/create-vite-cwd branch June 9, 2022 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2-nice-to-have Not breaking anything but nice to have (priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

allow to initialize template project in actual folder instead of subfolder.
3 participants