Skip to content

feat: create-svelte support for scoped packages #4851

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

feat: create-svelte support for scoped packages #4851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0a1cd9
feat: create-svelte support for scoped packages
elliott-with-the-longest-name-on-github May 8, 2022
036752d
feat: Changeset
elliott-with-the-longest-name-on-github May 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cuddly-stingrays-boil.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'create-svelte': patch
---

Now asks for project name instead of inferring it from filepath
41 changes: 33 additions & 8 deletions packages/create-svelte/bin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,41 @@ async function main() {
console.log(gray(`\ncreate-svelte version ${version}`));
console.log(disclaimer);

let cwd = process.argv[2] || '.';

if (cwd === '.') {
const opts = await prompts([
const package_name = await prompts(
[
{
type: 'text',
name: 'dir',
message: 'Where should we create your project?\n (leave blank to use current directory)'
name: 'packagename',
message: 'What would you like to name your project?',
validate: (value) => {
const regex = new RegExp(/^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

~ is no longer allowed for new packages, see https://github.com/npm/validate-npm-package-name

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting! That's probably a second bug fix for us -- the current function we're using to convert folder names to package names is still allowing them. I'll likely change this implementation to use the library you linked in your top level comment anyway -- I didn't realize that was an official NPM library when I saw it!

const match = regex.test(value);
return !match
? 'Value is not a valid NPM package name. Package names must be lowercase and one word, and may contain hyphens and underscores, or be scoped and of the form @scope/package.'
Copy link
Contributor

@Mlocik97 Mlocik97 May 8, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't match already boolean value? Also I don't know if You want to put error message here.

return match ?? 'Value is not...'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, you're sort of right. The error message would never be returned with ?? (nullish coalescing) -- but I should be using matched || "Blah blah blah". I'll fix it later.

: true;
}
}
],
{
onCancel: () => process.exit(1)
}
);

let cwd = process.argv[2] || `./${package_name.packagename}`;

if (cwd !== process.argv[2]) {
const opts = await prompts(
[
{
type: 'text',
name: 'dir',
message: `Where should we create your project?\n (leave blank to use default: ${cwd})`
}
],
{
onCancel: () => process.exit(1)
}
]);
);

if (opts.dir) {
cwd = opts.dir;
Expand Down Expand Up @@ -113,7 +138,7 @@ async function main() {
)
);

options.name = path.basename(path.resolve(cwd));
options.name = package_name.packagename;

await create(cwd, options);

Expand Down
12 changes: 1 addition & 11 deletions packages/create-svelte/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ function write_common_files(cwd, options, name) {

pkg.dependencies = sort_keys(pkg.dependencies);
pkg.devDependencies = sort_keys(pkg.devDependencies);
pkg.name = to_valid_package_name(name);
pkg.name = name;

fs.writeFileSync(pkg_file, JSON.stringify(pkg, null, ' '));
}
Expand Down Expand Up @@ -134,13 +134,3 @@ function sort_keys(obj) {

return sorted;
}

/** @param {string} name */
function to_valid_package_name(name) {
return name
.trim()
.toLowerCase()
.replace(/\s+/g, '-')
.replace(/^[._]/, '')
.replace(/[^a-z0-9~.-]+/g, '-');
}