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

comment out empty interfaces #4077

Merged
merged 4 commits into from
Feb 23, 2022
Merged

Conversation

ignatiusmb
Copy link
Member

Following TS approach when generating a tsconfig.json, it starts out with all the options commented out with some brief description besides and above it. Since this is just an interface, having a link that points to the docs that explains everything should be enough. Having some brief descriptions would be redundant with the docs and may lead to out-of-sync details later on.

Fixes #3839

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 pnpx changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Feb 23, 2022

🦋 Changeset detected

Latest commit: 72c5644

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

@Rich-Harris Rich-Harris merged commit 74b0e56 into master Feb 23, 2022
@Rich-Harris Rich-Harris deleted the fix-3839/comment-out-empty-interfaces branch February 23, 2022 14:41
@ignatiusmb
Copy link
Member Author

Ah @Rich-Harris, I probably should've commented earlier on that additional //. I committed it separately in 9d94d44 because it would collapse itself since it's become an empty namespace, and forcing a space between would fail on lint.

@baseballyama baseballyama mentioned this pull request Feb 23, 2022
5 tasks
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.

"An empty interface is equivalent to {}" lint error on new empty project
2 participants