На пути к «10x инженеру»: шорткаты, сниппеты, шаблоны17.11.2020 17:47

Теперь можно пользоваться терминалом не выходя из Xcode: ⌘ + P запустит скрипт на переустановку. Зажать сочетание — это всё, что от нас нужно.

Какие еще разделы для шорткатов можно прокачать:

• рефакторинг — extract to function/method/variable, add missing switch case;
  
• брейкпойнты — создание Swift Error/Exception/Symbolic/Test Failure;
  
• Version Control Source — push/pull/fetch/new branch/checkout;
  
• работа с Swift Package Manager — add/reset/resolve/update.
  

Как изучать шорткаты в программах? Как минимум, все стандартные приложения macOS имеют вкладку Help с возможностью поиска. Поиск в интерактивном режиме не только проведет вас по всем самым потаённым местам, но и подскажет шорткат.

Сниппеты

Иногда, работая над проектом, я понимал, что раз за разом пишу одно и то же — так называемый бойлерплейт. Этот процесс тоже можно автоматизировать. К счастью, сейчас есть много очень хороших решений и они скорей всего вам знакомы: это и Sourcery для генерации кода по шаблону и библиотеки по типу R.Swift для генерации доступа к ресурсам, и другие фреймворки. Но не всегда есть возможность затащить стороннюю зависимость в проект. К тому же есть бойлерплейт-код, где подобные библиотеки не помогут. Зато поможет стандартный инструмент Xcode — сниппеты.

Сниппеты есть для всех ключевых слов языка Swift (и некоторых других) и стандартных конструкций: циклов, ветвлений, функций. Но часто мне нужен не просто var, а private/public var. Точно также мне не нужен просто @testable, мне нужен @testable import. Другими словами, я бы хотел оперировать уже готовыми конструкциями, а не собирать их по частям.

Изменить стандартные сниппеты нельзя, зато добавить свой совсем просто: выделяем блок кода и в контекстном меню выбираем «Create Code Snippet». Дальше Xcode предложит его настроить: задать имя, добавить описание, платформу, скоуп вызова, и, конечно же, указать комплишн, по которому будет вызываться наш сниппет:

Вот так быстро можно «сгенерировать» код для минимальной работы таблицы (ещё быстрее можно сделать, если сразу в сниппете задать количество строк и возвращать пустую ячейку).

Так выглядит сниппет в библиотеке Xcode (⌘ + ⇧ + L):

Как добавить плейсхолдер: поместите ваш текст внутри конструкции <# MyDescription #> (лучше добавлять её  уже после того, как вы добавили описание, так как она сразу «схлопывается»).

А вот как в два тапа можно сделать импорт целой пачки фреймворков для юнит-тестов:

В проекте «Додо Пиццы» мы пишем тесты с помощью Quick/Nimble. Каждый новый спек начинается с импорта 4–6 фреймворков (минимум), и продолжается телом разного уровня вложенности. Импортировать фреймворки мы уже научились, сделаем это и для тела спеки. Всего пара тапов по клавиатуре и сетап для тестов готов:

Еще один кейс: в нашем проекте для логирования ошибки необходимо описать её в специальном виде: создаем энумку, наследуемся от протокола Error, задаем кейсы, устанавливаем код ошибки, описываем различные параметры. Каждый раз по памяти писать неудобно:

Для меня это идеальный кандидат для оптимизации своего времени — пусть сниппет делает все за меня:

А сколько еще таких мест можно улучшить (и всё это бесплатно). Несколько личных примеров кандидатов для сниппета:

• Делегат и data source для таблицы/коллекции (обязательные методы).
  
• При объявлении методов протокола срабатывал стандартный сниппет функции (с открытыми фигурными скобками). Но мне не нужны скобки в протоколе, поэтому я добавил свой сниппет, без скобок. Теперь не нарадуюсь.
  

Часто типы данных и функции нужно объявлять с явным типом доступа. Это можно можно завернуть в сниппет.

• weak self для замыканий — guard let weakSelf = self else { return };
  
