Skip to content
This repository has been archived by the owner on Aug 5, 2021. It is now read-only.

As a developer I would like documentation for publishing a component to npm #47

Open
1 of 6 tasks
thescientist13 opened this issue Aug 16, 2018 · 2 comments
Open
1 of 6 tasks
Labels
documentation Documentation for the wiki help wanted Extra attention is needed
Milestone

Comments

@thescientist13
Copy link
Member

Type of Change

  • New Feature Request
  • Documentation
  • Future Spec
  • Improvement / Suggestion
  • Bug
  • Other (please clarify below)

Summary

Some documentation on how to publish a reusable component to npm. Topics to cover:

  • files array in package.json (whitelisting what is published)
  • npm pack
  • how to bundle assets
  • good documentation is important!

Use Case

Developers looking to publish reusable components.

Code Sample

N / A

Pros / Cons

No cons, other than the usual risk with documentation that it can get out dated easily.

@thescientist13 thescientist13 added help wanted Extra attention is needed documentation Documentation for the wiki labels Aug 16, 2018
@thescientist13 thescientist13 added this to the Beta milestone Aug 16, 2018
@thescientist13
Copy link
Member Author

this project from @hutchgrant has been working on some good documentation
https://github.com/hutchgrant/evergreen-web-components

@hutchgrant
Copy link
Member

npmjs.org has excellent documentation as well.

Creating a new account
About two factor auth
Configure two factor auth
Logging in to npm
Changing package version
Creating and publishing unscoped packages

I also think docs for publishing multiple components at once via lerna, as described in the link cited in (#47 (comment)) would be helpful.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation for the wiki help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants