/*
* @package jscodesniffer
* @author sheiko
* @license MIT
* @copyright (c) Dmitry Sheiko http://www.dsheiko.com
* jscs standard:Jquery
* jshint unused:false
* Code style: http://docs.jquery.com/JQuery_Core_Style_Guidelines
*/
/**
* A module representing a sniffer.
* @module lib/Sniff/SyntaxTree/CompoundStatementConventions
*/
// UMD boilerplate according to https://github.com/umdjs/umd
if ( typeof module === "object" && typeof define !== "function" ) {
/**
* Override AMD `define` function for RequireJS
* @param {function( function, Object, Object )} factory
*/
var define = function ( factory ) {
module.exports = factory( require, exports, module );
};
}
/**
* @param {function( string )} require
*/
define(function ( require ) {
/**
* @type {utilsSniff/Utils}
*/
var utils = require( "../Utils" ),
/**
* @constant
* @type {String}
* @default
*/
NAME = "CompoundStatementConventions",
/**
* @constructor
* @alias module:lib/Sniff/SyntaxTree/CompoundStatementConventions
* @alias module:lib/Sniff/SyntaxTree/ArrayLiteralSpacing
* @param {module:lib/SourceCode} sourceCode
* @param {module:lib/Mediator} mediator
*/
Sniff = function( sourceCode, mediator ) {
/** @lends module:lib/Sniff/SyntaxTree/CompoundStatementConventions.prototype */
return {
/**
* Check the contract
* @access public
* @param {Object} rule
*/
validateRule: function( rule ) {
utils.validateRule( rule, "for", "array" );
utils.validateRule( rule, "requireBraces", "boolean" );
utils.validateRule( rule, "requireMultipleLines", "boolean" );
},
/**
* Run the sniffer according a given rule if a given node type matches the case
* @access public
* @param {Object} rule
* @param {Object} node
*/
run: function( rule, node ) {
if ( rule[ "for" ].indexOf( node.type ) !== -1 ) {
// Conditional statements e.g. IfStatement
if ( node.consequent ) {
this.sniffRequireBraces( node.consequent, rule.requireBraces );
this.sniffRequireMultipleLines( node.consequent, rule.requireMultipleLines );
}
// Iterating statements e.g. ForStatement
if ( node.body ) {
this.sniffRequireBraces( node.body, rule.requireBraces );
this.sniffRequireMultipleLines( node.body, rule.requireMultipleLines );
}
// Special cases e.g. TryStatement
if ( node.block ) {
this.sniffRequireBraces( node.block, rule.requireBraces );
this.sniffRequireMultipleLines( node.block, rule.requireMultipleLines );
}
// SwitchStatement has no block statement reflected in syntax tree
if ( node.type === "SwitchStatement" ) {
this.sniffRequireMultipleLines( node, rule.requireMultipleLines );
}
}
},
/**
* @access protected
* @param {Object} node
* @param {boolean} isRequired
*/
sniffRequireBraces: function( node, isRequired ) {
var code = "CompoundStatementRequireBraces",
excerpt = sourceCode.extract( node[ 0 ], node[ 1 ] );
if ( isRequired && node.type !== "BlockStatement" ) {
mediator.publish( "violation", NAME, code, node.range, node.loc,
{
excerpt: excerpt.get(),
trace: ".." + excerpt.get() + "..",
where: ""
});
}
},
/**
* @access protected
* @param {Object} node
* @param {boolean} isRequired
*/
sniffRequireMultipleLines: function( node, isRequired ) {
var code = "CompoundStatementRequireMultipleLines",
excerpt = sourceCode.extract( node[ 0 ], node[ 1 ] );
if ( isRequired && sourceCode.extract( node.range[ 0 ], node.range[ 1 ] ).find( "\n" ) === -1 ) {
mediator.publish( "violation", NAME, code, node.range, node.loc,
{
excerpt: excerpt.get(),
trace: ".." + excerpt.get() + "..",
where: ""
});
}
}
};
};
return Sniff;
});