Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Ruby

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.versions
bin
config
help
lib
sinatratest
spec
.rspec
README.md
TODO.md
aspen-0.2.6.gem
aspen.gemspec

README.md

aspen

A Ruby gem to easily, flexibly, and instantly create your next project's directory structure. Aspen, get it? Like a tree. With roots.

Anyway, for more details, check out the usage examples below.

More info on RubyGems.org: aspen.

Installation:

$ gem install aspen

Basic Usage:

$ aspen <project_title>

Creates basic project directory structure including rspec initialization. Also creates skeleton README.md and evnironment.rb files.

$ aspen --help

Displays help.

Example Bash Output:

$ aspen my-awesome-project
mkdir -p my-awesome-project
mkdir -p my-awesome-project/bin
mkdir -p my-awesome-project/config
mkdir -p my-awesome-project/lib/models/concerns
  create   spec/spec_helper.rb
  create   .rspec
  create   config/environment.rb

Project successfully created at:
  /Users/loganhasson/Desktop/my-awesome-project

Default Created Directory Structure:

my-awesome-project/
├── README.md
├── bin
├── config
│   └── environment.rb
├── lib
│   └── models
│       └── concerns
└── spec
    └── spec_helper.rb

Better Usage:

Flag Purpose Example
-t
--template=TEMPLATE
Flag to designate the template for your project's directory structure. If left blank uses default aspen template. $ aspen -t hello my-awesome-project
-g
--git
Flag to designate auto-initialize your git repo locally. $ aspen -g my-awesome-project
$ aspen -gt hello another-project

Contributing:

aspen is only as strong as the community surrounding it - like a forest.

Because aspen is a type of tree.

Anyway, we need your help: aside from improving the code base and adding new features, please submit templates of your own. It's really easy to create them, and with a single pull request you can help the forest grow.

All aspen needs to create a new directory template is a folder with a template.rb file and any other files that your project requires. As an example, the default aspen template is structured as follows in lib/templates/default:

lib/templates/default
├── environment.rb
└── template.rb

Inside the template.rb file is a simple hash that describes the structure of your project:

TEMPLATE = {
              :bin => {},
              :config => {:file1 => ["environment.rb"]},
              :lib => {
                :models => {
                  :concerns => {}
                }
              }
            }

All directories within your project are represented as key-value pairs. Directories with no children will point to an empty hash. Subdirectories will be nested within as hashes of their own. To include files within a directory, create a key such as :file1 and point it to an array that contains your file name as a string.

Your template must be submitted as a folder within the templates directory containing a template.rb file and any additional supporting files. The folder name determines the template name. Please follow reasonable naming conventions. In other words, no weird characters or spaces. If you really want to be sure, here's more info.

Submit Code, Offer Suggestions, Be Heard.

Tell us what you think! You're awesome and so are your opinions :)

If you have suggestions on how to improve the gem, drop us a line or submit a pull request.

And Twitter is always cool:

@loganhasson

@mecampbellsoup

@j_scag_

Known Issues:

  • Please submit a GitHub Issue with any bugs or concerns you encounter.

Upcoming Features:

  • More flags to customize directory structure

  • GitHub remote repo creation via flag

  • Custom file creation

  • Submit anything else you'd like to see via a GitHub Issue - or, better yet, submit a pull request :)

Built with ♥ @flatironschool

Something went wrong with that request. Please try again.