API плагина для UI #

module.exports = api => {
  // Используйте API здесь...
}

api.describeConfig({
  // Уникальный ID для конфигурации
  id: 'org.vue.eslintrc',
  // Отображаемое имя
  name: 'Конфигурация ESLint',
  // Показывается под названием
  description: 'Проверка ошибок & качество кода',
  // Ссылка "More info"
  link: 'https://eslint.org'
})

api.describeConfig({
  /* ... */
  // Конфигурация иконки
  icon: 'application_settings'
})

api.describeConfig({
  /* ... */
  // Все возможные файлы для этой конфигурации
  files: {
    // eslintrc.js
    eslint: {
      js: ['.eslintrc.js'],
      json: ['.eslintrc', '.eslintrc.json'],
      // Будет читать из `package.json`
      package: 'eslintConfig'
    },
    // vue.config.js
    vue: {
      js: ['vue.config.js']
    }
  },
})

api.describeConfig({
  /* ... */
  onRead: ({ data, cwd }) => ({
    prompts: [
      // объекты подсказок
    ]
  })
})

module.exports = {
  lintOnSave: false
}

api.describeConfig({
  /* ... */
  // Все возможные файлы в этой конфигурации
  files: {
    // vue.config.js
    vue: {
      js: ['vue.config.js']
    }
  },
})

{
  // Файл
  vue: {
    // Данные файла
    lintOnSave: false
  }
}

module.exports = {
  root: true,
  extends: [
    'plugin:vue/essential',
    '@vue/standard'
  ]
}

api.describeConfig({
  /* ... */
  // Все возможные файлы в этой конфигурации
  files: {
    // eslintrc.js
    eslint: {
      js: ['.eslintrc.js'],
      json: ['.eslintrc', '.eslintrc.json'],
      // Будет читать из `package.json`
      package: 'eslintConfig'
    },
    // vue.config.js
    vue: {
      js: ['vue.config.js']
    }
  },
})

{
  eslint: {
    root: true,
    extends: [
      'plugin:vue/essential',
      '@vue/standard'
    ]
  },
  vue: {
    lintOnSave: false
  }
}

api.describeConfig({
  /* ... */
  onRead: ({ data, cwd }) => ({
    tabs: [
      {
        id: 'tab1',
        label: 'Моя вкладка',
        // Опционально
        icon: 'application_settings',
        prompts: [
          // Объекты подсказок
        ]
      },
      {
        id: 'tab2',
        label: 'Моя вторая вкладка',
        prompts: [
          // Объекты подсказок
        ]
      }
    ]
  })
})

api.describeConfig({
  /* ... */
  onWrite: ({ prompts, answers, data, files, cwd, api }) => {
    // ...
  }
})

{
  id: data.name,
  type: data.type,
  name: data.short || null,
  message: data.message,
  group: data.group || null,
  description: data.description || null,
  link: data.link || null,
  choices: null,
  visible: true,
  enabled: true,
  // Текущее значение (не фильтруется)
  value: null,
  // true если было изменено пользователем
  valueChanged: false,
  error: null,
  tabId: null,
  // Оригинальный объект подсказок inquirer
  raw: data
}

api.describeConfig({
  // ...

  onWrite: async ({ api, prompts }) => {
    // Обновление правил ESLint
    const result = {}
    for (const prompt of prompts) {
      result[`rules.${prompt.id}`] = await api.getAnswer(prompt.id, JSON.parse)
    }
    api.setData('eslint', result)
  }
})

api.describeTask({
  // RegExp выполняется по командам скриптов для определения задачи описываемой здесь
  match: /vue-cli-service serve/,
  description: 'Компиляция и горячая замена модулей для разработки',
  // Ссылка "More info"
  link: 'https://github.com/vuejs/vue-cli/blob/dev/docs/cli-service.md#serve'
})

api.describeTask({
  match: (command) => /vue-cli-service serve/.test(command),
})

