Основы Gatsby CLI: шпаргалка по командам

Development | Amber | Комментировать запись

Работая с Gatsby.js, мы постоянно используем его встроенный интерфейс командной строки (сокращенно CLI). Этот важный инструмент позволяет нам выполнять множество необходимых операций, в том числе создавать новые проекты из стартеров, запускать сервер разработки с горячей перезагрузкой и собирать проекты.

Данный материал представляет собой краткое справочное руководство, которое поможет вам использовать Gatsby CLI.

Читайте также: Gatsby v2: с чего начать работу?

Установка Gatsby CLI

Если вы еще не установили gatsby-cli глобально, вам необходимо сделать это сейчас:

npm install -g gatsby-cli

Теперь, когда у вас есть глобальная копия gatsby-cli, вы можете запускать все команды Gatsby из любого расположения на вашем компьютере. Давайте приступим к изучению команд

Создание нового проекта

Команда new создает новый сайт Gatsby, устанавливает все его зависимости и локально инициализирует новый репозиторий git с помощью начального коммита.

Запуск команды без аргументов запросит имя папки и (опционально) стартер:

gatsby new

Для этой команды доступны аргументы:

• site directory: указывает каталог установки (опционально).
• starter: может содержать URL-адрес репозитория или имя пользователя/репозиторий на Github (опционально). Если этот параметр не установлен, команда автоматически использует gatsby-starter-default.

Вот пример, который устанавливает сайт в папку my-site и в качестве стартера использует gatsby-starter-blog:

gatsby new my-site gatsbyjs/gatsby-starter-blog

Локальный сервер разработки

Команда develop запускает локальный сервер разработки с горячей перезагрузкой.

gatsby develop

Доступные опции:

• -H, –host: устанавливает URL/IP хоста. По умолчанию используется значение localhost.
• -p, –port: устанавливает порт приложения. По умолчанию используется порт 8000.
• -o, –open: автоматически открывает сайт в браузере по умолчанию.
• -S, –https: включает HTTPS (более подробную информацию можно найти здесь).

Вот еще один пример этой команды, который выполняется по адресу http://0.0.0.0:8888 и автоматически открывается в браузере:

gatsby develop -H 0.0.0.0 -p 8888 -o

Производственная сборка сайта

Команда build компилирует сайт для развертывания в производственной среде.

gatsby build

• -prefix-paths: собирает сайт с префиксом пути (но работает, только если вы установили pathPrefix в конфигурации Gatsby).
• -no-uglify: выполняет сборку без искажения JavaScript (полезно для отладки).
• -open-tracing-config-file: устанавливает конфигурационный файл трассировщика для инструмента OpenTracing(подробнее об этом можно узнать на сайте Gatsby).

Например, такая команда сгенерирует сборку с префиксом пути и отключенным искажением:

gatsby build -prefix-paths -no-uglify

Локальное обслуживание производственных сборок

Команда serve локально запускает производственные сборки, что может быть полезно для тестирования и отладки. Примечание: Конечно, сначала нужно выполнить саму сборку, то есть запустить команду build.

gatsby serve

Для этой команды доступны такие опции:

• -H, –host: адрес хоста (по умолчанию localhost).
• -p, –port: установить порт приложения (по умолчанию это 9000).
• -o, –open: автоматически открывает сайт в вашем браузере по умолчанию.
• -prefix-paths: обслуживает сайт с префиксом пути, если вы установили значение pathPrefix в конфигурации Gatsby.

Данная команда будет обслуживать производственную сборку по адресу http://10.0.0.1:9999 с префиксом и автоматически откроет сайт в браузере:

gatsby serve -H 10.0.0.1 -p 9999 -prefix-paths -o

Сбор информации о среде

Команда info отображает информацию о среде вашего проекта Gatsby.

gatsby info

Она поддерживает опцию -C (–clipboard), которая автоматически копирует информацию в буфер обмена.

Данная команда возвращает объект, включающий вашу ОС, тип процессора, версии Yarn/npm, установленные языки, браузеры и пакеты npm.

Примечание: Эта информация требуется при отправке официального отчета об ошибке в Gatsby.

Удаление устаревшего кэша/сборок

Команда clean удаляет каталоги .cache и public из корневого каталога проекта.

gatsby clean

Хотя эту команду вы, вероятно, будете использовать довольно редко, все же о ней полезно знать. Иногда с кешированием возникают странные проблемы, и эта команда предлагает быстрый и безопасный способ их устранения: легче ввести два слова, чем две отдельные команды для удаления папки, кроме того, нет риска случайно удалить не ту папку.

REPL-доступ

Команда repl открывает доступ к интерактивной оболочке REPL (Read-Eval-Print-Loop) Gatsby.

Все преимущества этой команды невозможно описать в рамках краткой справочной статьи, но вы можете найти полную информацию о ней в документации Gatsby.

Заключение

Это краткое руководство поможет вам быстро сориентироваться в интерфейсе командной строки Gatsby. Это важно, потому что этот инструмент очень часто используется в разработке проектов Gatsby

При необходимости также рекомендуем вам проконсультироваться со следующими источниками:

• Страница Gatsby CLI в официальной документации.
• Репозиторий gatsby-cli на Github поможет вам следить за обновлениями.
• Разработчики Gatsby тоже написали шпаргалку, в которую входят наиболее часто используемые команды CLI.