Squidhead

Step Reference

Steps are a feature in Squidhead that allows developers to pick and choose the various tasks that Squidhead performs.

Currently by default Squidhead runs the following steps in order:

  1. buildDirectories
  2. sqlAnalyzeTables
  3. sqlWriteStoredProcs
  4. sqlAnalyzeProcs
  5. cfc_dao_gateway
  6. cfc_business
  7. customtags
  8. cfms
  9. ant
  10. refreshApplication

Notes

To add a step
All of the avialable steps are in the steps folder. Either just ArrayAppend a step to config.application.steps, or copy the entire config.application.steps declaration from the default.cfm in configs and modify as you see fit. Make sure to include the "arraynew() declaration."
To remove a step
Copy the entire config.application.steps declaration from the default.cfm in configs and modify as you see fit. Make sure to include the "arraynew() declaration."
Required Steps
Since buildDirectories and sqlAnalyzeTables are needed by so many other tasks, make sure you declare first.

Step Details

ant

Writes an Ant file for Squidhead generated application that creates tasks that do the following:

Additionally if the cfunit step is run, it creates a task that will:

Requires: buildDirectories
buildDirectories

Conditionally builds all of the directories that the generated application will use.

Requires:
buildDocumentation

A not very impressive task that builds quick and dirty CFC docs for your application.

Requires:
cfc_business

Builds the business cfc's for the generated application.

Requires: buildDirectories, sqlAnalyzeTables
cfc_business_dynamic

Switches the business cfc's to the dynamic and custom setup for the generated application. It's for use with the fkCrazy application template.

Requires: buildDirectories, sqlAnalyzeTables
cfc_dao_gateway

Builds the dao and gateway cfc's for the generated application.

Requires: buildDirectories, sqlAnalyzeTables, sqlAnalyzeProcs
cfms

Builds the weak cfml controllers for the generated application.

Requires: buildDirectories, sqlAnalyzeTables
cfunit

Builds the CFUnit Tests for the generated application.

Requires: buildDirectories, sqlAnalyzeTables
cfunitTest

Runs the CFUnit Tests for the generated application.

Requires: cfunit, ant
coldspringGenerateConfig

Creates the XML config file for ColdSpring for all of the DAO's and Gateway's in the application.

Requires: buildDirectories, sqlAnalyzeTables
customtags

Builds the CFML Custom Tag UI nuggets for the generated application.

Requires: buildDirectories, sqlAnalyzeTables
notify
p>A not very impressive task that notifies your team when you run Squidhead.

Requires:
refreshApplication

A simple tasks that refreshes the application scope of the generated application.

Requires:
sqlAnalyzeProcs

Reads in the information about all of the stored procedures in the database.

Requires:
sqlAnalyzeTables

Reads in the information about all of the tables, views and foreign keys in the database.

Requires:
sqlWriteStoredProcs

Writes all of the necessary CRUD + List + Foreign Key stored procs for the application.

Requires: buildDirectories, sqlAnalyzeTables