api.describeTask({
  /* ... */
  // Иконка задачи
  icon: 'application_settings'
})

api.describeTask({
  // ...

  // Опциональные параметры (подсказки inquirer)
  prompts: [
    {
      name: 'open',
      type: 'confirm',
      default: false,
      description: 'Открывать браузер при старте сервера'
    },
    {
      name: 'mode',
      type: 'list',
      default: 'development',
      choices: [
        {
          name: 'development',
          value: 'development'
        },
        {
          name: 'production',
          value: 'production'
        },
        {
          name: 'test',
          value: 'test'
        }
      ],
      description: 'Указать режим env'
    }
  ]
})

api.describeTask({
  // ...

  // Хуки
  // Изменяем аргументы здесь
  onBeforeRun: async ({ answers, args }) => {
    // Аргументы
    if (answers.open) args.push('--open')
    if (answers.mode) args.push('--mode', answers.mode)
    args.push('--dashboard')
  },
  // Сразу после запуска задачи
  onRun: async ({ args, child, cwd }) => {
    // child: дочерний процесс node
    // cwd: рабочий каталог процесса
  },
  onExit: async ({ args, child, cwd, code, signal }) => {
    // code: код выхода
    // signal: сигнал kill, если использовался
  }
})

api.describeTask({
  // ...

  // Дополнительные представления (например для панели webpack)
  // По умолчанию есть представление 'output' которое отображает вывод терминала
  views: [
    {
      // Уникальный ID
      id: 'vue-webpack-dashboard-client-addon',
      // Текст кнопки
      label: 'Dashboard',
      // Иконка кнопки
      icon: 'dashboard',
      // Динамический компонент для загрузки (см. секцию "Клиентское дополнение" ниже)
      component: 'vue-webpack-dashboard'
    }
  ],
  // Стартовый вид отображения сведений о задаче (по умолчанию это output)
  defaultView: 'vue-webpack-dashboard-client-addon'
})

api.addTask({
  // Обязательно
  name: 'inspect',
  command: 'vue-cli-service inspect',
  // Опционально
  // Остальное похоже на `describeTask` без опции `match`
  description: '...',
  link: 'https://github.com/vuejs/vue-cli/...',
  prompts: [ /* ... */ ],
  onBeforeRun: () => {},
  onRun: () => {},
  onExit: () => {},
  views: [ /* ... */ ],
  defaultView: '...'
})

{
  /* ... */
  // Используется для группировки подсказок на разделы
  group: 'Настоятельно рекомендуется',
  // Дополнительное описание
  description: 'Принудительный стиль именования атрибутов в шаблоне (`my-prop` или `myProp`)',
  // Ссылка "More info"
  link: 'https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/rules/attribute-hyphenation.md',
}

{
  name: 'open',
  type: 'confirm',
  default: false,
  description: 'Открыть приложение в браузере'
}

{
  name: 'mode',
  type: 'list',
  default: 'development',
  choices: [
    {
      name: 'Режим разработки',
      value: 'development'
    },
    {
      name: 'Режим production',
      value: 'production'
    },
    {
      name: 'Режим тестирования',
      value: 'test'
    }
  ],
  description: 'Режим сборки',
  link: 'https://link-to-docs'
}

{
  name: 'host',
  type: 'input',
  default: '0.0.0.0',
  description: 'Хост для сервера разработки'
}

{
  name: 'lintOn',
  message: 'Выберите дополнительные возможности линтинга:',
  when: answers => answers.features.includes('linter'),
  type: 'checkbox',
  choices: [
    {
      name: 'Линтинг при сохранении',
      value: 'save',
      checked: true
    },
    {
      name: 'Линтинг и исправление при коммите' + (hasGit() ? '' : chalk.red(' (требуется Git)')),
      value: 'commit'
    }
  ]
}

