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

Don't publish examples on npm #303

Closed
vmx opened this issue Aug 20, 2018 · 3 comments · Fixed by #737
Closed

Don't publish examples on npm #303

vmx opened this issue Aug 20, 2018 · 3 comments · Fixed by #737
Assignees

Comments

@vmx
Copy link
Member

vmx commented Aug 20, 2018

What is the time sink?

js-ipfs was publising examples which lead to huge download size due to publishing the dist folders of the examples. It got fixed here.

How do you think it can be solved?

I guess all projects should exclude the examples. If we agree on this all projects should be checked if they actually do it. Perhaps syncing the .npmignore files across repos.

How important do you think this is to fix?

Not urgent.

@jacobheun
Copy link
Contributor

Should we look at just whitelisting our packages rather than dealing with the .npmignore blacklisting?

With most repos we'd be able to just add src and dist to the files property in package.json

"files": [
  "src",
  "dist"
]

The readme, license, changelog and package.json files will automatically be white listed. This would save us from random files that would be in peoples directories, such as editor files that .npmignore isn't covering. It's worth noting that .npmignore doesn't respect global git ignores.

@daviddias
Copy link
Member

This looks like something the JS folks can handle with a script to update them all and a lint rule that checks for it. Sounds good? @alanshaw @achingbrain @vasco-santos @hugomrdias @jacobheun

@alanshaw
Copy link
Member

alanshaw commented Dec 4, 2018

+1 on a script to update them.

I have some half baked ideas about aegir doctor for detecting (and potentially fixing) things in your project that stray from aegir "best practices". This could be one of those things, but also things like having npm scripts for testing and release.

Also aegir create my-project which would spit out a aegir enabled template for building your new project with all of the best practices built in.

cc @hugomrdias

@daviddias daviddias transferred this issue from ipfs-inactive/dev-team-enablement Dec 4, 2018
@hugomrdias hugomrdias self-assigned this Dec 4, 2018
hugomrdias added a commit that referenced this issue Dec 17, 2018
This PR adds package.json linting with npm-package-json-lint and config for it. 
Check this issue #303 for context  about these changes, not all issues are solve in this PR but still improves the current situation.

//cc @ipfs/javascript-team
@hugomrdias hugomrdias mentioned this issue Feb 23, 2021
3 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 a pull request may close this issue.

5 participants