Command line interface to send parameter value to npm script

Question

Command line interface to send parameter value to npm script

I am working on a typescript project and I have an npm script defined in my package.json file as follows:

"test:add": "cross-env some-static-var=value npm run some-command"

Now, I need to pass a variable value when I run this script from the command line interface (CLI). I just want to be able to pass a value, even if no specific variable name is provided in the CLI. Essentially, I would like to run the script like this:

npm run test:add --additionalValue

I am struggling to figure out how to pass and access this value from the CLI. I have tried various methods such as checking process.env, process.argv, and process.arg0 but none of them seem to contain the value "additionalValue." Can someone please help me with this issue?

typescript npm command-line-interface

Answer 1

Answer №1

It appears you are on the right track, here is a basic example of how to implement that function.

The package.json file contains this script:

"scripts": {
    "helloWorld": "node hello-world.js"
  },

The contents of hello-world.js would be as follows:

const arg = process.env.npm_config_hello || "";

console.log(arg);

To execute the command using npm, use the following syntax:

npm run helloWorld --hello="Hello World!"

This will result in the output being displayed as Hello World!

For a demonstration, you can view this sandbox: https://codesandbox.io/p/devbox/cg2sg8

Answer 2

It appears you are on the right track, here is a basic example of how to implement that function.

The package.json file contains this script:

"scripts": {
    "helloWorld": "node hello-world.js"
  },

The contents of hello-world.js would be as follows:

const arg = process.env.npm_config_hello || "";

console.log(arg);

To execute the command using npm, use the following syntax:

npm run helloWorld --hello="Hello World!"

This will result in the output being displayed as Hello World!

For a demonstration, you can view this sandbox: https://codesandbox.io/p/devbox/cg2sg8

Command line interface to send parameter value to npm script

Answer №1

Similar questions

Utilize CircleCI for seamless automated publishing of packages to NPM

Differences Between Angular 2 Reactive Forms and Template Forms

Which TypeScript data type is most appropriate for referencing the match object within my props?

Converting a JSON array stored in a local file to a TypeScript array within an Angular 5 project

Beginning the React Script

Warning: Unsupported engine for version 10.0.0 of [email protected] - required engine is {"node":">=10.0.0"}

Add a class to a button in an Angular btn-group if a specific string is found within an

The Freemode feature in SwiperJS is not functioning properly when used with React TypeScript

Error encountered while trying to execute Node.js project - npm error code EBADPLATFORM

Angular routing is showing an undefined ID from the snapshot

Retrieve the service variable in the routing file

Loop through a collection of elements of a certain kind and selectively transfer only certain items to a different collection of a different kind

What is the best way to implement switchMap when dealing with a login form submission?

Adding a line break ( ) in a paragraph within a TypeScript file and then transferring it to HTML does not seem to be functioning properly

Is it recommended for the main, module, and browser properties in package.json to reference the minified version or the source

What steps do I need to take to implement Dispatch in a React Native project?

Is there a way to adjust the dimensions of my Angular npm slider?

Struggling to comprehend the node.js walker concept

"Can someone point me to the location of $(System.DefaultWorkingDirectory) within an Azure DevOps

Converting an array of object values to an Interface type in Typescript