Как разработчики, мы часто используем скрипты npm для автоматизации различных задач в наших проектах. Одной из мощных особенностей сценариев npm является возможность передавать в эти сценарии аргументы командной строки, что позволяет нам настраивать их поведение. В этой статье мы рассмотрим различные методы работы с аргументами командной строки в сценариях npm, используя разговорный язык и попутно предоставляя примеры кода.

Метод 1: использование процесса.argv
Самый простой способ получить доступ к аргументам командной строки в сценарии npm — использовать массив process.argv. Каждый аргумент, передаваемый в командной строке, доступен как элемент этого массива. Например, рассмотрим следующий скрипт в файле package.json:

"scripts": {
  "myScript": "node myScript.js"
}

Чтобы передать аргументы в myScript, вы можете изменить скрипт следующим образом:

"myScript": "node myScript.js --arg1 value1 --arg2 value2"

В пределах myScript.jsвы можете получить доступ к аргументам следующим образом:

const arg1 = process.argv[2];
const arg2 = process.argv[4];
console.log(arg1, arg2);

В результате будет получено --arg1 value1 --arg2 value2.

Метод 2: использование yargs
Пакет yargsобеспечивает более гибкий и удобный способ работы с аргументами командной строки. Он позволяет вам определять ожидаемые аргументы и их типы, а также предоставляет полезные функции, такие как синтаксический анализ и проверка. Чтобы использовать yargs, выполните следующие действия:

Шаг 1. Установите пакет yargs:

npm install yargs

Шаг 2. Измените сценарий в package.json:

"scripts": {
  "myScript": "node myScript.js"
}

Шаг 3. Обновите myScript.js, чтобы использовать yargs:

const argv = require('yargs').argv;
console.log(argv.arg1, argv.arg2);

Теперь вы можете передавать аргументы myScriptследующим образом:

npm run myScript -- --arg1 value1 --arg2 value2

В результате будет получено value1 value2.

Метод 3: использование перекрестного окружения
Если вам нужно передать переменные среды в качестве аргументов командной строки, вы можете использовать пакет cross-env. Он позволяет вам устанавливать переменные среды, к которым можно получить доступ в вашем скрипте npm. Чтобы использовать cross-env, выполните следующие действия:

Шаг 1. Установите пакет cross-env:

npm install cross-env

Шаг 2. Измените сценарий в package.json:

"scripts": {
  "myScript": "cross-env ARG1=value1 ARG2=value2 node myScript.js"
}

Шаг 3. Получите доступ к переменным среды в myScript.js:

const arg1 = process.env.ARG1;
const arg2 = process.env.ARG2;
console.log(arg1, arg2);

Теперь, когда вы запустите npm run myScript, значения ARG1и ARG2будут переданы в качестве аргументов в myScript.js.

В этой статье мы рассмотрели несколько методов работы с аргументами командной строки в сценариях npm. Мы научились использовать process.argvдля базового получения аргументов, yargsдля расширенного анализа аргументов и cross-envдля передачи переменных среды в качестве аргументов. Вооружившись этими методами, вы теперь можете настраивать поведение своих сценариев npm на основе входных данных командной строки, что делает рабочий процесс разработки более эффективным и гибким.