Создайте свой собственный инструмент для создания лесов в йоменском стиле с Caporal.js

Внутри экспортируемой функции первое, что мы собираемся добавить, это некоторые переменные:

 const variant = options.variant || 'default'; const templatePath = `${__dirname}/../templates/${args.template}/${variant}`; const localPath = process.cwd(); 

Как видите, мы берем параметр варианта, переданный команде scaffold и устанавливаем его в 'default' если этот параметр был опущен. Переменная templatePath содержит полный путь для указанного шаблона, а localPath содержит ссылку на каталог, в котором была выполнена команда.

Копирование файлов шаблона

Процесс копирования файлов очень прост с использованием функции cp из shellJS . Ниже переменных, которые мы только что включили, добавьте следующее:

 if (fs.existsSync(templatePath)) { logger.info('Copying files…'); shell.cp('-R', `${templatePath}/*`, localPath); logger.info(' The files have been copied!'); } else { logger.error(`The requested template for ${args.template} wasn't found.`) process.exit(1); } 

Во-первых, мы убедимся, что шаблон существует, в противном случае мы выйдем из процесса с сообщением об ошибке, используя logger.error() из Caporal.js. Если шаблон существует, мы покажем уведомление с помощью logger.info() и скопируем файлы с помощью shell.cp() . Параметр -R указывает, что он должен копировать файлы рекурсивно из пути шаблона в путь, где выполняется команда. Как только файлы скопированы, мы показываем подтверждающее сообщение. А поскольку функции shellJS являются синхронными, нам не нужно использовать обратные вызовы, обещания или что-то подобное — мы просто должны писать код процедурным способом.

Замена переменных

Хотя идея замены переменных в файлах звучит как сложная вещь, это довольно просто, если мы используем правильные инструменты. Одним из них является классический редактор sed из систем Unix, который может динамически преобразовывать текст. ShellJS предоставляет нам эту утилиту, которая будет работать как в системах Unix (Linux и MacOS), так и в Windows.

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

 const variables = require(`${templatePath}/_variables`); if (fs.existsSync(`${localPath}/_variables.js`)) { shell.rm(`${localPath}/_variables.js`); } logger.info('Please fill the following values…'); // Ask for variable values prompt.start().get(variables, (err, result) => { // Remove MIT License file if another is selected // Omit this code if you have used your own template if (result.license !== 'MIT') { shell.rm(`${localPath}/LICENSE`); } // Replace variable values in all files shell.ls('-Rl', '.').forEach(entry => { if (entry.isFile()) { // Replace '[VARIABLE]` with the corresponding variable value from the prompt variables.forEach(variable => { shell.sed('-i', `\\[${variable.toUpperCase()}\\]`, result[variable], entry.name); }); // Insert current year in files shell.sed('-i', '\\[YEAR\\]', new Date().getFullYear(), entry.name); } }); logger.info(' Success!'); }); 

Мы начнем с чтения, а variables устанавливаются на содержимое файла шаблона _variables.js который мы создали ранее.

Затем, поскольку мы скопировали все файлы из шаблона, первый оператор if удалит файл _variables.js из нашего локального каталога, поскольку он необходим только в самом CLI.

Значение каждой переменной получается с помощью инструмента подсказки , передавая массив переменных в функцию get() . Таким образом, CLI запросит у нас значение для каждого элемента в этом массиве и сохранит результат в объекте с именем result который передается в функцию обратного вызова. Этот объект содержит каждую переменную в качестве ключа и введенный текст в качестве значения.

Следующий оператор if необходим только в том случае, если вы используете включенные шаблоны в репозитории, поскольку мы также включаем файл LICENSE. Тем не менее, полезно посмотреть, как мы можем получить значение для каждой переменной, в данном случае из свойства license используя result.license . Если пользователь вводит лицензию, отличную от MIT , мы удаляем файл LICENSE из каталога, используя функцию ShellJS rm() .

Теперь перейдем к интересной части. Используя функцию ls из ShellJS, мы можем получить список всех файлов в текущем каталоге ( . ), Где мы собираемся заменить переменные. Мы передаем ему параметр -Rl , поэтому он становится рекурсивным и возвращает объект файла вместо имени файла.

Мы перебираем список файловых объектов, используя forEach() и для каждого проверяем, получаем ли мы файл, используя функцию isFile() . Если мы получаем каталог, мы ничего не делаем.

Затем для каждого файла, который мы получаем, мы перебираем все переменные и выполняем функцию sed следующим образом:

 shell.sed('-i', `\\[${variable.toUpperCase()}\\]`, result[variable], entry.name); 

Здесь мы передаем опцию -i которая позволяет нам заменить текст, затем передаем строку регулярного выражения, которая будет соответствовать идентификатору variable в верхнем регистре и заключена в квадратные скобки ( [ и ] ). Затем каждое совпадение этого регулярного выражения будет заменено значением соответствующей переменной ( result[variable] ), и, наконец, мы передаем имя файла, который мы заменяем, из функции forEach() ( entry.name ).

Второй sed совершенно необязателен. Это только для замены [YEAR] вхождений на текущий год. Полезно для файлов README.md или README.md .

Вот и все! Теперь мы можем выполнить нашу команду снова в пустой директории, чтобы увидеть, как она генерирует структуру проекта и заменяет все переменные новыми значениями:

 // To generate a Node.js MVC project scaffold create node --variant mvc // To generate a default Node.js project scaffold create node 

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

Если вы использовали шаблоны из репозитория (https://github.com/sitepoint-editors/node-scaffolding-tool
), чтобы следовать, вы также должны были сгенерировать рабочие проекты Node, которые можно запустить, запустив npm install затем npm start .

Что делать дальше

Мы успешно создали инструмент CLI для создания новых проектов Node.js из шаблонов, но нам не нужно останавливаться на этом. Поскольку мы создаем наш инструмент с нуля, у нас есть абсолютная свобода в том, что он может делать. В качестве вдохновения вы можете взять следующие идеи:

• Расширьте переменные, чтобы заменить блоки кода вместо простых слов; для этого вы можете использовать более сложные регулярные выражения и группы захвата в функции sed .
• Добавьте больше команд для создания определенных файлов для каждого вида проекта, например, новые модели для шаблона MVC.
• Включите команды для развертывания проекта на сервере, чего можно добиться с помощью библиотек для rsync и удаленных команд через SSH.
• Если у вас сложная настройка, вы также можете попробовать добавить команды для создания статических ресурсов или исходных файлов, что может быть полезно в случае статического сайта.
• Используйте функцию mv для переименования файлов из имен переменных.

Вывод

В этом руководстве я продемонстрировал, как мы можем создать интерфейс командной строки для быстрого запуска новых проектов в привычной среде. Но это не одноразовый проект — вы можете расширять его по мере необходимости. Создание автоматизированных инструментов — это то, что характеризует разработчиков. Если вы обнаружите, что выполняете повторяющиеся задачи, просто остановитесь и подумайте, сможете ли вы автоматизировать это. В большинстве случаев это возможно, и долгосрочная выгода может быть огромной.

Теперь это для тебя? Вы любите автоматизировать повторяющиеся и утомительные работы? Какой твой инструментарий по выбору? Позвольте мне знать в комментариях ниже.

Эта статья была рецензирована Джоан Инь , Камило Рейесом и Тимом Севериеном . Спасибо всем рецензентам SitePoint за то, что сделали контент SitePoint как можно лучше!