grunt-swig-it
Advanced tools
grunt-swig-it - npm Package Compare versions
Comparing version 0.0.1 to 0.0.2
| { | ||
| "name": "grunt-swig-it", | ||
| "description": "Create static HTML files using Swig", | ||
| "version": "0.0.1", | ||
| "version": "0.0.2", | ||
| "homepage": "https://github.com/adamsilver/grunt-swig-it", | ||
@@ -6,0 +6,0 @@ "license": "MIT", |
@@ -6,3 +6,3 @@ # grunt-swig-it | ||
| ## Getting Started | ||
| This plugin requires Grunt `0.4.5` | ||
| This plugin requires Grunt `0.4.1` | ||
@@ -29,59 +29,17 @@ If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command: | ||
| swig_it: { | ||
| options: { | ||
| // Task-specific options go here. | ||
| }, | ||
| your_target: { | ||
| // Target-specific file lists and/or options go here. | ||
| }, | ||
| }, | ||
| development: { | ||
| init: { | ||
| allowErrors: false, | ||
| autoescape: true | ||
| }, | ||
| test: { | ||
| var: 'short path file' | ||
| }, | ||
| dest: "dest", | ||
| src: ['src/swig/**/*.html'] | ||
| } | ||
| } | ||
| }); | ||
| ``` | ||
| ### Options | ||
| #### options.separator | ||
| Type: `String` | ||
| Default value: `', '` | ||
| A string value that is used to do something with whatever. | ||
| #### options.punctuation | ||
| Type: `String` | ||
| Default value: `'.'` | ||
| A string value that is used to do something else with whatever else. | ||
| ### Usage Examples | ||
| #### Default Options | ||
| In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.` | ||
| ```js | ||
| grunt.initConfig({ | ||
| swig_it: { | ||
| options: {}, | ||
| files: { | ||
| 'dest/default_options': ['src/testing', 'src/123'], | ||
| }, | ||
| }, | ||
| }); | ||
| ``` | ||
| #### Custom Options | ||
| In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!` | ||
| ```js | ||
| grunt.initConfig({ | ||
| swig_it: { | ||
| options: { | ||
| separator: ': ', | ||
| punctuation: ' !!!', | ||
| }, | ||
| files: { | ||
| 'dest/default_options': ['src/testing', 'src/123'], | ||
| }, | ||
| }, | ||
| }); | ||
| ``` | ||
| ## Contributing | ||
@@ -91,2 +49,2 @@ In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/). | ||
| ## Release History | ||
| _(Nothing yet)_ | ||
| _(Nothing yet)_ |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by5%
44125
Worsened metrics
- Number of lines in readme file
- decreased by-47.78%
47