SimenB/stylint

View on GitHub
docs/core_config.js.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: core/config.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: core/config.js</h1>

    



    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>/**
 * default configuration object
 * this is what the linter will run when no config file is passed
 */
var config = {
    // check for @block when defining blocks
    blocks: false,
    // check for { or }, unless used in a hash
    brackets: 'never',
    // enforce or disallow colons
    colons: 'always',
    // check for hex colors used without variables
    colors: 'always',
    // check for spaces after commas (0, 0, 0, .18)
    commaSpace: 'always',
    // check for space after line comment
    commentSpace: 'always',
    // if never disallow css literals
    cssLiteral: 'never',
    // set a maximum selector depth (dont nest more than 4 deep)
    depthLimit: false,
    // check if properties or selectors are duplicate
    duplicates: true,
    // check for margin 0 0 0 0 and recommend margin 0
    efficient: 'always',
    // prefer a specific syntax when using @extends (or @extend)
    extendPref: false,
    // throw duplicate selector warning across all files instead of curr file
    globalDupe: false,
    // group reporter output by file or go sequentially
    groupOutputByFile: true,
    // manipulate terminal output with or without an additional reporter
    reporterOptions: {
        columns: ['lineData', 'severity', 'description', 'rule'],
        columnSplitter: '  ',
        showHeaders: false,
        truncate: true
    },
    // how many spaces should we prefer when indenting, pass in false if hard tabs
    indentPref: false,
    // enforce or disallow leading zeroes
    leadingZero: 'never',
    // exit if over error limit
    maxErrors: false,
    // exit if over warning limit
    maxWarnings: false,
    // check for mixed spaces and tabs
    mixed: false,
    // lowercase-dash, camelCase, lowercase_underscore, BEM or false (dont check)
    namingConvention: false,
    // if true, then check classes and ids, if false just check variables
    namingConventionStrict: false,
    // check for use of border none or outline none, prefer 0
    none: 'never',
    // disallow !importants
    noImportant: true,
    // check for extra space inside parens
    parenSpace: false,
    // only allow @extending of placeholder vars
    placeholders: 'always',
    // check for $ when declaring vars (doesnt check use)
    prefixVarsWithDollar: 'always',
    // single or double quotes, or false to not check
    quotePref: false,
    // default reporter
    reporter: '../core/reporter',
    // disallow or enforce semicolons
    semicolons: 'never',
    // alphabetical, grouped, Array&lt;String> or false (no check)
    sortOrder: 'alphabetical',
    // no one liners
    stackedProperties: 'never',
    // check for trailing whitespace
    trailingWhitespace: 'never',
    // check for use of * and recommend against it
    universal: false,
    // check if prop or value is a valid assignment
    valid: true,
    // check for use of 0px | 0em | 0rem | 0% | etc and recommend 0 instead
    zeroUnits: 'never',
    // suggest a normalized z index value, base of whatever this is
    zIndexNormalize: false
}

module.exports = config
</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>