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

fix: include a .gitignore file in the copied over template from create-fuels #1613

Closed
wants to merge 6 commits into from

Conversation

Dhaiwat10
Copy link
Member

@Dhaiwat10 Dhaiwat10 commented Jan 5, 2024

npm doesn't include .gitignore files in package binaries once published to npm. This is why the source code of our templates - once publishsed to npm - didn't have a .gitignore file with it.

To go around this, I have added an extra file called gitignore (without the . at the start) so that npm includes it in the bundle. This file is then renamed to .gitignore by the CLI tool when it extracts the template.

I have also kept the .gitignore since the template folder is built out during our monorepo's build and we want the resulting build artifacts ignored.

This is not the fanciest solution but it is the one I've seen most commonly used by scaffolding CLI projects, even by create-next-app.

Closes #1612

@Dhaiwat10 Dhaiwat10 changed the base branch from master to rc/salamander January 5, 2024 12:06
@Dhaiwat10 Dhaiwat10 self-assigned this Jan 5, 2024
@Dhaiwat10 Dhaiwat10 added the bug Issue is a bug label Jan 5, 2024
@Dhaiwat10 Dhaiwat10 marked this pull request as ready for review January 5, 2024 12:10
@Dhaiwat10 Dhaiwat10 mentioned this pull request Jan 5, 2024
44 tasks
@Dhaiwat10 Dhaiwat10 added this to the 1 - Salamander milestone Jan 5, 2024
@arboleya
Copy link
Member

arboleya commented Jan 5, 2024

Looking good! — edit: A couple of tests to fix. 😅

It needs to be against master.

@Dhaiwat10 Dhaiwat10 closed this Jan 5, 2024
@Dhaiwat10 Dhaiwat10 removed this from the 1 - Salamander milestone Jan 5, 2024
@Dhaiwat10 Dhaiwat10 deleted the dp/create-fuels-gitignore branch February 23, 2024 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue is a bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants