Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/htmlhint/grunt-htmlhint-inline
Grunt plugin for linting inline html
https://github.com/htmlhint/grunt-htmlhint-inline
grunt-plugins htmlhint linter
Last synced: 4 days ago
JSON representation
Grunt plugin for linting inline html
- Host: GitHub
- URL: https://github.com/htmlhint/grunt-htmlhint-inline
- Owner: htmlhint
- License: mit
- Created: 2015-03-03T07:33:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T10:25:53.000Z (2 months ago)
- Last Synced: 2024-11-01T14:40:52.233Z (11 days ago)
- Topics: grunt-plugins, htmlhint, linter
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/grunt-htmlhint-inline
- Size: 314 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
grunt-htmlhint-inline
================
[](https://travis-ci.org/kazu69/grunt-htmlhint-inline)
[](https://nodei.co/npm/grunt-htmlhint-inline/)
This plug-in template files of view ( for example ```.erb``` , etc.) or , you can linting using [htmlhint](https://github.com/yaniswang/HTMLHint) the html of the old type of ```php``` (view and logic are not separated ).
Removes the specific embedded code , it is intended to run the htmlhint as pure html.
## Getting Started
This plugin requires Grunt `~0.4.5`
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-htmlhint-inline --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-htmlhint-inline');
```
## The "htmlhint-inline" task
### Overview
In your project's Gruntfile, add a section named `htmlhint-inline` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
htmlhint_inline: {
options: {
htmlhintrc: '.htmlhintrc',
ignore: {
''
}
},
dest: {
src: ['./test/*.phtml']
}
},
});
```
### Options
#### htmlhintrc
Type: String Default value: null
```htmlhintrc``` file must be a valid JSON.
If you specify this file, options that have been defined in it will be used in the global.
If there is specified in the task options, the options in this file will be overwritten.
```json
{
"tagname-lowercase": true
}
```
#### patterns
Type: Array Default: []
Enable the replacement by the pattern
##### patterns.match
Type: RegExp|String
Indicates the matching expression.
##### patterns.replacement
Type: String|Function
#### reporterOutput
Type: String Default: null
Output the task execution results to a specified file.
#### force
Type: Boolean Default value: false
Report HTMLHint errors but dont fail the task
### Usage Examples
```js
grunt.initConfig({
htmlhint_inline: {
options: {
htmlhintrc: '.htmlhintrc',
ignore: {
''
},
patterns: [
{
match: /hoge/g,
replacement: 'fuga'
}
],
reporterOutput: './log/grunt.log',
},
dest: {
src: ['./test/*.phtml']
}
}
});
```
## License
MIT