This guide has the following sections : Structuring your code for npm 📑 File Structure for the module 📁 Publishing and using your module 💻 Note : This guide assumes that you have node and npm installed. I will be using module and package interchangeably to refer to your npm module.😄 1. Structuring your code for npm 📑 npm modules are pieces of code which can be included into your Node.js program by using require(). As far as you the author are concerned, they are seperate Node.js programs on your file system, which export some function for other programs to use. Consider your boilerplate JS : const dependency = require(‘dependency-name’);//list all requires required by your npm module function yourFunction(args) {// operationsreturn result;} You convert this code to an npm module by simply placing your function into a variable. In the following example, I will be placing the function in to export it as a variable : module.exports const const dependency = require('dependency-name');//list all requires required by your npm module const yourFunction = (args) => {//operationsreturn result;} module.exports = yourFunction; That’s it for the coding part ! 🎉 2. File Structure for the module 📁 Create a new project folder with the name which you want to give your module and cd into it : mkdir module-namecd module-name Place your newly created js file in this folder and rename it to your module name as module-name.js 2. Use and give answers to the questionnaire like package-name,version,etc. This creates a package.json file with your provided information. npm init Finally, populate your package.json with the following fields to make your module SEO-friendly. Note : Here the 'main' field is important as it is the entry point of your module 3. Publishing and using your module 💻 Go to and create an account. npmjs.com Run and enter your username and password. npm login Now enter to have your code published to the NPM database. Go to to view your package npm publish npmjs.com/your-package-name If you want to update your package, simply change the ‘package-version’ in your package.json and run again. npm publish To use your published module in any of your Node.js programs, simply install it using npm i your-package-name --save And finally, use your module by including it in your code via and then use your function directly. 😄 require() const dependency = require('your-package-name') const desired_result = dependency(args) Get in touch !! : Github NPM LinkedIn Twitter

Twitter

Converting Your JS Boiler-Plate into NPM Modules : The Definitive Guide

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Alligator Energy & The Benefits of Working Slowly

The Noonification: Reduce Javascript: Master the Basics (1/11/2023)

The Noonification: Satoshi Might Be a Bitcoin ETF Skeptic (1/13/2024)

The Noonification: Small Puddle of Freedom (11/25/2022)

The Noonification: How to Use AI for Your B2B Marketing (11/11/2022)

105 Stories To Learn About Functional Programming

Alligator Energy & The Benefits of Working Slowly

The Noonification: Reduce Javascript: Master the Basics (1/11/2023)

The Noonification: Satoshi Might Be a Bitcoin ETF Skeptic (1/13/2024)

The Noonification: Small Puddle of Freedom (11/25/2022)

The Noonification: How to Use AI for Your B2B Marketing (11/11/2022)

105 Stories To Learn About Functional Programming

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps