Skip to content

Commit

Permalink
0.5.0 - release
Browse files Browse the repository at this point in the history
  • Loading branch information
@anodynos
anodynos committed Aug 9, 2013
1 parent fa93966 commit c3622cc
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 75 deletions.
2 changes: 0 additions & 2 deletions Gruntfile.coffee
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ module.exports = (grunt) ->
simplemocha:
src: ["test/*.test.js"]

## coffeescript compilation no longer need for grunt tasks - they work as is

### shortcuts generation ###
splitTasks = (tasks)-> if !_.isString tasks then tasks else (_.filter tasks.split(' '), (v)-> v)

Expand Down
142 changes: 72 additions & 70 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# grunt-urequire 0.4.6
# grunt-urequire 0.5.0
==============

Grunt wrapper for [uRequire](https://github.com/anodynos/uRequire), version >= v0.4.0
Expand All @@ -15,23 +15,23 @@ uRequire [config objects](http://urequire.org/urequireconfigmasterdefaults.coffe

You can use `grunt-contrib-watch` watch task to invoke a partial build of changed files only.

Notes:
Important notes:

* You need `watch: xxx: options: nospawn: true`.
* You DO need `watch: xxx: options: nospawn: true`.

* You DONT need `urequire: xxx: build: watch: true`

* At each `watch` event there is a *partial build* carried out.
* At each `watch` event there is a *partial build* carried out:

For non-`combined`-templates you are advised to have a full build run before watch (eg run the `urequire:xxx` grunt task before running `watch: xxx: tasks: ['urequire:xxx']`) within the same invocation of grunt. For example run `grunt urequire:xxx watch:xxx`) so that all modules & their dependencies are loaded.
* For non-`combined`-templates you should have a full build before watch, so that all modules & their dependencies are loaded. Plainly put, make sure you run `urequire:xxx` task before `watch: xxx: tasks: ['urequire:xxx']`) within the same invocation of grunt. I.e from CLI run `grunt urequire:xxx watch:xxx`) or create a task that runs both.

For `combined` template builds, a full build is enforced the 1st time by urequire and you SHOULD NOT have run the task before the watch - i.e just use `grunt watch:myCombinedBuildWatchTask` where `watch: myCombinedBuildWatchTask: tasks: ['urequire:myCombinedBuild']`.
* For `combined` template builds, a full build is enforced the 1st time by urequire and you MUST NOT have run the task before the watch - i.e just use `grunt watch:myCombinedBuildWatchTask` where `watch: myCombinedBuildWatchTask: tasks: ['urequire:myCombinedBuild']` and a full build will be enforced on the 1st watch event.

## Examples

### Simple example

Example config (using the new uRequire >= v0.4.0 format) :
Example config (using the uRequire >= v0.4.0 format) :

```javascript

Expand Down Expand Up @@ -69,74 +69,72 @@ Its also using `grunt-contrib-watch` to watch and build changed files as needed

```coffeescript

###
uRequire config for uBerscore is used as a testbed & example, thus so many comments :-)
###
### NOTE: uRequire config is used as a testbed & example, thus so many comments :-) ###
urequire:
# These are the defaults, when a task has no 'derive' at all. Use derive:[] to skip deriving it.
# @note that any urequire task starting with '_' is ignored as a grunt target and only used for `derive`-ing.
# @todo: On derive: a) allow dropping of cyclic references. b) fix file reference paths ALWAYS being relative to the initial path (the path used for 1st file), instead of file referencing.
_defaults:
bundle:
path: "#{sourceDir}"
filez: ['**/*.*', '!**/draft/*.*', '!uRequireConfig*']
copy: [/./]
resources: [ # example: declaring resource converter to perform some 'concat/inject' job.
[ '*inject VERSION to uberscore.js', # inject the VERSION variable inside the module's code, BEFORE running the template
['uberscore.js'] # note we are looking to change the converted `uberscore.js` (not `uberscore.coffee`)
(source)-> """var VERSION = '#{ pkg.version }'; //injected by urequire resource\n
#{source}"""
# no dstFilename converter needed
]

# define some Resource Converters on `resources` key
resources: [
[ # example: declare an RC to perform some 'concat/inject' job.
'~injectVERSION' # inject 'var VERSION=xxx' inside the module's code, BEFORE running the template
['uberscore.coffee'] # note '~' in name means `isMatchSrcFilename:true` - matching `uberscore.coffee`, instead of dstFilename `uberscore.js`
->"var VERSION = '#{pkg.version}';\n#{@converted}" # prepend to @converted (TextResource instance @converted -javascript- code)
] # no convFilename needed
]
dependencies:
node: 'util' # 'util' will not be added to deps array, will be available only on nodejs execution. Same as 'node!myDep'
exports:
bundle: # ['lodash', 'agreement/isAgree'] # simple syntax
'lodash':"_", # precise syntax
'agreement/isAgree': 'isAgree'
node: 'util' # 'util' will not be added to deps array, will be available only on nodejs execution.
# Same as 'node!myDep', but allows module to run on nodejs without conversion
exports: bundle:
# ['lodash', 'agreement/isAgree'] # simple syntax, if depVars can be derived from AMD code
'lodash': "_" # precise syntax
'agreement/isAgree': 'isAgree'

build:
verbose: false # false is default
debugLevel: 40 # 0 is default
# continue: true
#verbose: false # false is default
debugLevel: 30 # 0 is default
#continue: true # false is default

# a simple UMD build
uberscoreUMD:
#'build': # `build` and `bundle` hashes are not needed - keys are safelly recognised, even if they're not in them.
#'derive': ['_defaults'] # not needed - by default it deep uDerives all '_defaults'. To avoid use `derive:[]`.
#template: 'UMD' # Not needed - 'UMD' is default
dstPath: "#{buildDir}"

resources: [ # example: perform some 'concat' job.
[ '*!concat/add banner to uberscore.js', # '!' means 'isAfterTemplate: true'
['uberscore.js'] # note we are looking to change the dstFilename `uberscore.js` (not `uberscore.coffee`)
(source, srcFilename)->"#{banner}\n#{source}"
#no dstFilename converter needed
]
]
dstPath: "#{buildDir}"

resources: [ # example: perform some 'concat' job, AFTER the template conversion is done.
[ '!banner:uberscore.js', # '!' means 'isAfterTemplate: true'
'concat/add banner to uberscore.js' # some description
['uberscore.js'] # note we are looking to change the dstFilename `uberscore.js` (not `uberscore.coffee`). We could have used ~ to match srcFilename
->"#{banner}\n#{@converted}" # @converted holds our converted UMD code, since this RC runs AFTER the template conversion
] # no convFilename needed
]

# a 'combined' build, that also works without AMD loaders on Web
uberscoreDev:
main: 'uberscore' # Tempalte 'combined' requires a 'main' module.
# if 'main' is missing, then main is assumed to be `bundleName`,
# which in turn is assumed to be grunt's @target ('uberscoreDev' in this case).
# Having 'uberscoreDev' as the bundleName/main, but no module by that name (or 'index' or 'main')
# will cause a compilation error.
# Its better to be precise anyway, in case this config is used outside grunt.

dstPath: './build/dist/uberscore-dev.js'
template: 'combined'
main: 'uberscore' # template: 'combined' requires a 'main' module.
# if 'main' is missing, then main is assumed to be `bundleName`,
# which in turn is assumed to be grunt's @target ('uberscoreDev' in this case).
# Having 'uberscoreDev' as the bundle.name/main, but no module by that name (or 'index' or 'main')
# will cause a compilation error. Its better to be precise anyway, in case this config is used outside grunt :-)
dstPath: './build/dist/uberscore-dev.js' # the name of a file instead of a directory is needed for 'combined'


# A combined build, that is `derive`d from 'uberscoreDev' (& specifically '_defaults')
# that uses re.js/uglify2 for minification.
uberscoreMin:
derive: ['uberscoreDev', '_defaults'] # need to specify we also need '_defaults', in this order.
dstPath: './build/dist/uberscore-min.js'
optimize: 'uglify2' # doesn't have to be a String. `true` selects 'uglify2' also. It can also be 'uglify'.
# Even more interestingly, u can pass any 'uglify2' (or 'uglify') keys,
# the r.js way (https://github.com/jrburke/r.js/blob/master/build/example.build.js)
# eg optimize: {uglify2: output: beautify: true}
optimize: 'uglify2' # doesn't have to be a String. `true` selects 'uglify2' also. It can also be 'uglify'.
# Even more interestingly, u can pass any 'uglify2' (or 'uglify') keys,
# the r.js way (https://github.com/jrburke/r.js/blob/master/build/example.build.js)
# eg optimize: {uglify2: output: beautify: true}

# An example on how to reference (`derive`-ing from) external urequire config file(s),
# while overriding some of its options.
Expand All @@ -153,43 +151,47 @@ Its also using `grunt-contrib-watch` to watch and build changed files as needed
# An example of building only a sub-tree of the whole bundle.
# Here we want to build only Logger (& its dependencies) in a 'combined' build using almond.
# So we need `main: 'Logger'`, which is infered from grunt task/target name
# @todo: Its somewhat ineffiecient in urequire 0.4, cause all modules are converted to AMD, used as input to rjs.optimize
# which only picks the dependent ones. Future urequire version should fix this.
Logger: # bundle.main & consequently bundle.name inherit task/target 'Logger' name
# @todo: Its somewhat ineffiecient in urequire 0.5, cause ALL modules are converted to AMD first, used as input to rjs.optimize
# which only picks the dependent ones. Future urequire versions should fix this.
Logger:
#main: 'Logger' # Not needed: bundle.main & consequently bundle.name inherit grunt's task/target 'Logger' name
template: 'combined'
optimize: true
dstPath: 'build/Logger-min.js'

# uRequire-ing the specs: we also have two build as 'UMD' & as 'combined'
spec: # deep inherits all '_defaults', by default :-)
# uRequire-ing the specs: we also have two builds as 'UMD' & as 'combined'
spec: # deep derived from all '_defaults', by default :-)
path: "#{sourceSpecDir}"
copy: [/./, '**/*.*'] # 2 ways to say "I want all non-resource files to be coiped to build.dstPath"
copy: [/./, '**/*.*'] # 2 ways to say "I want all non-`resource` matched files to be copied to build.dstPath"
dstPath: "#{buildSpecDir}"
dependencies:
exports: bundle:
chai: 'chai'
lodash: '_'
uberscore: '_B'
'spec-data': 'data'
# assert = chai.assert # @todo(for uRequire 4 5 5) allow for . notation to refer to export!
dependencies: exports: bundle:
chai: 'chai'
lodash: '_'
uberscore: '_B'
'spec-data': 'data'
# assert = chai.assert # @todo(for uRequire 4 5 5) allow for . notation to refer to export!

specCombined:
derive: ['spec'] # deep inherits all of 'spec' BUT none of '_defaults':-)
derive: ['spec'] # deep inherits all of 'spec' BUT none of '_defaults':-)
dstPath: "#{buildSpecDir}_combined/index-combined.js"
template: 'combined'
#main: 'index' # not needed: if `bundle.main` is undefined it defaults
# to `bundle.bundleName` or 'index' or 'main' (whichever found 1st as a module on bundleRoot)
# with the price of a warning! In spec's case, THERE IS a module 'index.coffee' which is picked.
dependencies:
depsVars:
uberscore: ['_B', 'uberscore']
#main: 'index' # not needed: if `bundle.main` is undefined it defaults to `bundle.bundleName`
# or 'index' or 'main' (whichever found 1st as a module on bundleRoot)
# with the price of a warning! In spec's case, THERE IS a module 'index.coffee' which is picked.
dependencies: depsVars:
uberscore: ['_B', 'uberscore']

watch:
urequireDev:
uberscoreUMD:
files: ["#{sourceDir}/**/*.*", "#{sourceSpecDir}/**/*.*" ] # new subdirs dont work - https://github.com/gruntjs/grunt-contrib-watch/issues/70
tasks: ['urequire:uberscoreDev'] #, 'urequire:spec', 'mocha']
tasks: ['urequire:uberscoreUMD', 'urequire:spec', 'mocha', 'runBuildExample']
options: nospawn: true # urequire watch works only with `nospawn: true`

uberscoreDev:
files: ["#{sourceDir}/**/*.*"]
tasks: ['urequire:uberscoreDev', 'urequire:specCombined', 'mocha', 'runAlmondBuildExample']
options: nospawn: true

```

Look for more documentation on [uRequire.org](http://uRequire.org)'s docs (WIP).
Look for more documentation on [uRequire.org](http://uRequire.org)'s docs.
6 changes: 3 additions & 3 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "grunt-urequire",
"version": "0.4.6",
"version": "0.5.0",
"description": "A Grunt wrapper around uRequire <https://github.com/anodynos/uRequire>",
"main": "tasks/urequire.coffee",
"scripts": {
Expand Down Expand Up @@ -53,7 +53,7 @@

},
"dependencies": {
"uberscore": "0.0.10",
"urequire": "0.4.x"
"uberscore": "0.0.12",
"urequire": "0.5.x"
}
}

0 comments on commit c3622cc

Please sign in to comment.