Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/christianrondeau/grunt-unfold

Grunt task for inserting script tags based on a folder path or file pattern
https://github.com/christianrondeau/grunt-unfold

grunt grunt-plugins javascript template

Last synced: 27 days ago
JSON representation

Grunt task for inserting script tags based on a folder path or file pattern

Host: GitHub
URL: https://github.com/christianrondeau/grunt-unfold
Owner: christianrondeau
License: mit
Created: 2014-03-25T03:15:47.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2023-04-17T13:42:17.000Z (over 1 year ago)
Last Synced: 2024-04-14T13:12:53.916Z (9 months ago)
Topics: grunt, grunt-plugins, javascript, template
Language: JavaScript
Size: 71.3 KB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# grunt-unfold

> Inserts script tags based on a folder path or file pattern

[![Build Status](https://travis-ci.org/christianrondeau/grunt-unfold.svg?branch=master)](https://travis-ci.org/christianrondeau/grunt-unfold)

## Getting Started

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-unfold --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-unfold');
```

## The "unfold" task

### Overview
_Run this task with the `grunt unfold` command._

This will detect ` ... ` blocks in your html files and rebuild the list of script tags from the matching files.

* **PATH** is a globbing pattern, such as \*.js, scripts/\*\*/\*.js etc.
* **TYPE** defines the tag template to insert;
* **js** inserts a ``
* **css** inserts a ``
* **img** inserts a ``

### Options

#### templates

You can define a custom template for existing and custom types. You need to define the `$PATH$` variable in the template where you want the source path to be inserted.

```js
grunt.initConfig({
unfold: {
options: {
templates: {
'async-js': {
template: ''
}
}
},
files: {
src: 'index.html'
}
},
})
```

### Usage Example

#### In "Gruntfile.js", to overwrite the file

```js
grunt.initConfig({
unfold: {
files: {
src: 'index.html'
}
},
})
```

#### In "Gruntfile.js", to write to another file

Keep in mind that you can also provide a globbing pattern as the source and a folder as the destination.

```js
grunt.initConfig({
unfold: {
files: {
src: 'src/index.html',
dest: 'dist/index.html'
}
},
})
```

#### In "index.html"

```html

This will be overwritten by all css files in style/*.css and css/*.css

This will be overwritten by all .js files in scripts/ and its subfolders

```

## License

## Thanks

Thanks to Scott Laursen for [grunt-scriptlinker](http://github.com/scott-laursen/grunt-scriptlinker), from which this project was greatly inspired.