• локализация — оборачивание в NSLocalizedString (основное отличие от хоткея описанного выше в том, что здесь мы указываем параметр для бандла).
  

Шаблоны

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

Шаблоны удобны, но Apple не предоставляет инструменты для их разработки и документации. Но можно сделать все ручками, потому что есть доступ к стандартным шаблонам файлов (и проектов) Xcode. Чтобы их найти, перейдём в каталог по этому пути:

// ⌘ + ⇧ + G в Finder

/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/File Templates/Source/Cocoa Touch Class

Дальше разместим свои темплейты: создаём папку по пути ниже, её имя будет отображаться в окне Xcode. Я назвал папку Helpers:

~/Library/Developer/Xcode/Templates/Files Templates/Helpers

Шаблон для Xcode — это каталог, куда входят:

• файл шаблона (например, .swift или .storyboard);
  
• .plist файл с настройками;
  
• иконки двух размеров для отображения в окне Xcode при создании файла.
  

Чтобы создать свой шаблон, скопируем папку со стандартным шаблоном Xcode  и изменим его под себя. Например, для создания объекта API реквеста у себя в проекте мы используем определенную структуру, где описываем стандартные для запроса вещи: урл, параметры, заголовки.

Часто нам интересны только пара параметров, но всё остальное мы обязаны прописать (обязанность протокола). Как раз для этого случая я создал шаблон файла, который не только экономит мне время, но и сразу подсказывает где и что дописать.

Вот так может выглядеть .plist файл в нашем случае:

http://www.apple.com/DTDs/PropertyList-1.0.dtd">

    
        Platforms
        
            com.apple.platform.iphoneos
        
        Kind
        Xcode.IDEFoundation.TextSubstitutionFileTemplateKind
        Description
        Internet request
        Summary
        Internet request
        SortOrder
        1
        AllowedTypes
        
            public.swift-source
        
        DefaultCompletionName
        File
        MainTemplateFile
        ___FILEBASENAME___
        Options
        
            
                Default
                Some
                Description
                Name of the request
                Identifier
                productName
                Name
                Request name:
                NotPersisted
                Yes
                Required
                Yes
                Type
                text
            
        
    

Добавил код в .swift файл (полный пример на GitHub) и обновил иконки. Теперь можно протестировать создание в Xcode (возможно потребуется его перезапуск). Появилась отдельная секция Helpers с моим шаблоном.

А вот такое окно мы увидим после выбора шаблона:

Вводим имя для реквеста. В итоге будет создан вот такой файл:

Только посмотрите сколько работы за меня делают шаблоны!

Пара моментов:

• У нас есть правило для именования реквестов — постфикс Request в имени. При создании файла мне не нужно об этом заботиться, я только ввожу имя реквеста, и по шаблону будет создан класс с правильным названием и именем файла. GetMenuRequest и GetMenuRequest.swift в данном случае.
  
• Класс имплементирует протокол, но большинство параметров — дефолтные. После создания файла, шаблон мне «подсказывает» места, которые скорее всего я хочу изменить.
  

Рассмотрим более интересное применение шаблонов — многофайловые шаблоны с возможностью кастомизации при создании (code variants).

В проекте «Додо Пиццы» мы отделяем вью от котроллера. Если это новый контроллер, то создаем под него сториборд/ксиб. Чтобы создать один экран, нужно создать минимум 3 файла: вью, контроллер и сториборд. Помимо этого, контроллер должен быть связан с вью, а сториборд иметь ссылки на вью и контроллер. При этом, мне не всегда нужно создавать файл сториборда (если он уже есть), или файл с вью (если она не нужна). В этой ситуации помогут многофайловые шаблоны с кастомизацией.

В нашем случае нужно будет создать 4 папки для шаблона:

1. просто контроллер;
   
2. контроллер и сториборд;
   
3. контроллер и вью;
   
4. контроллер, вью и сториборд;
   

Вот так будет выглядеть иерархия:

- ViewController.xctemplate
- — UIViewController
- — UIViewControllerStoryboard
- — UIViewControllerView
- — UIViewControllerViewStoryboard
- — TemplateIcon.png
- — TemplateIcon@2x.png
- — TemplateInfo.plist

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

Вот так может выглядеть plist:

http://www.apple.com/DTDs/PropertyList-1.0.dtd">

    
        Kind
        Xcode.IDEFoundation.TextSubstitutionFileTemplateKind
        Description
        ViewController class
        Summary
        ViewController class
        SortOrder
        1
        DefaultCompletionName
        ViewController
        Platforms
        
             com.apple.platform.iphoneos
        
        Options
        
             
                  Identifier
                  viewControllerName
                  Required
                  
                  Name
                  ViewController:
                  Description
                  The name of the view controller class to create
                  Type
                  text
                  NotPersisted
                  
                 
             
                  Identifier
                  cocoaTouchSubclass
                  Required
                  YES
                  Name
                  Subclass of:
                  Description
                  What class to subclass in the new file
                  Type
                  class
                  Default
                  UIViewController
                  NotPersisted
                  
                 
             
                  Identifier
                  View
                  Name
                  Also create View file
                  Description
                  Whether to create a View file with the same name
                  Type
                  checkbox
                  Default
                  true
                  NotPersisted
                  
                 
             
                  Identifier
                  Storyboard
                  Name
                  Also create Storyboard file
                  Description
                  Whether to create a Storyboard file with the same name
                  Type
                  checkbox
                  Default
                  true
                  NotPersisted
                  
                 
             
                  Default
                  ___VARIABLE_viewControllerName___
                  Identifier
                  productName
                  Type
                  static
                 
        
    

А вот что получим в итоге:

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

Сила шаблонов в том, что на уровне создания файла можно конфигурировать, что именно нужно создать. Например, можно создать шаблон для VIPER-модуля и при создании указывать только то, что вам нужно (презентер с интерактором или весь модуль целиком).

Бонус секция для шаблонов

Как раньше упоминал, для шаблонов нет официальной документации и инструментов для их создания. Возможности шаблонов «перебираются» энтузиастами на основе стандартных шаблонов Xcode. Но есть одна фича, описание которой я не видел ни в одной статье по шаблонам (возможно, эта будет первой).

Фича в том, что в шаблоне мы можем сконфигурировать текстовое поле так, что оно будет выступать в роли превью для вводимого текста. Например, это можно видеть при создании нового проекта — поле Bundle Identifier меняется в зависимости от поля Product Name. В моем примере это выглядит так:

Потрясающе, ведь теперь я знаю, что мне не нужно дописывать бойлерплейт части ViewController и View.

Сделать это просто: в .plist добавим новое текстовое поле, где в default-параметре укажем переменную для интересующего идентификатора.

// Поле ввода имени ViewController

      Default
      Massive
      Identifier
      productName
      Required
      
      Name
      ViewController:
      Description
      The name of the view controller class to create
      Type
      text
      NotPersisted
      YES


// Превью имени ViewController

      NotPersisted
      Yes
      Default___VARIABLE_productName:identifier___ViewController
      Description
      ViewController
      Identifier
      previewViewController
      Name
      ViewController:
      Type
      static

Выглядит эффектно. Спасибо @ihppie за то, что рассказал про эту фичу.

Итог

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

• Тренируйте шорткаты — работа на тачпаде/мышкой будет замедлять вас. Многие операции мышкой и так требуют зажатия клавиш, почему бы полностью не перебраться на клавиатуру?
  
• Используйте сниппеты для часто повторяемых, неделимых конструкций, project-specific кейсов.
  
• Создавайте шаблоны и управляйте не только создаваемым файлом, но и сопутствующими (code variants).
  

Код со всеми примерами в репозитории на GitHub.

Делитесь в комментариях своими джедайскими техниками работы с кодом, что используете и в каких количествах, как учили или учите — вместе мы станем на один шаг ближе к 10x инженеру. Чтобы не пропустить следующую статью, подписывайтесь на канал Dodo Pizza Mobile и Dodo Engineering.

© Habrahabr.ru