Fix CLI template gitignore scaffolding#11380
Open
cameronapak wants to merge 1 commit into
Open
Conversation
c347437 to
d699ed0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #11342
This fix makes it where
.gitignoreis properly added to the scaffolded project when runningnpx remix@next new.Why does the
.gitignorefile not get added when scaffolding a Remix 3 project? NPM packlist says, "If you have a package.json file with a files array within, any top level .npmignore and .gitignore files will be ignored."template/gitignoreso it survives npm packaging.gitignoreto.gitignorein the scaffold copy step..gitignoreand do not leak a plaingitignorefile.This mirrors the established scaffolding convention used by Create React App templates: the template contains
gitignore, and the create command renames it to.gitignoreduring project creation. npm's own packlist rules call out.gitignoreand.npmignoreas package-control files that are commonly omitted from package tarballs, and npm's package docs note that ignore files still affect package contents under included directories.References:
package.json#filesdocs: https://docs.npmjs.com/cli/v11/configuring-npm/package-json/#files