{
  name: 'themeColor',
  type: 'color',
  message: 'Цвет темы',
  description: 'Используется для изменения цвета интерфейса системы вокруг приложения',
  default: '#4DBA87'
}

const { clientAddonConfig } = require('@vue/cli-ui')

module.exports = {
  ...clientAddonConfig({
    id: 'org.vue.webpack.client-addon',
    // Порт разработки (по умолчанию 8042)
    port: 8042
  })
}

import VueProgress from 'vue-progress-path'
import WebpackDashboard from './components/WebpackDashboard.vue'
import TestView from './components/TestView.vue'

// Вы можете устанавливать дополнительные Vue-плагины
// используя глобальную переменную 'Vue'
Vue.use(VueProgress, {
  defaultShape: 'circle'
})

// Регистрировать пользовательские компоненты
// (работает аналогично 'Vue.component')
ClientAddonApi.component('org.vue.webpack.components.dashboard', WebpackDashboard)

// Добавлять маршруты во vue-router в соответствии с родительским маршрутом /addon/<id>.
// Например, addRoutes('foo', [ { path: '' }, { path: 'bar' } ])
// будет добавлять маршруты /addon/foo/ и the /addon/foo/bar во vue-router.
// Здесь мы создаём новый маршрут '/addon/vue-webpack/' с именем 'test-webpack-route'
ClientAddonApi.addRoutes('org.vue.webpack', [
  { path: '', name: 'org.vue.webpack.routes.test', component: TestView }
])

// Вы можете переводить компоненты своего плагина
// Загрузите файлы локализаций (используется vue-i18n)
const locales = require.context('./locales', true, /[a-z0-9]+\.json$/i)
locales.keys().forEach(key => {
  const locale = key.match(/([a-z0-9]+)\./i)[1]
  ClientAddonApi.addLocalization(locale, locales(key))
})

api.addClientAddon({
  id: 'org.vue.webpack.client-addon',
  // Каталог содержащий все собранные JS файлы
  path: '@vue/cli-ui-addon-webpack/dist'
})

// Полезно для разработки
// Перезапишет путь, если он уже определён в плагине
api.addClientAddon({
  id: 'org.vue.webpack.client-addon',
  // Используйте тот же порт, который указали ранее
  url: 'http://localhost:8042/index.js'
})

api.describeTask({
  /* ... */
  // Дополнительные представления (например для панели webpack)
  // По умолчанию есть представление 'output', которое отображает вывод терминала
  views: [
    {
      // Уникальный ID
      id: 'org.vue.webpack.views.dashboard',
      // Текст кнопки
      label: 'Dashboard',
      // Иконка кнопки (material-icons)
      icon: 'dashboard',
      // Динамический компонент для загрузки, зарегистрированный через ClientAddonApi
      component: 'org.vue.webpack.components.dashboard'
    }
  ],
  // Стартовое представление при отображении сведений о задаче (по умолчанию output)
  defaultView: 'org.vue.webpack.views.dashboard'
})

/* В `main.js` */
// Импортируем компонент
import WebpackDashboard from './components/WebpackDashboard.vue'
// Регистрируем пользовательский компонент
// (работает аналогично 'Vue.component')
ClientAddonApi.component('org.vue.webpack.components.dashboard', WebpackDashboard)

api.addView({
  // Уникальный ID
  id: 'org.vue.webpack.views.test',

  // Имя маршрута (из vue-router)
  // Использует то же имя, как и в методе 'ClientAddonApi.addRoutes' (см. выше в разделе клиентское дополнение)
  name: 'org.vue.webpack.routes.test',

  // Иконка кнопки (material-icons)
  icon: 'pets',
  // Можно указать собственное изображение (см. ниже раздел публичных статичных файлов):
  // icon: 'http://localhost:4000/_plugin/%40vue%2Fcli-service/webpack-icon.svg',

  // Подсказка для кнопки
  tooltip: 'Тестовая страница из дополнения webpack'
})

