How to Publish Your First NPM Package: A Beginner's Tutorial

UpdatedOctober 1, 2024

•3 min read•View as Markdown

How to Publish Your First NPM Package: A Beginner's Tutorial

Pratham Agrawal

Comments

Join the discussion

No comments yet. Be the first to comment.

More from this blog

SEO With NextJs

In the dynamic world of web development, ensuring your website stands out to search engines is as crucial as the development itself. Next.js, a React framework, offers powerful features for building highly performive and SEO-friendly websites. Here, ...

Jul 28, 20244 min read

Streamlining Web Development with Powerful Tools from Google I/O Connect

The recent Google I/O Connect event in Bangalore was a treasure trove of exciting announcements for web developers. With a focus on streamlining workflows and empowering developers to build more feature-rich applications, the event showcased a range ...

Jul 17, 20242 min read

Streamlining Web Development with Powerful Tools from Google I/O Connect

Pratham Agrawal's Blog

3 posts

Initializing the Package

Run the following command to initialize a new NPM package:

 npm init

Follow the prompts to fill in the required information:

package name: The name of your package (e.g., my-package).
version: The initial version of your package (e.g., 1.0.0).
description: A brief description of your package.
entry point: The main file of your package (e.g., index.js).
test command: The command to run your tests (e.g., npm test).
git repository: The URL of your GitHub repository (optional).
keywords: Keywords related to your package (e.g., javascript, utility).
author: Your name and email address.
license: The license under which your package is released (e.g., MIT).

Testing the Package

Create a new file called test.js in the root of your package directory:


 touch test.js

Open the test.js file in your code editor and add the following code:

 const greet = require('./index');

 describe('greet', () => { it('should print a greeting message', () => { const message = 'Hello, John!'; console.log = jest.fn(); greet('John'); expect(console.log).toHaveBeenCalledWith(message); }); });

Save the file.

Publishing the Package

Create an NPM account if you haven't already.

Run the following command to login to your NPM account:

 npm login

Follow the prompts to enter your NPM username, password, and email address.

Run the following command to publish your package:

 npm publish

Follow the prompts to confirm that you want to publish your package.

Example Use Case

To use your newly published package in another project, run the following command:

npm install my-package

Then, in your JavaScript file, import and use the package:

const greet = require('my-package'); greet('John'); // Output: Hello, John!

That's it! You've successfully created and published an NPM package.

How to Publish Your First NPM Package: A Beginner's Tutorial

Comments

More from this blog

SEO With NextJs

Streamlining Web Development with Powerful Tools from Google I/O Connect

Prerequisites

Creating a New NPM Package

Initializing the Package

Writing the Package Code

Testing the Package

Building the Package

Publishing the Package

Updating the Package

Example Use Case

Command Palette

Comments

More from this blog

Prerequisites

Creating a New NPM Package

Initializing the Package

Writing the Package Code

Testing the Package

Building the Package

Publishing the Package

Updating the Package

Example Use Case