support this.file api
This commit is contained in:
Tyler Kellen
parent
112efb4455
commit
a9a04260ff
@ -1,73 +1 @@
|
||||
[Grunt homepage](http://gruntjs.com/) | [Documentation table of contents](https://github.com/gruntjs/grunt/blob/devel/docs/toc.md)
|
||||
|
||||
# Contributing to grunt
|
||||
|
||||
There are a number of grunt projects.
|
||||
|
||||
* [grunt](https://github.com/gruntjs/grunt) - the main grunt project
|
||||
* [gruntjs.com](https://github.com/gruntjs/gruntjs.com) - the gruntjs.com website
|
||||
* [grunt-contrib collection](https://github.com/gruntjs/grunt-contrib) - a collection of all grunt "contrib" plugins
|
||||
|
||||
In addition, each individual grunt-contrib plugin is a separate repository listed on the [gruntjs org homepage](https://github.com/gruntjs).
|
||||
|
||||
## Filing issues
|
||||
If something isn't working like you think it should, please read the documentation first. If you'd like to chat with someone, [pop into IRC](#discussing-grunt) and ask your question there.
|
||||
|
||||
The best way to ensure an issue gets addressed is to file it in the appropriate issues tracker.
|
||||
|
||||
**If there's an issue with a specific grunt-contrib plugin:**
|
||||
Please file an issue on that plugin's issues tracker.
|
||||
|
||||
**If you'd like to contribute a new plugin:**
|
||||
Please file an issue on the [grunt-contrib collection issues tracker](https://github.com/gruntjs/grunt-contrib/issues). We don't accept all plugins, but we'll certainly consider yours.
|
||||
|
||||
**If there's an issue with the [website](http://gruntjs.com/):**
|
||||
Please file an issue on the [gruntjs.com website issues tracker](https://github.com/gruntjs/gruntjs.com/issues).
|
||||
|
||||
**If there's an issue that isn't specific to any of the above:**
|
||||
Please file an issue on the [grunt issues tracker](https://github.com/gruntjs/grunt/issues).
|
||||
|
||||
### Simplify the issue
|
||||
Try to [reduce your code](http://www.webkit.org/quality/reduction.html) to the bare minimum required to reproduce the issue. This makes it much easier (and much faster) to isolate and fix the issue.
|
||||
|
||||
### Explain the issue
|
||||
If we can't reproduce the issue, we can't fix it. Please list the exact steps required to reproduce the issue. Include versions of your OS, Node.js, grunt, etc. Include relevant logs or sample code.
|
||||
|
||||
## Discussing grunt
|
||||
Join the [freenode](http://freenode.net/) IRC #grunt channel. We've got a bot and everything.
|
||||
|
||||
_No private messages, please._
|
||||
|
||||
## Modifying grunt
|
||||
First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
|
||||
|
||||
1. Fork and clone the repo.
|
||||
1. Check out the correct branch. Currently, grunt development happens in the `devel` branch.
|
||||
1. Run `npm install` to install all grunt dependencies.
|
||||
1. Run `npm link` to put the dev version of grunt in the system path (this is only needed for developing grunt, not for plugins or the website).
|
||||
1. Run `grunt` to grunt grunt.
|
||||
|
||||
Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing breaks.
|
||||
|
||||
### Submitting pull requests
|
||||
|
||||
1. Create a new branch, please don't work in your `master` or `devel` branch directly.
|
||||
1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
|
||||
1. Fix stuff.
|
||||
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
|
||||
1. Update the documentation to reflect any changes.
|
||||
1. Push to your fork and submit a pull request.
|
||||
|
||||
### Syntax
|
||||
|
||||
* Two space indents. Don't use tabs anywhere. Use `\t` if you need a tab character in a string.
|
||||
* No trailing whitespace, except in markdown files where a linebreak must be forced.
|
||||
* Don't go overboard with the whitespace.
|
||||
* No more than [one assignment](http://benalman.com/news/2012/05/multiple-var-statements-javascript/) per `var` statement.
|
||||
* Delimit strings with single-quotes `'`, not double-quotes `"`.
|
||||
* Prefer `if` and `else` to ["clever"](http://programmers.stackexchange.com/a/25281) uses of `? :` conditional or `||`, `&&` logical operators.
|
||||
* Comments are great. Just put them _before_ the line of code, _not_ at the _end_ of the line.
|
||||
* **When in doubt, follow the conventions you see used in the source already.**
|
||||
|
||||
### Reverting back to the "official" grunt
|
||||
If you've used `npm link` to put a dev version of grunt in the system path and, for some reason, need to revert back to the current official grunt release, just reinstall grunt globally with `npm install -g grunt`
|
||||
Please see the [Contributing to grunt](http://gruntjs.com/contributing) guide for information on contributing to this project.
|
||||
|
||||
44
README.md
44
README.md
@ -2,31 +2,20 @@
|
||||
|
||||
> Precompile Underscore templates to JST file.
|
||||
|
||||
_Note that this plugin has not yet been released, and only works with the latest bleeding-edge, in-development version of grunt. See the [When will I be able to use in-development feature 'X'?](https://github.com/gruntjs/grunt/blob/devel/docs/faq.md#when-will-i-be-able-to-use-in-development-feature-x) FAQ entry for more information._
|
||||
|
||||
## Getting Started
|
||||
_If you haven't used [grunt][] before, be sure to check out the [Getting Started][] guide._
|
||||
If you haven't used [grunt][] before, be sure to check out the [Getting Started][] guide, as it explains how to create a [gruntfile][Getting Started] as well as install and use grunt plugins. Once you're familiar with that process, install this plugin with this command:
|
||||
|
||||
From the same directory as your project's [Gruntfile][Getting Started] and [package.json][], install this plugin with the following command:
|
||||
|
||||
```bash
|
||||
```shell
|
||||
npm install grunt-contrib-jst --save-dev
|
||||
```
|
||||
|
||||
Once that's done, add this line to your project's Gruntfile:
|
||||
|
||||
```js
|
||||
grunt.loadNpmTasks('grunt-contrib-jst');
|
||||
```
|
||||
|
||||
If the plugin has been installed correctly, running `grunt --help` at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a `devDependency`, which ensures that it will be installed whenever the `npm install` command is run.
|
||||
|
||||
[grunt]: http://gruntjs.com/
|
||||
[Getting Started]: https://github.com/gruntjs/grunt/blob/devel/docs/getting_started.md
|
||||
[package.json]: https://npmjs.org/doc/json.html
|
||||
|
||||
|
||||
## The jst task
|
||||
## Jst task
|
||||
_Run this task with the `grunt jst` command._
|
||||
|
||||
### Overview
|
||||
|
||||
@ -46,7 +35,7 @@ grunt.initConfig({
|
||||
```
|
||||
### Options
|
||||
|
||||
## files
|
||||
#### files
|
||||
Type: `Object`
|
||||
|
||||
This defines what files this task will process and should contain key:value pairs.
|
||||
@ -55,13 +44,13 @@ The key (destination) should be an unique filepath (supports [grunt.template](ht
|
||||
|
||||
Note: Values are precompiled to the namespaced JST array in the order passed.
|
||||
|
||||
## options.namespace
|
||||
#### options.namespace
|
||||
Type: `String`
|
||||
Default: 'JST'
|
||||
|
||||
The namespace in which the precompiled templates will be asssigned. *Use dot notation (e.g. App.Templates) for nested namespaces.*
|
||||
|
||||
## options.processName
|
||||
#### options.processName
|
||||
Type: ```function```
|
||||
Default: null
|
||||
|
||||
@ -75,7 +64,7 @@ options: {
|
||||
}
|
||||
```
|
||||
|
||||
## options.templateSettings
|
||||
#### options.templateSettings
|
||||
Type: ```Object```
|
||||
Default: null
|
||||
|
||||
@ -114,13 +103,14 @@ jst: {
|
||||
|
||||
## Release History
|
||||
|
||||
* 2012-10-11 - v0.3.1 - Rename grunt-contrib-lib dep to grunt-lib-contrib.
|
||||
* 2012-08-22 - v0.3.0 - Options no longer accepted from global config key.
|
||||
* 2012-08-15 - v0.2.3 - Support for nested namespaces.
|
||||
* 2012-08-11 - v0.2.2 - Added processName functionality & escaping single quotes in filenames.
|
||||
* 2012-08-09 - v0.2.0 - Refactored from grunt-contrib into individual repo.
|
||||
* 2012-10-11 v0.3.1 Rename grunt-contrib-lib dep to grunt-lib-contrib.
|
||||
* 2012-08-22 v0.3.0 Options no longer accepted from global config key.
|
||||
* 2012-08-15 v0.2.3 Support for nested namespaces.
|
||||
* 2012-08-11 v0.2.2 Added processName functionality & escaping single quotes in filenames.
|
||||
* 2012-08-09 v0.2.0 Refactored from grunt-contrib into individual repo.
|
||||
|
||||
--
|
||||
Task submitted by <a href="http://tbranyen.com">Tim Branyen</a>.
|
||||
---
|
||||
|
||||
*Generated on Thu Oct 18 2012 19:03:04.*
|
||||
Task submitted by [Tim Branyen](http://tbranyen.com)
|
||||
|
||||
*This file was generated on Tue Nov 13 2012 16:12:13.*
|
||||
|
||||
38
tasks/jst.js
38
tasks/jst.js
@ -29,31 +29,29 @@ module.exports = function(grunt) {
|
||||
grunt.verbose.writeflags(options, 'Options');
|
||||
|
||||
var compiled, srcFiles, src, filename;
|
||||
var output = [];
|
||||
var nsInfo = helpers.getNamespaceDeclaration(options.namespace);
|
||||
|
||||
this.files.forEach(function(files) {
|
||||
srcFiles = grunt.file.expandFiles(files.src);
|
||||
srcFiles.forEach(function(file) {
|
||||
src = grunt.file.read(file);
|
||||
var files = grunt.file.expandFiles(this.file.src);
|
||||
var output = files.map(function(file) {
|
||||
var src = grunt.file.read(file);
|
||||
|
||||
try {
|
||||
compiled = _.template(src, false, options.templateSettings).source;
|
||||
} catch (e) {
|
||||
grunt.log.error(e);
|
||||
grunt.fail.warn('JST failed to compile.');
|
||||
}
|
||||
|
||||
filename = processName(file);
|
||||
output.push(nsInfo.namespace+'['+JSON.stringify(filename)+'] = '+compiled+';');
|
||||
});
|
||||
|
||||
if(output.length > 0) {
|
||||
output.unshift(nsInfo.declaration);
|
||||
grunt.file.write(files.dest, output.join('\n\n'));
|
||||
grunt.log.writeln('File "' + files.dest + '" created.');
|
||||
try {
|
||||
compiled = _.template(src, false, options.templateSettings).source;
|
||||
} catch (e) {
|
||||
grunt.log.error(e);
|
||||
grunt.fail.warn('JST failed to compile.');
|
||||
}
|
||||
|
||||
filename = processName(file);
|
||||
|
||||
return nsInfo.namespace+'['+JSON.stringify(filename)+'] = '+compiled+';';
|
||||
});
|
||||
|
||||
if(output.length > 0) {
|
||||
output.unshift(nsInfo.declaration);
|
||||
grunt.file.write(this.file.dest, output.join('\n\n'));
|
||||
grunt.log.writeln('File "' + this.file.dest + '" created.');
|
||||
}
|
||||
|
||||
});
|
||||
};
|
||||
|
||||
Loading…
Reference in New Issue
Block a user