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

Support non-alphanumeric characters in project name #46

Open
sandwichnyc opened this issue Jul 15, 2021 · 3 comments
Open

Support non-alphanumeric characters in project name #46

sandwichnyc opened this issue Jul 15, 2021 · 3 comments
Labels
Resolution: Refine This PR is marked for Jira refinement. We're not working on it - we're talking it through.

Comments

@sandwichnyc
Copy link

Stencil version:

 @stencil/core@2.6.0

I'm submitting a:

[ ] bug report
[x] feature request
[ ] support request => Please do not submit support requests here, use one of these channels: https://stencil-worldwide.herokuapp.com/ or https://forum.ionicframework.com/

Current behavior:
When installing Stencil, if you create a package name that contains non-alphanumeric characters, the install fails:

✖ Project name "@blah/my-project" is not valid. It must be a kebab-case name without spaces.

Expected behavior:
The project name should be able to support prefixes (such as @stencil/core) since this is a common convention.

Steps to reproduce:

Related code:

// insert any relevant code here

Other information:

@johnjenkins
Copy link

The ‘project name’ doesn’t really relate to the package name. It’s just used to name folders and some entry files

@sandwichnyc
Copy link
Author

The ‘project name’ doesn’t really relate to the package name. It’s just used to name folders and some entry files

Sorry, I should clarify this more. In our case, we have a root package (it's a monorepo) and it's called, for example, @blah/my-package. If I run the Stencil init in that root package and give it a kebab case name such as my-stencil-project, it creates a directory within that root package called my-stencil-project and it has its own package.json. So that makes sense. Is it possible though, to install Stencil such that it's at the root directory level and not in its own sub-directory? I tried moving files around manually and adding all of the Stencil stuff to the root package.json, but that doesn't work because of the format of that @blah/my-package name.

@rwaskiewicz rwaskiewicz transferred this issue from ionic-team/stencil Jul 23, 2021
@rwaskiewicz
Copy link
Member

I apologize it took so long for someone on the team to respond to this request. I'm going to label it to be ingested into our backlog/discussed with the team

@rwaskiewicz rwaskiewicz added Resolution: Refine This PR is marked for Jira refinement. We're not working on it - we're talking it through. and removed triage labels May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resolution: Refine This PR is marked for Jira refinement. We're not working on it - we're talking it through.
Projects
None yet
Development

No branches or pull requests

3 participants