I have an npm script, which is run like that:
npm run start:local -- -target.location https://192.1.1.1:8052/
The URL param is the local IP of a user.
What I would love to have is to ask users to input this value, because it's different for everybody.
Is it possible? Would be great to do it with vanila npm scripts.
Simply speaking, an npm script will run the desired command in your shell environment.
In a shell script, the arguments passed can be accessed using $N where N = Position of the argument.
Talking about your case, the command you want to run is
npm run start:local -- -target.location USER_INPUT
USER_INPUT needs to replaced with the argument that the user has passed. Assuming that the user will pass location as the first argument to the script, it can be accessed using $1.
I have created this gist to demonstrate the same.
As you can clearly see, I have defined start:local to access the first argument and then, pass it to the start script which then echoes out the passed in argument.
UPDATE:
Here is the script for ASKING a value from a user in a prompt format.
Basically, first I am asking for user input then, storing the same in a variable and passing the variable as an argument to npm start
stdin. But, I believe your question was regarding the concern with windows user. In that case, I recommend running all the npm scripts in a bash environment accessible using git-bash.Use readline to get the ip value then use exec to spawn this process. This is a pure JS solution, and OS agnostic.
Example:
"scripts": {
"start": "npm run start:local -- -target.location",
"prompt": "node prompt.js"
},
const { spawn, execSync } = require('child_process');
const exec = commands => {
execSync(commands, { stdio: 'inherit', shell: true });
};
const spawnProcess = commands => {
spawn(commands, { stdio: 'inherit', shell: true });
};
const readline = require('readline');
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout
});
rl.question('What is your current ip? example: https://192.168.1.10:9009 ', (ip) => {
console.log(`Starting server on: ${ip}`);
exec(`npm run start -- ${ip}`);
rl.close();
});
Example: If we want to run below three commands in sequence with userinput
git add .
git commit -m "With git commit message at run time"
git push
Add below command in your package.json file under the scripts
"gitPush": "git add . && echo 'Enter Commit Message' && read message && git commit -m \"$message\" && git push"
And run commands via npm run gitPush
References: ask-users-to-input-value-for-npm-script
If you're trying to ask for users to input ther response you could do something like this.
const readline = require("readline");
const reader = readline.createInterface({
input: process.stdin,
output: process.stdout,
error: process.stderr
});
const ask = (message, default_value = null) => new Promise(resolve => {
reader.question(message, (response)=>{
return resolve(response.length >= 1 ? response : default_value);
});
});
(()=>{
let ip = await ask(`Please enter your public ip: `);
})();
I think the above answers are good, but if you just need a little bit of data from the user they seem like overkill. For simple user input you might try the following and avoid additional files or third party libraries.
{
"step1": "#!/usr/bin/env bash \n read -p \"What is your name? \" name \n npm run step2 $name",
"step2": "echo Hello, $1",
}
Here is an example of how you might use it to start a http server on a user specified port:
{
"http1": "#!/usr/bin/env bash \n read -p \"What port do you want to use? \" port \n npm run http2 $port",
"http2": "http-server . -p $1",
}
For a slightly more complex example you might use npm-run-all. For example this will have the user type a specific string before continuing.
{
"reset": "run-s --print-label reset:*",
"reset:confirm": "#!/usr/bin/env bash \n set -e \n read -p \"Are you sure you want to reset everything? Type YES to continue : \" confirm \n if \n [ \"$confirm\" != \"YES\" ] ; then \n exit 1 \n fi",
"reset:db": "..."
}
package.jsonfile?