echo-fecs/lib/js/rules/properties-quote.js

Front End Code Style Suite

/**
 * @file Rule to validate object properties
 * @author chris<wfsr@foxmail.com>
 */

//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------

var reserved = require('reserved-words');

module.exports = function (context) {
    'use strict';

    var NO_QUOTES = 'Expected key `{{name}}` but `\'{{name}}\'` found.baidu094';
    var NEED_QUOTES = 'Expected key `\'{{name}}\'` but `{{name}}` found.baidu095';

    var options = context.options[0] || {};
    var ignore = options.ignore || [];
    var esVerioin = options.esVersion || 5;

    function reducer(map, key) {
        map[key] = true;
        return map;
    }

    var ignores = (Array.isArray(ignore) ? ignore : [ignore]).reduce(reducer, Object.create(null));

    /**
     * Check SpreadProperty Node
     *
     * @param {Property} property property node
     * @return {boolean} [return description]
     */
    function isSpreadProperty(property) {
        return property.type === 'SpreadProperty'
            || property.type === 'SpreadElement'
            || property.type === 'ExperimentalSpreadProperty'
            || property._babelType === 'SpreadProperty';
    }

    function getKey(property) {
        var key = property.key;

        return isSpreadProperty(property)
            ? property.argument.name
            : (key.name || (typeof key.value === 'number' ? key.raw : key.value));
    }

    function requireQuotes(needs, key) {
        var reg = /(^\d+\D+|[^\$\w]|^0[0-7]+|^0x[a-zA-Z\d]+)/;

        if (reg.test(key) || reserved.check(key, esVerioin)) {
            needs.push(key);
        }
    }

    return {

        ObjectExpression: function (node) {

            var needs = [];
            var type = {literal: [], identifier: []};

            node.properties.forEach(function (property) {
                var key = getKey(property);

                if (isSpreadProperty(property)
                    || property.method
                    || property.computed
                    || property.shorthand
                    || property.kind === 'set'
                    || property.kind === 'get'
                    || ignores[key]
                ) {
                    return;
                }

                var keyType = property.key.type.toLowerCase();
                if (keyType === 'literal' && typeof property.key.value === 'number') {
                    keyType = 'identifier';
                }

                type[keyType].push(property);
                requireQuotes(needs, key);
            });

            var hadToQuote = !!needs.length;
            var message = hadToQuote ? NEED_QUOTES : NO_QUOTES;

            type[hadToQuote ? 'identifier' : 'literal'].forEach(function (property) {
                context.report(
                    property,
                    message,
                    {name: getKey(property)}
                );
            });
        }
    };

};

module.exports.schema = [
    {
        type: 'object',
        properties: {
            ignore: {
                oneOf: [
                    {
                        type: 'string'
                    },
                    {
                        type: 'array',
                        items: {
                            type: 'string'
                        }
                    }
                ]
            },
            esVersion: {
                'enum': ['es3', 3, 'es5', 5, 'es2015', 'es6', 6, 'es7', 7, 'next', 'default']
            }
        }
    }
];