CLI: Ensure .gitignore updated via CLI ends with a newline

[3w36zj6]

What I did

POSIX defines that text files should end with a newline¹. However, the .gitignore updated via CLI does not end with a newline.
Therefore, I fixed it to ensure that a newline is added to the final line.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

1. Navigate to the project folder where .gitignore does not include *storybook.log.
2. Add storybook using the init command via the CLI
3. Expect the .gitignore file to be updated, with the final line ending in a newline.

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

name	before	after	diff	z	%
createSize	0 B	0 B	0 B	-	-
generateSize	77.5 MB	77.5 MB	100 B	3.74	0%
initSize	162 MB	162 MB	123 B	0.39	0%
diffSize	85 MB	85 MB	23 B	-0.45	0%
buildSize	7.57 MB	7.57 MB	0 B	-0.42	0%
buildSbAddonsSize	1.66 MB	1.66 MB	0 B	-0.42	0%
buildSbCommonSize	195 kB	195 kB	0 B	-	0%
buildSbManagerSize	2.34 MB	2.34 MB	0 B	-	0%
buildSbPreviewSize	352 kB	352 kB	0 B	-	0%
buildStaticSize	0 B	0 B	0 B	-	-
buildPrebuildSize	4.55 MB	4.55 MB	0 B	-0.42	0%
buildPreviewSize	3.02 MB	3.02 MB	0 B	-0.42	0%
testBuildSize	0 B	0 B	0 B	-	-
testBuildSbAddonsSize	0 B	0 B	0 B	-	-
testBuildSbCommonSize	0 B	0 B	0 B	-	-
testBuildSbManagerSize	0 B	0 B	0 B	-	-
testBuildSbPreviewSize	0 B	0 B	0 B	-	-
testBuildStaticSize	0 B	0 B	0 B	-	-
testBuildPrebuildSize	0 B	0 B	0 B	-	-
testBuildPreviewSize	0 B	0 B	0 B	-	-

name	before	after	diff	z	%
createTime	17.5s	6.6s	-10s -920ms	-1.14	-165.3%
generateTime	22.8s	21.1s	-1s -711ms	0.56	-8.1%
initTime	14.6s	17.1s	2.5s	0.77	14.7%
buildTime	9.9s	10.3s	378ms	-0.88	3.7%
testBuildTime	0ms	0ms	0ms	-	-
devPreviewResponsive	6.6s	6.2s	-329ms	-1.31	🔰-5.2%
devManagerResponsive	4.4s	4.1s	-262ms	-1.15	-6.3%
devManagerHeaderVisible	782ms	775ms	-7ms	-0.34	-0.9%
devManagerIndexVisible	817ms	807ms	-10ms	-0.41	-1.2%
devStoryVisibleUncached	1.3s	1.3s	-28ms	-0.47	-2.2%
devStoryVisible	816ms	810ms	-6ms	-0.37	-0.7%
devAutodocsVisible	632ms	653ms	21ms	-1.07	3.2%
devMDXVisible	666ms	609ms	-57ms	-1.56	🔰-9.4%
buildManagerHeaderVisible	716ms	647ms	-69ms	-1.51	🔰-10.7%
buildManagerIndexVisible	722ms	720ms	-2ms	-0.92	-0.3%
buildStoryVisible	782ms	721ms	-61ms	-1.27	🔰-8.5%
buildAutodocsVisible	664ms	615ms	-49ms	-1.23	-8%
buildMDXVisible	652ms	627ms	-25ms	-0.89	-4%

Greptile Summary

This pull request makes a minor but important change to ensure the .gitignore file updated by the Storybook CLI ends with a newline character, aligning with POSIX standards for text files.

• Modified code/lib/create-storybook/src/initiate.ts to add a newline character when appending to .gitignore
• Ensures compatibility with POSIX standards for text files
• Improves consistency and prevents potential issues with git and other tools
• Simple change with minimal risk of unintended side effects
• Enhances the overall quality and standards compliance of the Storybook CLI

Footnotes

1. https://stackoverflow.com/questions/729692/why-should-text-files-end-with-a-newline ↩

[greptile-apps]

LGTM

_{1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings}

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9a059d9. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 1 target

• nx run-many -t build --parallel=3

---

Sent with 💌 from NxCloud.