docs/checks_brackets.js.html from SimenB/stylint

docs/checks_brackets.js.html
Summary

Maintainability

Test Coverage

Issues
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: checks/brackets.js</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Source: checks/brackets.js</h1>

    



    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>'use strict'

var ignoreRe = /\(.*\)|@extend|\(|if|for(?!\w)|else|return|@block|@media|@import|@require|,$/
var stripRe = /(?=\S)\[\S+\]|(\.|#)\w+/
var equalsRe = /( =|\?=|\+=|-=)+/
var validJSON = require( '../data/valid.json' )


/**
 * @description check for brackets
 * @param {string} [line] curr line being linted
 * @returns {boolean} true if bracket found, false if not
 */
var brackets = function( line ) {
    // in order if:
    // 1 in hash or css block
    // 2 variable or hash or block
    // 3 mixin
    // 4 .selector,
    if ( this.state.hashOrCSS ||
        line.trim().length === 0 ||
        equalsRe.test( line ) ||
        ignoreRe.test( line ) ) {
        return
    }

    var arr = ['hint']
    var isCSS = false
    var isMixin = false
    var bracket = false

    if ( this.state.conf === 'never' ) {
        // ex: $hash = { is ok but .class = { is not
        if ( line.indexOf( '{' ) !== -1 &amp;&amp;
            line.indexOf( '=' ) === -1 &amp;&amp;
            line.indexOf( '}' ) === -1 ) {
            bracket = true
        }
        // ex: } is okay if ending a hash. otherwise it is NOT okay
        // one liners are lame but ok ( check for = { )
        else if ( line.indexOf( '}' ) !== -1 &amp;&amp; line.indexOf( '{' ) === -1 ) {
            bracket = true
        }
    }
    else if ( this.state.conf === 'always' ) {

        if ( bracket === false ) {
            arr = this.splitAndStrip( new RegExp( /[\s\t,:]/ ), line )

            if ( typeof arr[0] !== 'undefined' ) {
                arr[0] = arr[0].replace( stripRe, '' ).trim()

                isCSS = validJSON.css.some( function( css ) {
                    return arr[0] === css || this.checkPrefix( arr[0], css, validJSON )
                }.bind( this ) )

                isMixin = this.cache.customProperties.some( function( mixin ) {
                    return arr[0] === mixin
                } )
            }

            // basically, we don't care about properties like margin or padding
            if ( line.trim().indexOf( '}' ) !== -1 || isCSS || isMixin ) { return }

            if ( line.indexOf( '{' ) !== -1 ) {
                bracket = true
                this.state.openBracket = true
            }
            // ex: } is okay if ending a hash. otherwise it is NOT okay
            else if ( line.indexOf( '}' ) !== -1 &amp;&amp; this.state.openBracket ) {
                bracket = true
                this.state.openBracket = false
            }
        }
    }

    if ( this.state.conf === 'never' &amp;&amp; bracket === true ) {
        this.msg( 'unnecessary bracket', line.indexOf( '{' ) )
    }
    else if ( this.state.conf === 'always' &amp;&amp; bracket === false ) {
        this.msg( 'always use brackets when defining selectors', line.length )
    }

    return bracket
}

module.exports = brackets
</code></pre>
        </article>
    </section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#blocks">blocks</a></li><li><a href="global.html#brackets">brackets</a></li><li><a href="global.html#checkPrefix">checkPrefix</a></li><li><a href="global.html#checkPseudo">checkPseudo</a></li><li><a href="global.html#colons">colons</a></li><li><a href="global.html#colors">colors</a></li><li><a href="global.html#commaSpace">commaSpace</a></li><li><a href="global.html#commentSpace">commentSpace</a></li><li><a href="global.html#config">config</a></li><li><a href="global.html#cssLiteral">cssLiteral</a></li><li><a href="global.html#depthLimit">depthLimit</a></li><li><a href="global.html#done">done</a></li><li><a href="global.html#duplicates">duplicates</a></li><li><a href="global.html#efficient">efficient</a></li><li><a href="global.html#extendPref">extendPref</a></li><li><a href="global.html#getFiles">getFiles</a></li><li><a href="global.html#hashEnd">hashEnd</a></li><li><a href="global.html#hashStart">hashStart</a></li><li><a href="global.html#indentPref">indentPref</a></li><li><a href="global.html#init">init</a></li><li><a href="global.html#keyframesEnd">keyframesEnd</a></li><li><a href="global.html#keyframesStart">keyframesStart</a></li><li><a href="global.html#leadingZero">leadingZero</a></li><li><a href="global.html#lint">lint</a></li><li><a href="global.html#mixed">mixed</a></li><li><a href="global.html#msg">msg</a></li><li><a href="global.html#namingConvention">namingConvention</a></li><li><a href="global.html#noImportant">noImportant</a></li><li><a href="global.html#none">none</a></li><li><a href="global.html#parenSpace">parenSpace</a></li><li><a href="global.html#parse">parse</a></li><li><a href="global.html#placeholders">placeholders</a></li><li><a href="global.html#prefixVarsWithDollar">prefixVarsWithDollar</a></li><li><a href="global.html#quotePref">quotePref</a></li><li><a href="global.html#read">read</a></li><li><a href="global.html#reporter">reporter</a></li><li><a href="global.html#resetOnChange">resetOnChange</a></li><li><a href="global.html#rootEnd">rootEnd</a></li><li><a href="global.html#rootStart">rootStart</a></li><li><a href="global.html#semicolons">semicolons</a></li><li><a href="global.html#setConfig">setConfig</a></li><li><a href="global.html#setContext">setContext</a></li><li><a href="global.html#setState">setState</a></li><li><a href="global.html#sortOrder">sortOrder</a></li><li><a href="global.html#splitAndStrip">splitAndStrip</a></li><li><a href="global.html#stackedProperties">stackedProperties</a></li><li><a href="global.html#startsWithComment">startsWithComment</a></li><li><a href="global.html#state">state</a></li><li><a href="global.html#stylintOff">stylintOff</a></li><li><a href="global.html#stylintOn">stylintOn</a></li><li><a href="global.html#trailingWhitespace">trailingWhitespace</a></li><li><a href="global.html#trimLine">trimLine</a></li><li><a href="global.html#universal">universal</a></li><li><a href="global.html#watch">watch</a></li><li><a href="global.html#zeroUnits">zeroUnits</a></li><li><a href="global.html#zIndexNormalize">zIndexNormalize</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Sun Oct 09 2016 22:18:45 GMT+0200 (CEST)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>