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

Ensure .gitignore updated via CLI ends with a newline #29124

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

3w36zj6
Copy link

@3w36zj6 3w36zj6 commented Sep 13, 2024

What I did

POSIX defines that text files should end with a newline1. 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>

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

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant