如何创建自定义的Xcode 6 工程模板

随着时间的推移，这篇文章的实践部分需要更新了，我找到一个更好的工具来做这件事，这就是 liftoff。相比与手动来制作工程模板，自定义 liftoff 的配置文件要容易很多，更重要的是它提供了文档。

liftoff 支持配置工程的组，目录结构和模板。配置工程的组和目录结构是通过 .liftoffrc 文件，它查找顺序是 ./.liftoffrc > ~/.liftoffrc > 默认配置文件，可以 man liftoffrc 来查看详细介绍。

litfoff 还可以在新建工程时通过在 .liftoffrc 中指定包含哪些文件，这些文件的来源顺序是 ./.liftoff/templates > ~/.liftoff/templates > 默认的文件。

通过 .liftoffrc 来配置我们想要的工程结构，然后自定义Podfile 来包含工程常用的 pod，可以为我们在新建工程省些事，减轻些负担，总之还是我们之前想办法把重复的事情自动化的思想。

下面是我的 ~/.liftoffrc:

############################################################################
# The following keys can be used to configure defaults for project creation
# project_name:
# company:
# author:
# prefix:
# company_identifier:
############################################################################

test_target_name: UnitTests
configure_git: true
warnings_as_errors: true
enable_static_analyzer: true
indentation_level: 4
use_tabs: false
dependency_managers: cocoapods
enable_settings: false
strict_prompts: false
deployment_target: 8.0

run_script_phases:
  - file: todo.sh
    name: Warn for TODO and FIXME comments
  - file: bundle_version.sh
    name: Set version number

templates:
  - test.sh: bin/test
  - setup.sh: bin/setup
  - README.md: README.md

warnings:
  - GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED
  - GCC_WARN_MISSING_PARENTHESES
  - GCC_WARN_ABOUT_RETURN_TYPE
  - GCC_WARN_SIGN_COMPARE
  - GCC_WARN_CHECK_SWITCH_STATEMENTS
  - GCC_WARN_UNUSED_FUNCTION
  - GCC_WARN_UNUSED_LABEL
  - GCC_WARN_UNUSED_VALUE
  - GCC_WARN_UNUSED_VARIABLE
  - GCC_WARN_SHADOW
  - GCC_WARN_64_TO_32_BIT_CONVERSION
  - GCC_WARN_ABOUT_MISSING_FIELD_INITIALIZERS
  - GCC_WARN_ABOUT_MISSING_NEWLINE
  - GCC_WARN_UNDECLARED_SELECTOR
  - GCC_WARN_TYPECHECK_CALLS_TO_PRINTF
  - GCC_WARN_ABOUT_DEPRECATED_FUNCTIONS
  - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS
  - CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF
  - CLANG_WARN_IMPLICIT_SIGN_CONVERSION
  - CLANG_WARN_SUSPICIOUS_IMPLICIT_CONVERSION
  - CLANG_WARN_EMPTY_BODY
  - CLANG_WARN_ENUM_CONVERSION
  - CLANG_WARN_INT_CONVERSION
  - CLANG_WARN_CONSTANT_CONVERSION

xcode_command: open -a 'Xcode' .

project_template: objc

app_target_templates:
  objc:
    - <%= project_name %>:
      - Categories:
      - Protocols:
      - Headers:
      - Models:
      - Sections:
      - Classes:
      - AppDelegate:
        - <%= prefix %>AppDelegate.h
        - <%= prefix %>AppDelegate.m
      - Network:
      - DataPersistence:
      - Docs:
      - Vendors:
      - Resources:
        - Images.xcassets
        - Nibs:
          - LaunchScreen.xib
        - Other-Sources:
          - Info.plist
          - <%= project_name %>-Prefix.pch
          - main.m
  swift:
    - <%= project_name %>:
      - Extensions:
      - Protocols:
      - Models:
      - ViewModels:
      - Controllers:
        - AppDelegate.swift
      - Views:
      - Resources:
        - Images.xcassets
        - Storyboards:
          - Main.storyboard
        - Nibs:
          - LaunchScreen.xib
        - Other-Sources:
          - Info.plist

test_target_templates:
  objc:
    - <%= test_target_name %>:
      - Resources:
        - <%= test_target_name %>-Info.plist
        - <%= test_target_name %>-Prefix.pch
      - Helpers:
      - Tests:
  swift:
    - <%= test_target_name %>:
      - Resources:
        - <%= test_target_name %>-Info.plist
      - Helpers:
      - Tests:

使用Xcode 6新建工程时，Apple准备了好些模板，这些模板写个Demo还是没有问题的，但是用来组织项目文件还是太弱了，所以情况经常是不得不每次去新建各种目录，这种重复性的劳动一来乏味，二来浪费时间。那么我们能不像创建自己的模板呢？这样新建的工程就能按自己的想法包含各种目录和文件。好消息是可以，坏消息是Apple没有提供相应的文档。虽然没有文档，还是试着来创建一个模板，每次都重复实在太烦（就是这么任性）。

既然没有文档，我们就把Apple的模板复制一份，在它的基础上修改成我们需要的样子。/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/Project\ Templates/iOS/Application/有iOS所有工程模板。用户自定义的模板建议放到~/Library/Developer/Xcode/Templates/，目录如果不存在就创建。模板至少要包含两部分：一是扩展名为.xctemplate的文件夹；二是名称为TemplateInfo.plist的属性列表文件。好了，我们来创建一个自定义模板：

// Step 1:
$ mkdir ~/Library/Developer/Xcode/Templates/CocoaBite.xctemplate/

// Step 2:
$ cp /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/Project\ Templates/iOS/Application/Single\ View\ Application.xctemplate/* ~/Library/Developer/Xcode/Templates/CocoaBite.xctemplate/

现在我们有了一个和Single View Application一样的模板，但这和我们目标还相差很远。接下来我们要做就是修改TemplateInfo.plist，让模板为我们做更多准备工作。

Keys	Advice
Ancestors	No	Import settings from another Project Template.
Concrete	Recommended	Visible or hide Template form New Project Window.
Definitions	No	Work with workplace. Can write to file example source code.
Description	Recommended	New Project Window - Project Template Description.
Identifier	Yes	Project Template Unique Identifier.
Kind	Yes	XCode Template Kind. Project or File.
Nodes	Recommended	Create or Copy Files to Project. Copy works
Options	Recommended	New Project Wizard » Choose Options for Project. Add Text Fields, Combo Boxes.
Platforms	Recommended	Set Platform.
Project	Yes	Set Project Build Settings.
Targets	Recommended	Set Build Settings, Build Phases for Targets. Link Libraries.

上面列出了TemplateInfo.plist大部分键，详细介绍在这里。

我自己新建的模板主要用到Definitions和Nodes，它们俩组合起来可以控制模板会新建哪些文件。例如我想让模板包含Models目录：

// Step 1:
$ cd ~/Library/Developer/Xcode/Templates/CocoaBite.xctemplate/

// Step 2:
$ mkdir -p Models

// Step 3: 编辑TemplateInfo.plist 如下图所示。

<img name="PropertyList" src="/images/PropertyList.png" width="623" height="836">

完整的模板放在这里。

##Reference

Creating Custom Xcode 4 Project Templates
About XCode 4 Project Template (How To Create Custom Project Template)
Xcode-6-Project-Templates