/* В `main.js` */
// Импортируем компонент
import TestView from './components/TestView.vue'
// Добавляем маршруты в vue-router под родительским маршрутом /addon/<id>.
// Например, addRoutes('foo', [ { path: '' }, { path: 'bar' } ])
// добавит маршруты /addon/foo/ и /addon/foo/bar во vue-router.
// Теперь создаём новый маршрут '/addon/vue-webpack/' с именем 'test-webpack-route'
ClientAddonApi.addRoutes('org.vue.webpack', [
  { path: '', name: 'org.vue.webpack.routes.test', component: TestView }
])

// Установка или обновление
api.setSharedData('com.my-name.my-variable', 'some-data')

// Получение
const sharedData = api.getSharedData('com.my-name.my-variable')
if (sharedData) {
  console.log(sharedData.value)
}

// Удаление
api.removeSharedData('com.my-name.my-variable')

// Отслеживание изменений
const watcher = (value, id) => {
  console.log(value, id)
}
api.watchSharedData('com.my-name.my-variable', watcher)
// Прекращение отслеживания изменений
api.unwatchSharedData('com.my-name.my-variable', watcher)

// Версии для пространства имён
const {
  setSharedData,
  getSharedData,
  removeSharedData,
  watchSharedData,
  unwatchSharedData
} = api.namespace('com.my-name.')

// Компонент Vue
export default {
  // Синхронизируем общие данные
  sharedData () {
    return {
      // Можно использовать `myVariable` в шаблоне
      myVariable: 'com.my-name.my-variable'
      // Можно указывать общие данные нужного пространства имён
      ...mapSharedData('com.my-name.', {
        myVariable2: 'my-variable2'
      })
    }
  },

  // Ручные методы
  async created () {
    const value = await this.$getSharedData('com.my-name.my-variable')

    this.$watchSharedData(`com.my-name.my-variable`, value => {
      console.log(value)
    })

    await this.$setSharedData('com.my-name.my-variable', 'new-value')
  }
}

// Вызов действия
api.callAction('com.my-name.other-action', { foo: 'bar' }).then(results => {
  console.log(results)
}).catch(errors => {
  console.error(errors)
})

// Отслеживание действия
api.onAction('com.my-name.test-action', params => {
  console.log('test-action called', params)
})

const { onAction, callAction } = api.namespace('com.my-name.')

// Компонент Vue
export default {
  created () {
    this.$onPluginActionCalled(action => {
      // Когда действие вызывается
      // до того как будет выполнено
      console.log('called', action)
    })
    this.$onPluginActionResolved(action => {
      // После того как действие запущено и завершено
      console.log('resolved', action)
    })
  },

  methods: {
    testPluginAction () {
      // Вызов действия плагина
      this.$callPluginAction('com.my-name.test-action', {
        meow: 'meow'
      })
    }
  }
}

const { IpcMessenger } = require('@vue/cli-shared-utils')

// Создание нового экземпляра IpcMessenger
const ipc = new IpcMessenger()

function sendMessage (data) {
  // Отправка сообщения на сервер cli-ui
  ipc.send({
    'com.my-name.some-data': {
      type: 'build',
      value: data
    }
  })
}

function messageHandler (data) {
  console.log(data)
}

// Отслеживание сообщения
ipc.on(messageHandler)

// Прекращение отслеживания
ipc.off(messageHandler)

function cleanup () {
  // Отключение от сети IPC
  ipc.disconnect()
}

const ipc = new IpcMessenger({
  autoConnect: false
})

// Это сообщение будет добавлено в очередь
ipc.send({ ... })

ipc.connect()

const ipc = new IpcMessenger({
  disconnectOnIdle: true,
  idleTimeout: 3000 // По умолчанию
})

ipc.send({ ... })

setTimeout(() => {
  console.log(ipc.connected) // false
}, 3000)

