Node.js Publish Custom Module : Step-by-Step Guide

If tutorials available on this website are helpful for you, please whitelist this website in your ad blocker😭 or Donate to help us ❤️ pay for the web hosting to keep the website running.

Public Custom Package

Node.js एक popular JavaScript runtime है जो server-side development के लिए use होता है। JavaScript community में package management के लिए NPM (Node Package Manager) एक standard tool है।

अगर आपने कोई custom Node.js module develop किया है और उसे publicly share करना चाहते हैं, तो आप उसे NPM पर publish कर सकते हैं। इस blog में, हम step-by-step देखेंगे कि कैसे आप अपना custom Node.js module NPM पर publish कर सकते हैं।

Node.js Publish Custom Module

Step 1 : Setup NPM Account

सबसे पहले, आपको NPM पर एक account create करना होगा। अगर आपका NPM account पहले से है, तो आप इस step को skip कर सकते हैं।

• NPM Website पर जाएं और "Sign Up" पर click करें ।

• अपनी email, username, और password enter करें ।

• Email verification process को complete करें ।

अब आपका NPM account ready है!

Step 2 : Prepare Node.js Module

अपने custom module को NPM पर publish करने से पहले, आपको उसे local machine पर तैयार करना होगा।

mkdir my-custom-module
cd my-custom-module

Initialize project

npm init

यह command आपको कुछ questions पूछेगा, जैसे module का नाम, version, description, entry point (जैसे index.js), test command, git repository, keywords, author, और license. इन details को ध्यान से fill करें।

अब अपनी module functionality को code करें। एक simple example के लिए, index.js file create करें -

Copy
// index.js
function test_package(name) {
    return `Hello, ${name}!, welcome to learnhindituts.com`;
}

module.exports = test_package;

इस code को test करने के लिए एक separate file बनाएं -

Copy
// test.js
const test_package = require('./index');

console.log(test_package('User')); // Output: Hello, User! , welcome to learnhindituts.com

Step 3 : Login In NPM

अब आपको NPM में login करना होगा ताकि आप अपना module publish कर सकें।

npm login

यह command आपसे username, password, और email मांगेगा। सही credentials enter करें और login process complete करें।

Step 4 : Publish Module

अब आपका module publish करने के लिए ready है।

Copy
npm publish

यह command आपके custom module को NPM registry पर publish कर देगा। अगर सब कुछ सही है, तो आपको एक success message दिखाई देगा।

Step 5 : Update Version of Module

अगर आपको बाद में अपने module में कोई changes करने हैं, तो version number update करें और फिर से publish करें।

package.json में version number increment करें।

For example -

"version": "1.0.1"

Now publish

npm publish

●●●

Important Tips

• Versioning : हमेशा semantic versioning (MAJOR.MINOR.PATCH) का पालन करें।

• Readme : एक अच्छा README.md file create करें जो users को बताए कि आपका module क्या करता है और इसे कैसे use करें।

• License : सुनिश्चित करें कि आपने  package.json में सही license information दी है।

●●●

Conclusion

आपने सीखा कि कैसे एक custom Node.js module को NPM पर publish किया जा सकता है। इस process में NPM account creation, module preparation, और publish steps शामिल थे।

अब आप अपने modules को दुनिया के साथ share कर सकते हैं और open-source community में contribute कर सकते हैं।