Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anseki/grunt-htmlclean
Simple and safety HTML/SVG cleaner to minify without changing its structure.
https://github.com/anseki/grunt-htmlclean
clean comment compress grunt grunt-plugins gruntplugin html javascript lightweight linebreak minify svg unneeded-whitespaces whitespace
Last synced: 7 days ago
JSON representation
Simple and safety HTML/SVG cleaner to minify without changing its structure.
- Host: GitHub
- URL: https://github.com/anseki/grunt-htmlclean
- Owner: anseki
- License: mit
- Created: 2013-08-27T11:51:09.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T01:52:46.000Z (5 months ago)
- Last Synced: 2024-09-21T08:57:53.235Z (about 2 months ago)
- Topics: clean, comment, compress, grunt, grunt-plugins, gruntplugin, html, javascript, lightweight, linebreak, minify, svg, unneeded-whitespaces, whitespace
- Language: JavaScript
- Homepage:
- Size: 201 KB
- Stars: 11
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-htmlclean
[](https://www.npmjs.com/package/grunt-htmlclean) [](https://github.com/anseki/grunt-htmlclean/issues) [](package.json) [](LICENSE)
This [Grunt](http://gruntjs.com/) plugin is wrapper of [htmlclean](https://github.com/anseki/htmlclean).
* [gulp](http://gulpjs.com/) plugin: [gulp-htmlclean](https://github.com/anseki/gulp-htmlclean)
* [webpack](https://webpack.js.org/) loader: [htmlclean-loader](https://github.com/anseki/htmlclean-loader)
**If you want to just clean files, [Command Line Tool](https://github.com/anseki/htmlclean-cli) is easy way.**
Simple and safety HTML/SVG cleaner to minify without changing its structure.
See [htmlclean](https://github.com/anseki/htmlclean) for options and more information about htmlclean.
## Getting Started
This plugin requires Grunt `~0.4.1`
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-htmlclean --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-htmlclean');
```
## Usage
In your project's Gruntfile, add a section named `htmlclean` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
htmlclean: {
options: {
protect: /<\!--%fooTemplate\b.*?%-->/g,
edit: function(html) { return html.replace(/\begg(s?)\b/ig, 'omelet$1'); }
},
deploy: {
expand: true,
cwd: 'develop/',
src: '**/*.html',
dest: 'public_html/'
}
}
});
```
See [htmlclean](https://github.com/anseki/htmlclean#options) for the options.
## Working with grunt-task-helper
For example, you want to clean only changed HTML files. Then [grunt-task-helper](https://github.com/anseki/grunt-task-helper) helps it. In this case, using `handlerByContent` Function instead of this plugin is better. Because grunt parses `files` components in every tasks(targets). `handlerByContent` can be included to one task with other handlers (e.g. select changed HTML files).
See [grunt-task-helper](https://github.com/anseki/grunt-task-helper).
Example:
`Gruntfile.js`
```js
grunt.initConfig({
taskHelper: {
deploy: {
options: {
// Select files which are newer than `dest`.
handlerByFile: 'newFile',
// Clean the selected files.
handlerByContent: require('grunt-htmlclean/node_modules/htmlclean')
//handlerByContent: require('htmlclean') // If htmlclean is already installed. (Not grunt-htmlclean)
},
expand: true,
cwd: 'develop/',
src: '**/*.html',
dest: 'public_html/'
}
}
});
```