initial

Author: mrmlnc

Diff for: .gitignore

@@ -0,0 +1,3 @@
+node_modules
+npm-debug.log
+typings

Diff for: .travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: node_js
+node_js:
+  - "0.10"
+  - "0.12"
+  - iojs
+  - "4"
+  - "stable"
+
+before_script:
+  - npm install -g grunt-cli

Diff for: Gruntfile.js

@@ -0,0 +1,46 @@
+/*
+ * grunt-puglint
+ * https://github.com/mrmlnc/grunt-puglint
+ */
+
+'use strict';
+
+module.exports = function (grunt) {
+  grunt.initConfig({
+    puglint: {
+      // Default test with default `clock` config
+      clock: {
+        src: ['test/fixtures/**/*.jade']
+      },
+
+      // Custom config with the string in the options
+      customConfigString: {
+        options: {
+          preset: 'jadelint'
+        },
+        src: ['test/fixtures/**/*.jade']
+      },
+
+      // Custom config with the object in the options
+      customConfigObject: {
+        options: {
+          preset: {
+            disallowIdLiterals: true
+          }
+        },
+        src: ['test/fixtures/**/*.jade']
+      },
+
+      // RC file
+      rcFile: {
+        options: {
+          puglintrc: 'test/fixtures/.pug-lintrc'
+        },
+        src: ['test/fixtures/**/*.jade']
+      }
+    }
+  });
+
+  grunt.loadTasks('tasks');
+  grunt.registerTask('default', ['puglint']);
+};

Diff for: LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Denis Malinochkin
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

Diff for: README.md

