Skip to content

Commit

Permalink
fix(app generator): clarify build target environment into build anatomy
Browse files Browse the repository at this point in the history
  • Loading branch information
cueedee committed Aug 26, 2016
1 parent 592155f commit a11115d
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 13 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,9 @@ Grunt can do more than just that; here's a recap of common grunt idioms:

command | description
:-- |:--
`grunt [default]` | does a production, non-debugging, all-parts, minified build plus artifacts;
`grunt debug` | does a testing, debugging, all-parts except documentation, as-is build;
`grunt dev` | does a local, debugging, all-parts except documentation, as-is build; <br>_(**Note that this variant doesn't exit**. Instead it'll keep a close watch on filesystem changes, selectively re-triggering part builds as needed)_
`grunt [default]` | does a for-production, non-debugging, all-parts, minified build plus artifacts;
`grunt debug` | does a for-testing, debugging, all-parts except documentation, as-is build;
`grunt dev` | does a for-local, debugging, all-parts except documentation, as-is build; <br>_(**Note that this variant doesn't exit**. Instead it'll keep a close watch on filesystem changes, selectively re-triggering part builds as needed)_
`grunt doc` | will build just the code documentation;
`grunt lint` | will just lint your code;
`grunt test` | will run your test suite;
Expand Down
6 changes: 3 additions & 3 deletions generators/app/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -630,13 +630,13 @@ var AppGenerator = generators.Base.extend(

+ '\n'
+ chalk.bold( ' * ' + chalk.yellow( 'grunt ' + chalk.cyan( '[' ) + 'default' + chalk.cyan( ']' ) + ' ' ))
+ '- does a production, non-debugging, all-parts, minified build plus artifacts;\n'
+ '- does a for-production, non-debugging, all-parts, minified build plus artifacts;\n'

+ chalk.bold( ' * ' + chalk.yellow( 'grunt debug ' ))
+ '- does a testing, debugging, all-parts except documentation, as-is build;\n'
+ '- does a for-testing, debugging, all-parts except documentation, as-is build;\n'

+ chalk.bold( ' * ' + chalk.yellow( 'grunt dev ' ))
+ '- does a local, debugging, all-parts except documentation, as-is build;\n'
+ '- does a for-local, debugging, all-parts except documentation, as-is build;\n'
+ ' (' + chalk.bold( 'Note that this variant doesn\'t exit.' ) + ' Instead, it\'ll keep a close watch on\n'
+ ' filesystem changes, selectively re-triggering part builds as needed)\n'

Expand Down
14 changes: 11 additions & 3 deletions generators/app/templates/@Gruntfile.coffee
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@
## * The application
## * The application's code documentation
##
## * The build's target environment:
## * local
## * testing
## * acceptance
## * production
##
## * The build parts:
## * app<@ if ( i18n ) { @>
## * i18n<@ } @>
Expand Down Expand Up @@ -70,6 +76,8 @@
## * A debugging build implies as-is packing.
## * Minified packing implies a non-debugging build.
##
## * A for-acceptance targetted build is identical to a for-production build.
##
## * The build's artifacts are an all-or-nothing deal, currently.
##
## * The build parts can be processed seperately, but some depend on others:
Expand Down Expand Up @@ -107,9 +115,9 @@
##
## Finally, this is how the main grunt commandline tasks are mapped to all of the above:
##
## * grunt [default] - does a production, non-debugging, all-parts, minified build plus artifacts;
## * grunt debug - does a testing, debugging, all-parts except documentation, as-is build;
## * grunt dev - does a local, debugging, all-parts except documentation, as-is build;
## * grunt [default] - does a for-production, non-debugging, all-parts, minified build plus artifacts;
## * grunt debug - does a for-testing, debugging, all-parts except documentation, as-is build;
## * grunt dev - does a for-local, debugging, all-parts except documentation, as-is build;
## (Note that this variant doesn't exit. Instead, it'll keep a close watch on
## filesystem changes, selectively re-triggering part builds as needed)
##
Expand Down
6 changes: 3 additions & 3 deletions generators/app/templates/@README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ If you would like something different, here's a recap of most common grunt idiom

command | description
:-- |:--
`grunt [default]` | does a production, non-debugging, all-parts, minified build plus artifacts;
`grunt debug` | does a testing, debugging, all-parts except documentation, as-is build;
`grunt dev` | does a local, debugging, all-parts except documentation, as-is build; <br>_(**Note that this variant doesn't exit**. Instead it'll keep a close watch on filesystem changes, selectively re-triggering part builds as needed)_
`grunt [default]` | does a for-production, non-debugging, all-parts, minified build plus artifacts;
`grunt debug` | does a for-testing, debugging, all-parts except documentation, as-is build;
`grunt dev` | does a for-local, debugging, all-parts except documentation, as-is build; <br>_(**Note that this variant doesn't exit**. Instead it'll keep a close watch on filesystem changes, selectively re-triggering part builds as needed)_
`grunt doc` | will build just the code documentation;
`grunt lint` | will just lint your code;
`grunt test` | will run your test suite;
Expand Down
2 changes: 1 addition & 1 deletion generators/demo/templates/src/views/buildscript.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<h3>Default</h3>
<code>grunt [default]</code>
</div>
<p>This task does a production, non-debugging, all-parts, minified build, plus deployable artifacts. It will run the following tasks:</p>
<p>This task does a for-production, non-debugging, all-parts, minified build, plus deployable artifacts. It will run the following tasks:</p>
<ul>
<li>
<a href="https://github.com/gruntjs/grunt-contrib-clean#readme">Clean</a>:
Expand Down

0 comments on commit a11115d

Please sign in to comment.