Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgan59/grunt-svg-factory-writer
a simple grunt task to handle file writing for svg-factory
https://github.com/mgan59/grunt-svg-factory-writer
Last synced: 2 days ago
JSON representation
a simple grunt task to handle file writing for svg-factory
- Host: GitHub
- URL: https://github.com/mgan59/grunt-svg-factory-writer
- Owner: mgan59
- License: mit
- Created: 2014-02-15T19:03:39.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-02-19T15:30:25.000Z (over 10 years ago)
- Last Synced: 2023-03-11T20:49:23.065Z (over 1 year ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-svg-factory-writer
> The best Grunt plugin ever.
## Getting Started
This plugin requires Grunt `~0.4.2`
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:
```shell
npm install grunt-svg-factory-writer --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-svg-factory-writer');
```
## The "svg_factory_writer" task
### Overview
In your project's Gruntfile, add a section named `svg_factory_writer` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
svg_factory_writer: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
```
### 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({
svg_factory_writer: {
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({
svg_factory_writer: {
options: {
separator: ': ',
punctuation: ' !!!',
},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
});
```
## Contributing
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)_