@foxford/cli

Описание

Фоксовый CLI клиент

Использование

npx fox

Оптимизация

Команда optimize позволит вам прогнать оптимизацию для jpg png mp4 файлов

:::info[Заметочка] Для оптимизации картинок используется сервис https://tinypng.com/

Авторизовавшись в сервисе вы можете в профиле получить ключ на 500 оптимизаций в месяц бесплатно. :::

Для того, чтобы оптимизация работала успешно необходимо в свое окружение (.bashrc .zshrc) добавить env переменную

export TINIFY_API_KEY=ВАШ_КЛЮЧ

После чего можно прогнать команду натравив на ваши ресурсы (поддерживается blob)

npx fox optimize ./src/packages/navigation/**/*.png --list

Ваши ресурсы будут оптимизированы и по завершению будет предоставлена сводная таблица

Плагины

Fox-cli может быть расширен плагинами. Плагин - это пакет, который установлен в проекте и имеет в своем package.json в секции keywords значение foxford-cli-plugin

Пример:

{
  "name": "@foxford/cli-analyze-plugin",
  "version": "1.0.0",
  "description": "Package cli-analyze-plugin",
  "keywords": [
    "foxford-cli-plugin"
  ],
  "license": "MIT",
  "exports": {
    ".": {
      "import": "./dist/index.mjs",
      "types": "./dist/index.d.ts",
      "default": "./dist/index.js"
    }
  },
  "dependencies": {
    "commander": "13.1.0"
  }
}

К примеру исходный код точки входа плагина

import { Command } from 'commander'
import type { Program } from 'commander'

export default function (program: Program) {
  const command = new Command()

  const contextifyCommand = new Command('awesome')
    .description('Инструмент')
    .requiredOption('-p, --param <path>', 'Мой параметр')
    .action((options) => {
      const { param } = options
      // код экшена
    })

  program.addCommand(contextifyCommand)
}

После установки плагина команда CLI автоматически зарегистрирует вашу команду и она станет доступна для выполнения:

npx fox awesome -p TEST