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

chore: overhaul ignore configs #11938

Merged
merged 12 commits into from
May 30, 2024
Merged

chore: overhaul ignore configs #11938

merged 12 commits into from
May 30, 2024

Conversation

hyunbinseo
Copy link
Contributor

This is a recreation of the following issue. Sorry for the inconvenience.

Notable Changes

  1. Follow the Vite's .env file conventions - only the *.local files are ignored by git.
  2. Clean-up of .eslintignore - removal of JSON, YAML, and env files from the list

Note

JSON and YAML files are not handled by ESLint - plugins have to be installed.

Additional Suggestions

.gitignore

  1. Merge different ignore files into one. Suggestion below:
  2. Remove .output and .vercel from the default ignore file.
/package
node_modules

# Output
/.svelte-kit
/build
/dist

# OS
.DS_Store
Thumbs.db

# Vite
.env.*.local
.env.local
vite.config.js.timestamp-*
vite.config.ts.timestamp-*

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Mar 6, 2024

🦋 Changeset detected

Latest commit: 85c15de

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
create-svelte Patch

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

@hyunbinseo
Copy link
Contributor Author

@benmccann your suggestions have been applied. What do you think about merging (unifying) the .gitignore files?

@benmccann
Copy link
Member

What do you think about merging (unifying) the .gitignore files?

I don't have a strong feeling one way or the other. I don't really understand why they're different at the moment

@@ -1,13 +1,12 @@
.DS_Store
/package
Copy link
Member

Choose a reason for hiding this comment

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

wouldn't this be considered "Output"?

I think if you changed the "Lockfiles" head to "Package managers" then you could put node_modules there too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wasn't certain about the /packages directory. When is it used? The package template uses the dist directory.

Copy link
Member

Choose a reason for hiding this comment

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

perhaps we don't need it anymore. it may be leftover. I think svelte-kit package used to output to that location

@hyunbinseo
Copy link
Contributor Author

@benmccann Feel free to make changes directly. I just want a cleanup of ignore files, and would love to reflect maintainers' opinions on this issue.

@benmccann benmccann merged commit c63b340 into sveltejs:main May 30, 2024
7 of 12 checks passed
@github-actions github-actions bot mentioned this pull request May 30, 2024
@hyunbinseo hyunbinseo deleted the patch-1 branch May 31, 2024 01:56
@hyunbinseo
Copy link
Contributor Author

@benmccann Appreciate it. Thank you!

@benmccann
Copy link
Member

Thank you!!

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.

2 participants