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(create): exclude tests in package.template.json #9584

Merged
merged 5 commits into from
Apr 5, 2023
Merged

fix(create): exclude tests in package.template.json #9584

merged 5 commits into from
Apr 5, 2023

Conversation

stordahl
Copy link
Contributor

@stordahl stordahl commented Apr 1, 2023

Apologies, there's no linked issue for this - I've just made this change in a ton of SK projects that use the lib skeleton template. IMO tests shouldn't be bundled in the distributed package. Curious if others here agree!

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:.

@changeset-bot
Copy link

changeset-bot bot commented Apr 1, 2023

🦋 Changeset detected

Latest commit: a49eb05

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 Minor

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

@benmccann
Copy link
Member

Without having used svelte-package myself, it seems strange to me that there would be tests in the dist folder. Can we prevent them from ending up there in the first place?

@stordahl
Copy link
Contributor Author

stordahl commented Apr 2, 2023

When building a component lib, I'll often have component tests colocated next to the component. Until svelte-package gets more advanced than just transpiling/copying lib to dist, this is the simplest solution IMO

@dummdidumm
Copy link
Member

The idea in general makes sense to me, I'm not sure about /**/tests though. There's a slight possibility that it's a false positive, and I've also seen people use test instead. The *.test.* (and probably also *.spec.*) have my approval.

@stordahl
Copy link
Contributor Author

stordahl commented Apr 2, 2023

@dummdidumm thought about this a bit and I agree! Updated my fork with that change

@dummdidumm
Copy link
Member

Looks good! Could you add a changeset? Then we're good to merge.

@benmccann
Copy link
Member

This seems okay, but I do wonder if it would be hard to fix svelte-package to not copy those files instead? That might be the better fix because then when you do ls dist you won't see a bunch of stuff that probably shouldn't be there

@dummdidumm
Copy link
Member

We did that in version 1 and decided against doing anything like this, instead relying on the files mechanism

Copy link
Member

@benmccann benmccann left a comment

Choose a reason for hiding this comment

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

I guess that's more easily user configurable

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.

3 participants