#PACKAGE.JSON UNPKG INSTALL#
#PACKAGE.JSON UNPKG CODE#

Just set 'main' to the esm file in package.json, right? But then all users who are using my packages in Node apps will not be able to use it anymore. There is currently a bug in Rollup where it will not properly show JSDoc comments when coding after having imported a cjs file, but it does work when importing a es file. What is the 'module' package.json field for? Why do I want to be able to import the 'module' file instead of the 'main' file:

See further information on this Stackoverflow thread: Lots of famous libraries like Vue.js are already doing this. Why I define a separate 'module' in package.json: That's why I chose cjs for the 'main' path in package.json. I have some simple helper JS functions like this and this, and I would want them to be usable to the widest audience. I noticed that using Node, importing an esm file is not possible because of export default, it has to be commonJS. Is there a way to import the module file instead when doing import myPackage from 'my-package' in a JavaScript file? Why I choose the commonJS file for 'main':

It will automatically choose the main file, not the module.

#PACKAGE.JSON UNPKG INSTALL#

When I npm install the package and I simple import it like: import myPackage from 'my-package' I set up my package.json like so: main: '', A sample package.I have created some npm modules and compile them to: We can address the most common use cases by specifying 2 additional versions ( module and unpkg), and provide access to the. The package.json file used by npm really only requires one version ( main), but as it turns out, we aren’t limited to that. How does npm know which version to serve to a browser/build process? It is likely your own package.json file will contain a lot more than is listed here. The file used in these examples was generated by hand, and will include the minimum configuration required for the discussion/task at hand. Throughout this document, references are made to the package.json file listed above. Properly packaging your SFC for distribution via npm enables your component to be shared in a way which is ready to use everywhere! Packaging Components for npmįor the purposes of this section, assume the following file structure: package.json However, this excludes anyone who wishes to use the component directly in a browser via tag, anyone who uses a runtime-only build, or build processes which don’t understand what to do with. vue file might be preferred in this scenario (see Packaging Components for npm > SSR Usage for details). Also, the SSR build uses string concatenation as an optimization, so the. vue files directly, and anyone using a Vue build containing the Vue compiler can consume it immediately. vue file directly? Isn’t that the simplest way to share components?” Because a Single File Component (SFC) is already just one file, you might ask:

#PACKAGE.JSON UNPKG CODE#

Vue already allows components to be written as a single file. If you aren't using a package manager for your project, but don't want to have to copy the code yourself, you can use unpkg. Not only does this help you avoid copy/pasting components around, but it also allows you to give back to the Vue community! Can’t I Just Share. Or even used via tag in the browser directly: But how can you write a component once and use it in multiple sites/applications? Perhaps the easiest solution is via npm.īy packaging your component to be shared via npm, it can be imported/required into a build process for use in full-fledged web applications: import M圜omponent from 'my-component' This is easy when the component is only used within a single application.

Vue components by nature are meant to be re-used. Packaging Vue Components for npm Base Example

Package.json unpkg