aristath / kirki

modules/field-dependencies/field-dependencies.js

var kirkiDependencies = {

This file is missing a doc comment.

	listenTo: {},

	init: function() {
		var self = this;

		wp.customize.control.each( function( control ) {

The opening parenthesis of a multi-line function call should be the last content on the line.

			self.showKirkiControl( control );
		} );

For multi-line function calls, the closing parenthesis should be on a new line.

		_.each( self.listenTo, function( slaves, master ) {

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			_.each( slaves, function( slave ) {

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

				wp.customize( master, function( setting ) {

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

					var setupControl = function( control ) {
						var setActiveState,
							isDisplayed;

						isDisplayed = function() {
							return self.showKirkiControl( wp.customize.control( slave ) );
						};
						setActiveState = function() {
							control.active.set( isDisplayed() );
						};

						setActiveState();
						setting.bind( setActiveState );
						control.active.validate = isDisplayed;
					};
					wp.customize.control( slave, setupControl );
				} );

For multi-line function calls, the closing parenthesis should be on a new line.

			} );

For multi-line function calls, the closing parenthesis should be on a new line.

		} );

For multi-line function calls, the closing parenthesis should be on a new line.

	},

	/**
	 * Should we show the control?
	 *
	 * @since 3.0.17
	 * @param {string|object} control - The control-id or the control object.
	 * @returns {bool}
	 */
	showKirkiControl: function( control ) {
		var self     = this,
			show     = true,
			isOption = (
				control.params && // Check if control.params exists.
				control.params.kirkiOptionType &&  // Check if option_type exists.

Expected 1 space after "&&"; 2 found

				'option' === control.params.kirkiOptionType &&  // We're using options.

Expected 1 space after "&&"; 2 found

				control.params.kirkiOptionName && // Check if option_name exists.
				! _.isEmpty( control.params.kirkiOptionName ) // Check if option_name is not empty.
			),
			i;

Functions must not contain multiple empty lines in a row; found 2 empty lines

		if ( _.isString( control ) ) {
			control = wp.customize.control( control );
		}

		// Exit early if control not found or if "required" argument is not defined.
		if ( 'undefined' === typeof control || ( control.params && _.isEmpty( control.params.required ) ) ) {
			return true;
		}

		// Loop control requirements.
		for ( i = 0; i < control.params.required.length; i++ ) {

The use of object.length inside a loop condition is not allowed; assign the return value to a variable and use the variable in the loop condition instead

			if ( ! self.checkCondition( control.params.required[ i ], control, isOption, 'AND' ) ) {
				show = false;
			}
		}
		return show;
	},

	/**
	 * Check a condition.
	 *
	 * @param {Object} requirement - The requirement, inherited from showKirkiControl.
	 * @param {Object} control - The control object.
	 * @param {bool}   isOption - Whether it's an option or not.
	 * @param {string} relation - Can be one of 'AND' or 'OR'.
	 */
	checkCondition: function( requirement, control, isOption, relation ) {
		var self          = this,
			childRelation = ( 'AND' === relation ) ? 'OR' : 'AND',
			nestedItems,
			i;

		// Tweak for using active callbacks with serialized options instead of theme_mods.
		if ( isOption && requirement.setting ) {

			// Make sure we don't already have the option_name in there.
			if ( -1 === requirement.setting.indexOf( control.params.kirkiOptionName + '[' ) ) {
				requirement.setting = control.params.kirkiOptionName + '[' + requirement.setting + ']';
			}
		}

		// If an array of other requirements nested, we need to process them separately.
		if ( 'undefined' !== typeof requirement[0] && 'undefined' === typeof requirement.setting ) {
			nestedItems = [];

			// Loop sub-requirements.
			for ( i = 0; i < requirement.length; i++ ) {

The use of object.length inside a loop condition is not allowed; assign the return value to a variable and use the variable in the loop condition instead

				nestedItems.push( self.checkCondition( requirement[ i ], control, isOption, childRelation ) );
			}

			// OR relation. Check that true is part of the array.
			if ( 'OR' === childRelation ) {
				return ( -1 !== nestedItems.indexOf( true ) );
			}

			// AND relation. Check that false is not part of the array.
			return ( -1 === nestedItems.indexOf( false ) );
		}

		// Early exit if setting is not defined.
		if ( 'undefined' === typeof wp.customize.control( requirement.setting ) ) {
			return true;
		}

		self.listenTo[ requirement.setting ] = self.listenTo[ requirement.setting ] || [];
		if ( -1 === self.listenTo[ requirement.setting ].indexOf( control.id ) ) {
			self.listenTo[ requirement.setting ].push( control.id );
		}

		return self.evaluate(
			requirement.value,
			wp.customize.control( requirement.setting ).setting._value,
			requirement.operator
		);
	},

	/**
	 * Figure out if the 2 values have the relation we want.
	 *
	 * @since 3.0.17
	 * @param {mixed} value1 - The 1st value.
	 * @param {mixed} value2 - The 2nd value.
	 * @param {string} operator - The comparison to use.
	 * @returns {bool}
	 */
	evaluate: function( value1, value2, operator ) {
		var found = false;

		if ( '===' === operator ) {
			return value1 === value2;
		}
		if ( '==' === operator || '=' === operator || 'equals' === operator || 'equal' === operator ) {
			return value1 == value2;
		}
		if ( '!==' === operator ) {
			return value1 !== value2;
		}
		if ( '!=' === operator || 'not equal' === operator ) {
			return value1 != value2;
		}
		if ( '>=' === operator || 'greater or equal' === operator || 'equal or greater' === operator ) {
			return value2 >= value1;
		}
		if ( '<=' === operator || 'smaller or equal' === operator || 'equal or smaller' === operator ) {
			return value2 <= value1;
		}
		if ( '>' === operator || 'greater' === operator ) {
			return value2 > value1;
		}
		if ( '<' === operator || 'smaller' === operator ) {
			return value2 < value1;
		}
		if ( 'contains' === operator || 'in' === operator ) {
			if ( _.isArray( value1 ) && _.isArray( value2 ) ) {
				_.each( value2, function( value ) {

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

					if ( value1.includes( value ) ) {
						found = true;
						return false;
					}
                } );

For multi-line function calls, the closing parenthesis should be on a new line.

				return found;
			}
			if ( _.isArray( value2 ) ) {
				_.each( value2, function( value ) {

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

					if ( value == value1 ) { // jshint ignore:line

Inline comments must end in full-stops, exclamation marks, or question marks

						found = true;
					}
				} );

For multi-line function calls, the closing parenthesis should be on a new line.

				return found;
			}
			if ( _.isObject( value2 ) ) {
				if ( ! _.isUndefined( value2[ value1 ] ) ) {
					found = true;
				}
				_.each( value2, function( subValue ) {

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

					if ( value1 === subValue ) {
						found = true;
					}
				} );

For multi-line function calls, the closing parenthesis should be on a new line.

				return found;
			}
			if ( _.isString( value2 ) ) {
				if ( _.isString( value1 ) ) {
					return ( -1 < value1.indexOf( value2 ) && -1 < value2.indexOf( value1 ) );
				}
				return -1 < value1.indexOf( value2 );
			}
		}
		return value1 == value2;
	}
};

jQuery( document ).ready( function() {

The opening parenthesis of a multi-line function call should be the last content on the line.

	kirkiDependencies.init();
} );

For multi-line function calls, the closing parenthesis should be on a new line.