-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
[fix] rename dotfiles to avoid template problems #2990
Conversation
🦋 Changeset detectedLatest commit: 774ebc7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
I don't see the renamed dot-files in this PR |
They're not renamed in this repo, and they shouldn't need to be. They're renamed as they're copied into the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah now I understand, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@@ -134,7 +134,7 @@ async function main() { | |||
*/ | |||
function write_template_files(template, typescript, name, cwd) { | |||
const dir = dist(`templates/${template}`); | |||
copy(`${dir}/assets`, cwd, (name) => name.replace('gitignore', '.gitignore')); | |||
copy(`${dir}/assets`, cwd, (name) => name.replace('DOT-', '.')); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe use regex here too, for the off chance that there will ever be any file containing DOT-
in it's name...
copy(`${dir}/assets`, cwd, (name) => name.replace('DOT-', '.')); | |
copy(`${dir}/assets`, cwd, (name) => name.replace(/^DOT-/, '.')); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DOT-
could also be extracted as constant into packages/create-svelte/utils.js
I didn't review, but with four approvals, this seems safe to merge 😄 |
Fixes #2952.
Rather than adding another special case for
.npmrc
like there already is for.gitignore
, this simply renames all dotfiles to instead begin withDOT-
when thecreate-svelte
package is being built, and un-renames them when bootstrapping a new project with the CLI. This doesn't currently handle dotfiles other than at the top level of a particular template, but we don't have any of those. I didn't include that for simplicity, but if other folks think that would be a good idea to handle now while we're thinking of it, I'd be amenable to that.Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm test
and lint the project withpnpm lint
andpnpm check
Changesets
pnpx changeset
and following the prompts. All changesets should bepatch
until SvelteKit 1.0