Create custom Xcode templates
Switch branches/tags
Nothing to show
Pull request Compare This branch is 26 commits behind royclarkson:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
ASL.txt
LICENSE
MIT.txt
NOTICE
README.md
original_header.txt
templates.png
xctemplates.rb

README.md

Xcode Templates

A Ruby shell script for generating custom Xcode templates

Overview

Often when working with Xcode you may want to replace the default file heading with something else, maybe a license, or maybe more description about the project. This script will help you generate templates preconfigured with a specific license or heading, so you don't have to keep cutting and pasting that information into your code. It copies the default templates from within the Xcode bundle, then updates the header of each template with the specified license.

Prerequisites

It is expected that you are on a Mac, running OS X, that you have the latest version of Xcode installed (4.6 as of this writing), and also are running Ruby 1.8.7 or newer.

Usage

The script is executed from the command line, so the first step is to verify the script can be executed. Run the following command to make it executable.

chmod +x xctemplates.rb

Now you can simply run the script from your shell prompt. The default implementation generates templates with the Apache Software License (ASL) header.

./xctemplates.rb

You can also specify an alternate header file to use by passing a command line argument. The argument must match the name of a text file within the same directory. Currently, only ASL and MIT text files are provided.

./xctemplates.rb MIT

Installing the Templates

The templates are copied to the "staging" folder. Within that is a folder called "File Templates". Move or copy the generated "File Templates" folder and its contents into the following location:

~/Library/Developer/Xcode/Templates/

Please note that the script is capable of copying the generated templates into this location, but it is a limited implementation that simply erases any existing templates first. Since this is not always desirable, that functionality has been commented out until it can be improved.

Using the Templates to Create a New File

When you select to add a new file you will see the new templates available as options within Xcode.

<File Templates>

Adding new License Files

This is very easy to do. Simply create a new text document in the project root with a descriptive name. For example you may want to use the BSD license, so create a BSD.txt and place it in the root of the project along side the ASL and MIT files. See the ASL and MIT files for inspiration. Once you have created a new file you can run the script, passing the name as a command line argument.

If you would like to share your header file with others, then feel free to submit a pull request and I will include it in the project.

Contributing to the Project

I only spent a couple hours coding and manually testing this script. It does what I need it to do, but not much more. There are many areas for improvement and expansion, like tests! Pull requests are welcome.

Copyright

Copyright (c) 2012-2013, Roy Clarkson. All Rights Reserved.

License

Licensed under version 2.0 of the Apache License.