const ipc = new IpcMessenger({
  networkId: 'com.my-name.my-ipc-network'
})

function onWebpackMessage ({ data: message }) {
  if (message['com.my-name.some-data']) {
    console.log(message['com.my-name.some-data'])
  }
}

// Отслеживание любого IPC-сообщения
api.ipcOn(onWebpackMessage)

// Прекращение отслеживания
api.ipcOff(onWebpackMessage)

// Отправка сообщения во все подключённые экземпляры IpcMessenger
api.ipcSend({
  webpackDashboardMessage: {
    foo: 'bar'
  }
})

// Сохранение значения в локальной базе данных
api.storageSet('com.my-name.an-id', { some: 'value' })

// Получение значения из локальной базы данных
console.log(api.storageGet('com.my-name.an-id'))

// Полноценный экземпляр lowdb
api.db.get('posts')
  .find({ title: 'low!' })
  .assign({ title: 'hi!'})
  .write()

// Использование версий для пространства имён
const { storageGet, storageSet } = api.namespace('my-plugin.')

api.notify({
  title: 'Какой-то заголовок',
  message: 'Сообщение пользователю',
  icon: 'path-to-icon.png'
})

api.setProgress({
  status: 'Обновление...',
  error: null,
  info: 'Шаг 2 из 4',
  progress: 0.4 // значение от 0 до 1, -1 означает скрытый индикатор прогресса
})

api.removeProgress()

api.onProjectOpen((project, previousProject) => {
  // Сброс данных
})

api.onPluginReload((project) => {
  console.log('плагин перезагружен')
})

api.onConfigRead(({ config, data, onReadData, tabs, cwd }) => {
  console.log(config.id)
})

api.onConfigWrite(({ config, data, changedFields, cwd }) => {
  // ...
})

api.onTaskOpen(({ task, cwd }) => {
  console.log(task.id)
})

api.onTaskRun(({ task, args, child, cwd }) => {
  // ...
})

api.onTaskExit(({ task, args, child, signal, code, cwd }) => {
  // ...
})

api.onViewOpen(({ view, cwd }) => {
  console.log(view.id)
})

api.addSuggestion({
  id: 'com.my-name.my-suggestion',
  type: 'action', // Обязательно (больше типов в будущем)
  label: 'Add vue-router',
  // Это будет показано в модальном окне подробностей
  message: 'A longer message for the modal',
  link: 'http://link-to-docs-in-the-modal',
  // Опциональное изображение
  image: '/_plugin/my-package/screenshot.png',
  // Функция вызывается когда предположение активируется пользователем
  async handler () {
    // ...
    return {
      // По умолчанию удаляет кнопку
      keep: false
    }
  }
})

api.removeSuggestion('com.my-name.my-suggestion')

api.addSuggestion({
  id: 'com.my-name.my-suggestion',
  type: 'action', // Обязательно
  label: 'Add vue-router',
  // Открыть новую вкладку
  actionLink: 'https://vuejs.org/'
})

const ROUTER = 'vue-router-add'

api.onViewOpen(({ view }) => {
  if (view.id === 'vue-project-plugins') {
    if (!api.hasPlugin('router')) {
      api.addSuggestion({
        id: ROUTER,
        type: 'action',
        label: 'org.vue.cli-service.suggestions.vue-router-add.label',
        message: 'org.vue.cli-service.suggestions.vue-router-add.message',
        link: 'https://router.vuejs.org/',
        async handler () {
          await install(api, 'router')
        }
      })
    }
  } else {
    api.removeSuggestion(ROUTER)
  }
})

api.hasPlugin('eslint')
api.hasPlugin('apollo')
api.hasPlugin('vue-cli-plugin-apollo')

api.getCwd()

api.resolve('src/main.js')

api.getProject()

api.describeConfig({
  /* ... */
  // Пользовательское изображение
  icon: '/_plugin/vue-cli-plugin-hello/my-logo.png'
})