Sending Command Line Arguments to NPM Script
Last Updated :
28 Mar, 2024
In the sector of NodeJS development, NPM (Node Package Manager) scripts are a effective tool for automating numerous tasks like strolling exams, building the mission, or starting a improvement server. However, there are times while you need to bypass arguments to these scripts to customize their behavior. This article will discover how you can ship command line arguments to NPM scripts.
We will discuss the following methods to send command line arguments to NPM Script:
Using process.argv()
1. Sending a single argument to an NPM script
Explanation: In this code we're executing an NPM script named "hello" that's described inside the package.json file. By running NPM run hello and passing the argument -- --name=John through the command line, the script script.js accesses this argument and outputs a greeting message. It prints "Hello, John!" which indicate that argument which was send has successfull.
Note: Install the minimist package for using this approach
$ npm i minimist
CODE
// package.json
{
"scripts": {
"hello": "node script.js"
}
}
Terminal
$ npm run hello -- --name=John
JavaScript
// script.js
const args = require('minimist')(process.argv.slice(2));
const name = args['name'];
console.log(`Hello ${name}!`);
Output:
Hello, John!
2. Sending multiple arguments to an npm script:
Explanation: We're running an npm script referred to as "greet", passing multiple arguments through the command line the usage of --. The script greet.Js processes those arguments and outputs a greeting message accordingly. In this situation, it prints "Hello, John!" because we provided the name "John" and the greeting "Hello" as arguments.
Note: Install the minimist package for using this approach
$ npm i minimist
CODE
// package.json
{
"scripts": {
"greet": "node greet.js"
}
}
Terminal
$ npm run greet -- --name=John --greeting=Hello
JavaScript
// greet.js
const args = require('minimist')(process.argv.slice(2));
const name = args['name'];
const greeting = args['greeting'];
console.log(`${greeting}, ${name}!`);
Output:
Hello, John!
Using npm_config_ Method
1. Sending a single argument to an npm script:
Explanation: In this code we are running an npm script named "hello" defined in package.json. using NPM run hello, followed by --name="Jane" in the terminal, we have passed a single argument to the script script.js. The script then uses this argument to output a greeting message "Hello Jane !".
CODE
// package.json
{
"scripts": {
"hello": "node script.js"
}
}
Terminal
$ npm run hello --name="Jane"
JavaScript
const nname = process.env.npm_config_name ? process.env.npm_config_name : "John"
console.log("Hello", nname, "!")
2. Sending multiple arguments to an npm script:
Explanation: in this code we are excuting an npm script named "greet" specified in package.json. By running npm run hello, followed by --firstName="Jason" --lastName="Roy" in the command line, we are passing multiple arguments to the script greet.js. The script accesses these arguments and generates a greeting message accordingly. In this case, it's output is "Hello Jason Roy"
CODE
// package.json
{
"scripts": {
"hello": "node script.js"
}
}
Terminal:
$ npm run hello --firstName="Jason" --lastName="Roy"
JavaScript
const firstName = process.env.npm_config_firstName ?
process.env.npm_config_firstName : "John"
const lastName = process.env.npm_config_lastName ?
process.env.npm_config_lastName : "Doe"
console.log("Hello", firstName, lastName)
Similar Reads
Non-linear Components
In electrical circuits, Non-linear Components are electronic devices that need an external power source to operate actively. Non-Linear Components are those that are changed with respect to the voltage and current. Elements that do not follow ohm's law are called Non-linear Components. Non-linear Co
11 min read
JavaScript Tutorial
JavaScript is a programming language used to create dynamic content for websites. It is a lightweight, cross-platform, and single-threaded programming language. JavaScript is an interpreted language that executes code line by line, providing more flexibility.JavaScript on Client Side : On client sid
11 min read
Web Development
Web development is the process of creating, building, and maintaining websites and web applications. It involves everything from web design to programming and database management. Web development is generally divided into three core areas: Frontend Development, Backend Development, and Full Stack De
5 min read
Class Diagram | Unified Modeling Language (UML)
A UML class diagram is a visual tool that represents the structure of a system by showing its classes, attributes, methods, and the relationships between them. It helps everyone involved in a projectâlike developers and designersâunderstand how the system is organized and how its components interact
12 min read
Spring Boot Tutorial
Spring Boot is a Java framework that makes it easier to create and run Java applications. It simplifies the configuration and setup process, allowing developers to focus more on writing code for their applications. This Spring Boot Tutorial is a comprehensive guide that covers both basic and advance
10 min read
React Interview Questions and Answers
React is an efficient, flexible, and open-source JavaScript library that allows developers to create simple, fast, and scalable web applications. Jordan Walke, a software engineer who was working for Facebook, created React. Developers with a JavaScript background can easily develop web applications
15+ min read
HTML Tutorial
HTML stands for HyperText Markup Language. It is the standard language used to create and structure content on the web. It tells the web browser how to display text, links, images, and other forms of multimedia on a webpage. HTML sets up the basic structure of a website, and then CSS and JavaScript
10 min read
JavaScript Interview Questions and Answers
JavaScript (JS) is the most popular lightweight, scripting, and interpreted programming language. JavaScript is well-known as a scripting language for web pages, mobile apps, web servers, and many other platforms. Both front-end and back-end developers need to have a strong command of JavaScript, as
15+ min read
Backpropagation in Neural Network
Back Propagation is also known as "Backward Propagation of Errors" is a method used to train neural network . Its goal is to reduce the difference between the modelâs predicted output and the actual output by adjusting the weights and biases in the network.It works iteratively to adjust weights and
9 min read
React Tutorial
React is a JavaScript Library known for front-end development (or user interface). It is popular due to its component-based architecture, Single Page Applications (SPAs), and Virtual DOM for building web applications that are fast, efficient, and scalable.Applications are built using reusable compon
8 min read