Liftoff is a CLI for creating and configuring iOS Xcode projects.
brew tap thoughtbot/formulae
brew install liftoff
Liftoff was previously distributed via RubyGems. This method of installation has been deprecated, and all new releases will be done through Homebrew. If you are migrating from RubyGems, you should uninstall the gem version to avoid confusion in the future.
Run this command in a directory
liftoff
When Liftoff finds an existing project in the current directory, it will perform the following configurations:
- Set the indentation level (In spaces, 4 by default).
- Treat warnings as errors for release schemes
- Enable warnings at the project level
- Turn on Static Analysis for the project
- Add a build phase shell script that turns "TODO:" and "FIXME:" into warnings
- Add default .gitignore and .gitattributes files.
- Initialize a new
gitrepo and create an initial commit (if needed).
When you run Liftoff in a directory without a project file, it will create a new directory structure for a project, and generate a well-configured Xcode project in that subdirectory:
$ cd ~/dev/
$ liftoff
Project name? MyCoolApp
Company name? thoughtbot
Author name? Gordon Fontenot
Prefix? MCA
Creating MyCoolApp
Creating MyCoolApp/Categories
Creating MyCoolApp/Classes
[snip]
Liftoff will generate a brand new project for you based on the provided values. Generating projects via Liftoff has these advantages:
- Minimized time reorganizing the repository
- Sets up
gitrepository automatically - Defined group structure
- Matching directory structure on disk (linked to the proper group)
- Easily customizable
- Configurations can be shared easily
You can use a liftoffrc file to speed up your workflow by defining your
preferred configuration for Liftoff.
Liftoff will look for config files in the local directory and then the home
directory. If it can't find a key in ./.liftoffrc or ~/.liftoffrc, it will
use the default.
Check the default for a list of available options.
We highly recommend using ~/.liftoffrc to define the author configuration:
author: Gordon FontenotThis will speed up data entry when creating new projects. It can also be
useful to create context-specific .liftoffrc files for personal or work
uses. So I can create ~/work-projects/.liftoffrc that looks like so:
company: thoughtbotNow any new project started inside my work-projects directory will
automatically default to using thoughtbot as the company name. Then I can do
the same for my personal directory so that projects created there have a
different default. Note that this can be applied to any of the settings inside
the liftoffrc. So if your company dictates a specific folder structure, you
can define that in your company's liftoffrc to make sure that those projects
conform to your guidelines.
One of the most powerful things that Liftoff can do for you is let you quickly
and easily customize your project's group and directory structure. By defining
a YAML dictionary inside your local or user .liftoffrc, you can completely
dictate the structure that will be created. This includes group structure,
order, placement of template files, etc. And remember that these groups will
be mimicked on disk as well.
You can also create your own templates, or override the defaults by adding
them to ~/.liftoff/templates or ./.liftoff/templates. Liftoff will use the
same fallback order when looking for templates as it does for the
.liftoffrc.
These files (and filenames) will be parsed with ERB, using the values
provided at run time (or the default values from a liftoffrc).
There are a few default template files available to you:
<%= prefix %>AppDelegate.h<%= prefix %>AppDelegate.m<%= project_name %>-Info.plist<%= project_name %>-Prefix.pchmain.mUnitTests-Info.plistUnitTests-Prefix.pch
There is also a template directory for the Images.xcassets asset library.
Liftoff is maintained by Mark Adams and Gordon Fontenot. It was written by thoughtbot, inc.
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
Liftoff is Copyright (c) 2012-2014 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.