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

Stop publishing the test directory #415

Open
fvictorio opened this issue Feb 27, 2023 · 3 comments
Open

Stop publishing the test directory #415

fvictorio opened this issue Feb 27, 2023 · 3 comments

Comments

@fvictorio
Copy link
Contributor

The files array in the package.json includes the test directory, but this is not necessary according to @pfmescher's research (see this comment).

It's very likely that just removing the directory from files is enough, but we should validate that this doesn't break anything. The easiest way to do that is to remove the directory from files, then use npm pack to create a package, and then install the created .tgz in a real project and verify that it works.

@dbale-altoros
Copy link
Collaborator

dbale-altoros commented Mar 6, 2023

Removing the files keyword in the package.json is no good
I made an npm pack without the file keyword in the package.json and installed such pack in a fresh project...
The test folder is no longer in the package, but when I try to make solhint --init I get MODULE NOT FOUND for each rule having a /test/fixture/.... something.js
Seems we need to split test from documentation or leave it as it is

@pfmescher @fvictorio

@fvictorio
Copy link
Contributor Author

I see. Yes, we should probably move all those fixtures to an examples directory outside the test directory, and include that in files instead of test. Low priority though.

@dbale-altoros
Copy link
Collaborator

agree

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

No branches or pull requests

2 participants