@@ -0,0 +1,67 @@
+# grunt-puglint
+
+> Grunt plugin for [pug-lint](https://github.com/pugjs/pug-lint) (formerly Jade).
+
+[![Travis](https://img.shields.io/travis/mrmlnc/grunt-puglint.svg?style=flat-square)](https://travis-ci.org/mrmlnc/grunt-puglint)
+[![NPM version](https://img.shields.io/npm/v/grunt-puglint.svg?style=flat-square)](https://www.npmjs.com/package/grunt-puglint)
+[![devDependency Status](https://img.shields.io/david/mrmlnc/grunt-puglint.svg?style=flat-square)](https://david-dm.org/mrmlnc/grunt-puglint#info=dependencies)
+[![devDependency Status](https://img.shields.io/david/dev/mrmlnc/grunt-puglint.svg?style=flat-square)](https://david-dm.org/mrmlnc/grunt-puglint#info=devDependencies)
+
+## 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-puglint --save-dev
+```
+
+Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
+
+```js
+grunt.loadNpmTasks('grunt-puglint');
+```
+
+## Usage
+
+If you need a clean config settings, then use the object(`preset: {}`) or config file (`puglintrc: '..'`).
+
+```js
+puglint: {
+  taskName: {
+    options: {
+      // The name of the preset: `clock` (default) or `jadelint`
+      preset: 'clock',
+      // If preset is an object, the standard preset is not loaded
+      preset: {
+        disallowHtmlText: true,
+        validateIndentation: 4
+      }
+      // The path to the configuration file
+      puglintrc: 'test/fixtures/.pug-lintrc',
+      // Override preset settings (default: `clock`)
+      disallowHtmlText: true,
+      validateIndentation: 4
+    },
+    src: ['test/fixtures/**/*.jade]
+  }
+
+  // Or short version
+  options: {
+    // ..
+  },
+  taskName: ['...']
+}
+```
+
+## Configuration
+
+Plugin can read [.pug-lintrc file](https://github.com/pugjs/pug-lint#configuration-file).
+
+## Rules
+
+[List of available rules](https://github.com/pugjs/pug-lint/blob/master/docs/rules.md).
+
+## History
+
+  * **v0.1.0** [2015-12-26] - Initial release.

Diff for: lib/formatter.js

@@ -0,0 +1,44 @@
+'use strict';
+
+var path = require('path');
+var chalk = require('chalk');
+var table = require('text-table');
+var cwd = process.cwd();
+
+/**
+ * Formatting string for the table
+ *
+ * @param {Object} item
+ */
+var formatRow = function(item) {
+  // Drop newline symbol in error string
+  item.msg = item.msg.replace('\n', '');
+  // Using zero instead of undefined
+  item.column = (item.column === undefined) ? 0 : item.column;
+  // Drop `PUG:LINT_` prefix in error code
+  item.code = chalk.grey(item.code.replace(/(PUG:|LINT_)/g, ''));
+  // Formatting output
+  var position = chalk.grey(item.line + ':' + item.column);
+  return ['', position, chalk.red('error'), item.msg, item.code];
+};
+
+exports.formatOutput = function(block) {
+  var blockName;
+  var output = [];
+
+  // If the passed block errors is an array
+  if (block.length) {
+    blockName = block[0].filename;
+    block.forEach(function(item) {
+      output.push(formatRow(item));
+    });
+  } else {
+    blockName = block.filename;
+    output.push(formatRow(block));
+  }
+
+  blockName = '\n' + path.join(cwd, blockName);
+
+  console.log(chalk.underline(blockName));
+  console.log(table(output));
+};

Diff for: package.json

@@ -0,0 +1,57 @@
+{
+  "name": "grunt-puglint",
+  "description": "Grunt plugin for pug-lint",
+  "version": "0.1.0",
+  "author": {
+    "name": "Denis Malinochkin",
+    "email": "[email protected]"
+  },
+  "repository": "mrmlnc/grunt-puglint",
+  "license": "MIT",
+  "engines": {
+    "node": ">= 0.8.0"
+  },
+  "scripts": {
+    "test": "ava test/test.js"
+  },
+  "devDependencies": {
+    "ava": "^0.8.0",
+    "grunt": "~0.4.5",
+    "rcloader": "^0.1.4",
+    "xo": "^0.12.1"
+  },
+  "dependencies": {
+    "chalk": "^1.1.1",
+    "pug-lint": "^2.1.1",
+    "text-table": "^0.2.0"
+  },
+  "keywords": [
+    "gruntplugin",
+    "grunt",
+    "pug",
+    "pug lint",
+    "pug hint",
+    "jade",
+    "jade lint",
+    "jade hint",
+    "lint",
+    "hint"
+  ],
+  "files": [
+    "tasks",
+    "lib"
+  ],
+  "xo": {
+    "space": true,
+    "rules": {
+      "object-curly-spacing": [
+        2,
+        "always"
+      ],
+      "space-before-function-paren": 0
+    },
+    "envs": [
+      "node"
+    ]
+  }
+}

Diff for: tasks/puglint.js

@@ -0,0 +1,50 @@
+/*
+ * grunt-puglint
+ * https://github.com/mrmlnc/grunt-puglint
+ */
+
+'use strict';
+
+var PugLint = require('pug-lint');
+var linter = new PugLint();
+var formatter = require('../lib/formatter');
+
+module.exports = function(grunt) {
+  grunt.registerMultiTask('puglint', 'Grunt plugin for pug-lint', function () {
+    var done = this.async();
+    var options = this.options({
+      preset: 'clock'
+    });
+
+    if (typeof options.preset === 'object') {
+      options = options.preset;
+    }
+
+    var pugLintRc = options.puglintrc;
+    if (pugLintRc) {
+      if (grunt.file.exists(pugLintRc)) {
+        options = grunt.file.readJSON(pugLintRc);
+      } else {
+        grunt.log.error('Configuration file not found. Used a standard config: `clock`.');
+      }
+    }
+
+    linter.configure(options);
+
+    if (this.filesSrc.length === 0) {
+      done();
+      return;
+    }
+
+    var errors = [];
+    this.filesSrc.forEach(function(filepath) {
+      errors = linter.checkFile(filepath);
+
+      if (errors.length) {
+        formatter.formatOutput(errors);
+      }
+    });
+
+    done(errors.length === 0);
+  });
+};

Diff for: test/fixtures/.pug-lintrc

@@ -0,0 +1,3 @@
+{
+  "requireClassLiteralsBeforeIdLiterals": true
+}

Diff for: test/fixtures/invalid.jade

@@ -0,0 +1,23 @@
+doctype html
+html(lang='en')
+  head
+    title= pageTitle
+    script(type='text/javascript').
+      if (foo) {
+         bar(1 + 5)
+      }
+  body
+    h1 Jade - node template engine
+    #container.col
+      if youAreUsingJade
+        p You are amazing
+      else
+        p Get on it!
+
+      br(role='invalid')
+
+      p.
+        Jade is a terse and simple
+        templating language with a
+        strong focus on performance
+        and powerful features.

Diff for: test/test.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const test = require('ava');
+const exec = require('child_process').exec;
+
+test.cb('Default test with default `clock` config', function(t) {
+  exec('grunt puglint:clock', function(err, stdout) {
+    var isOneError = /ID literals must/.test(stdout.toString());
+    var isTwoError = /REQUIRECLASSLITERALSBEFOREIDLITERALS/.test(stdout.toString());
+
+    t.same(isOneError && isTwoError, true);
+    t.end();
+  });
+});
+
+test.cb('Custom config with the string in the options', function(t) {
+  exec('grunt puglint:customConfigString', function(err, stdout) {
+    var isOneError = /DISALLOWSPECIFICATTRIBUTES/.test(stdout.toString());
+
+    t.same(isOneError, true);
+    t.end();
+  });
+});
+
+test.cb('Custom config with the object in the options', function(t) {
+  exec('grunt puglint:customConfigObject', function(err, stdout) {
+    var isOneError = /DISALLOWIDLITERALS/.test(stdout.toString());
+
+    t.same(isOneError, true);
+    t.end();
+  });
+});
+
+test.cb('RC file', function(t) {
+  exec('grunt puglint:rcFile', function(err, stdout) {
+    var isOneError = /REQUIRECLASSLITERALSBEFOREIDLITERALS/.test(stdout.toString());
+
+    t.same(isOneError, true);
+    t.end();
+  });
+});