Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 4.47 KB

README_RU.md

File metadata and controls

47 lines (36 loc) · 4.47 KB
Raw

generator-vue-components README

Это расширение для Visual Code позволяет с минимум действий генерировать компоненты для фреймворка Vue JS. Возможно использование нескольких шаблонов, выбор или ввод имени и выбор или ввод пути для создания компанента. Данные функции возможно настраивать в файле конфигурации.

Возможности

Доступ к функциям расширения возможен из палитры команд (ctrl + shift + P).

Основная функция расширения - это генерация компонентов по шаблонам. Шаблоны могут быть общими (глобальными) или локальными, существующими в конкретном проекте и не доступными из других. Генерация шаблона доступна по пункту в меню "generator-vue-components: new component".

В расширении реализованы функции управления шаблонами, а именно создание новых и открытие для изменения существующих. Данные функции доступны по пункту в меню "generator-vue-components: options" и соответсвующими подпунктами "Create new template" и "Edit a existing template".

Для сохранения локальных настроек для проекта существует возможность использования локального файла конфигурации. Эта возможность доступна из пункта меню "generator-vue-components: options" и подпункта "open the config.json file". При отсутствии файла он будет создан.

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

Для генерации файл-компонента Vue выполните:

  1. Команду "generator-vue-components: new component" в палитре команд (chift + cntrl + P).
    2.1. Если установлен выбор из списка шаблонов, то выберите нужный. Иначе данный этап автоматически пропускается.
    2.2. Если установлен выбор из списка имен компонентов, то выберите нужный. Иначе введите имя строкой.
    2.3. Если установлен выбор из списка путей генерации компонентов, то выберите нужный. Иначе введите путь строкой.
  2. Готово!

Структура файла настроек config.json

{
  "lang": "en",                 // Возможны варианты "ru", "en"
  "default": {                  // Параметры по умолчанию
    "template": "component",    // Шаблон по умолчанию при вводе строкой
    "name": "view",             // Имя генерируемого компонента по умолчанию при вводе строкой
    "path": "/src/components/"  // Путь генерируемого компонента по умлочанию при вводе строкой
  },
  "lists": {                    // Парамерты списков выбора
    "template": true,           // Использовать выбор из списка существующих шаблонов (общих и локальных)
                                // Список выбора путей для генерируемых компонентов (для ввода строкой значение null)
    "path": ["/src/components/", "/src/components/home"],
                                // Список выбора имен для генерируемых компонентов (для ввода строкой значение null)
    "name": ["list", "view", "edit"]
  },
  "templates": {                // Внутренние переменные
    "global": [],
    "local": []
  }
}

Исходный код доступен на GitHub