Enforce linting and fix lint errors

Author: mmirus

.eslintrc.js

@@ -1,8 +1,12 @@
 module.exports = {
  root: true,
- extends: "eslint:recommended",
+ extends: 'eslint:recommended',
  globals: {
  wp: true,
+ SetFieldProperty: true,
+ gform: true,
+ GetInputType: true,
+ GetSelectedField: true,
  },
  env: {
  node: true,
@@ -18,27 +22,27 @@ module.exports = {
  objectLiteralDuplicateProperties: false,
  },
  ecmaVersion: 2017,
- sourceType: "module",
+ sourceType: 'module',
  },
- plugins: ["import"],
+ plugins: ['import'],
  settings: {
- "import/core-modules": [],
- "import/ignore": [
- "node_modules",
- "\\.(coffee|scss|css|less|hbs|svg|json)$",
+ 'import/core-modules': [],
+ 'import/ignore': [
+ 'node_modules',
+ '\\.(coffee|scss|css|less|hbs|svg|json)$',
  ],
  },
  rules: {
- "no-console": 0,
- quotes: ["error", "single"],
- "comma-dangle": [
- "error",
+ 'no-console': 0,
+ quotes: ['error', 'single'],
+ 'comma-dangle': [
+ 'error',
  {
- arrays: "always-multiline",
- objects: "always-multiline",
- imports: "always-multiline",
- exports: "always-multiline",
- functions: "ignore",
+ arrays: 'always-multiline',
+ objects: 'always-multiline',
+ imports: 'always-multiline',
+ exports: 'always-multiline',
+ functions: 'ignore',
  },
  ],
  },

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.0.1 / 2018-12-1
+
+- Add pre-commit lint
+- Fix JS linter errors
+
 ## 1.0.0 / 2018-12-1
 
 - Initial release

README.md

@@ -2,6 +2,7 @@
 
 - [Usage](#usage)
 - [Installation](#installation)
+- [Contributing](#contributing)
 - [Screenshots](#screenshots)
 
 This plugin allows you to add custom data attributes to Gravity Forms fields.
@@ -30,6 +31,18 @@ There are three options for installing this plugin:
 2. With [GitHub Updater](https://github.com/afragen/github-updater)
 3. By downloading the latest release ZIP from this repository and installing it like any normal WordPress plugin
 
+## Contributing
+
+To work on this project (for yourself or to contribute a PR):
+
+1. Clone this repo
+2. Run `composer install`
+3. Run `yarn` or `npm install`
+
+And you should be good to go.
+
+Pre-commit linting is enforced (see `.eslintrc.js` and `.stylelintrc.js` for scripts and styles; PHP users PSR-2).
+
 ## Screenshots
 
 _Settings for a field without choices_

app/admin.php

@@ -19,7 +19,7 @@
 // Add "Enable Data Attributes" and "Data Attribute Names" settings
 add_action('gform_field_standard_settings', function ($position, $form_id) {
  if ($position === 1350) :
- ?>
+  ?>
  <li class="enable_data_attrs_setting field_setting">
  <input type="checkbox" id="field_enable_data_attrs_value" onclick="ToggleDataAttrs();" />
  <label for="field_enable_data_attrs_value" class="inline">
@@ -38,7 +38,7 @@
  <div id="gform_data_attr_inputs"></div>
  </div>
  </li>
- <?php
+  <?php
  endif;
 }, 10, 2);
 
@@ -56,5 +56,5 @@
  fieldSettings[i] += ", .enable_data_attrs_setting, .data_attrs_setting";
  }
  </script>
-<?php
+ <?php
 });

assets/admin.js

@@ -7,16 +7,16 @@
 
 // Show/hide the "Data Attribute Names" setting and the settings for individual data attributes
 function ToggleDataAttrs(isInit) {
- var speed = isInit ? "" : "slow";
+ var speed = isInit ? '' : 'slow';
 
- if (jQuery("#field_enable_data_attrs_value").is(":checked")) {
- jQuery("#gform_data_attrs, .field-choice-data-attr-wrapper").show(speed);
+ if (jQuery('#field_enable_data_attrs_value').is(':checked')) {
+ jQuery('#gform_data_attrs, .field-choice-data-attr-wrapper').show(speed);
 
- SetFieldProperty("enableDataAttrsField", true);
+ SetFieldProperty('enableDataAttrsField', true);
  } else {
- jQuery("#gform_data_attrs, .field-choice-data-attr-wrapper").hide(speed);
- SetFieldProperty("enableDataAttrsField", false);
- SetFieldProperty("dataAttrsField", "");
+ jQuery('#gform_data_attrs, .field-choice-data-attr-wrapper').hide(speed);
+ SetFieldProperty('enableDataAttrsField', false);
+ SetFieldProperty('dataAttrsField', '');
  }
 }
 
@@ -25,106 +25,106 @@ function ToggleDataAttrs(isInit) {
  * 1. Initialize "Enable Data Attributes" and "Data Attribute Names" settings
  * 2. If the field doesn't have choices, add the field for each data attribute
  */
-jQuery(document).on("gform_load_field_settings", function(event, field, form) {
- jQuery("#field_enable_data_attrs_value").attr(
- "checked",
+jQuery(document).on('gform_load_field_settings', function(event, field) {
+ jQuery('#field_enable_data_attrs_value').attr(
+ 'checked',
  field.enableDataAttrsField == true
  );
 
- var dataAttrsInputContainer = jQuery("#gform_data_attr_inputs");
- dataAttrsInputContainer.html("");
+ var dataAttrsInputContainer = jQuery('#gform_data_attr_inputs');
+ dataAttrsInputContainer.html('');
 
- jQuery("#field_data_attrs").val(field.dataAttrsField);
+ jQuery('#field_data_attrs').val(field.dataAttrsField);
 
  var dataAttrs = field.dataAttrsField;
 
  if (field.choices || !dataAttrs)
  return ToggleDataAttrs(!field.enableDataAttrsField);
 
- dataAttrs = dataAttrs.split("\n").map(function(name) {
+ dataAttrs = dataAttrs.split('\n').map(function(name) {
  return {
  name: name,
- value: field[name] || "",
+ value: field[name] || '',
  };
  });
 
  var inputs = dataAttrs
  .map(function(dataAttr) {
  return (
- "<br><label class='section_label'>" +
+ '<br><label class=\'section_label\'>' +
  dataAttr.name +
- "</label><input type='text' id='" +
+ '</label><input type=\'text\' id=\'' +
  dataAttr.name +
- "' value='" +
+ '\' value=\'' +
  dataAttr.value +
- "' class='field-" +
+ '\' class=\'field-' +
  dataAttr.name +
- " field-data-attr' data-attr-name='" +
+ ' field-data-attr\' data-attr-name=\'' +
  dataAttr.name +
- "' /><br>"
+ '\' /><br>'
  );
  })
- .join("");
+ .join('');
 
  dataAttrsInputContainer.html(inputs);
 
  ToggleDataAttrs(!field.enableDataAttrsField);
 });
 
 // Add the field for each data attribute when fields choices are rendered
-gform.addFilter("gform_append_field_choice_option", function(str, field, i) {
+gform.addFilter('gform_append_field_choice_option', function(str, field, i) {
  var inputType = GetInputType(field);
 
  var dataAttrs = field.dataAttrsField;
 
- if (!dataAttrs) return "";
+ if (!dataAttrs) return '';
 
- dataAttrs = dataAttrs.split("\n").map(function(name) {
+ dataAttrs = dataAttrs.split('\n').map(function(name) {
  return {
  name: name,
- value: field.choices[i][name] || "",
+ value: field.choices[i][name] || '',
  };
  });
 
  var inputs = dataAttrs
  .map(function(dataAttr) {
- var id = inputType + "_choice_" + dataAttr.name + "_" + i;
+ var id = inputType + '_choice_' + dataAttr.name + '_' + i;
  return (
- "<label>" +
+ '<label>' +
  dataAttr.name +
- " <input type='text' id='" +
+ ' <input type=\'text\' id=\'' +
  id +
- "' value='" +
+ '\' value=\'' +
  dataAttr.value +
- "' class='field-choice-input field-choice-" +
+ '\' class=\'field-choice-input field-choice-' +
  dataAttr.name +
- " field-choice-data-attr' data-attr-name='" +
+ ' field-choice-data-attr\' data-attr-name=\'' +
  dataAttr.name +
- "' /></label>"
+ '\' /></label>'
  );
  })
- .join("");
+ .join('');
 
- return "<div class='field-choice-data-attr-wrapper'>" + inputs + "</div>";
+ return '<div class=\'field-choice-data-attr-wrapper\'>' + inputs + '</div>';
 });
 
 // save data attribute values (general / non-choices)
-jQuery(document).on("input propertychange", ".field-data-attr", function() {
+jQuery(document).on('input propertychange', '.field-data-attr', function() {
  var $this = jQuery(this);
 
  var field = GetSelectedField();
- field[$this.data("attrName")] = $this.val();
+ field[$this.data('attrName')] = $this.val();
 });
 
 // save data attribute values (choices)
 jQuery(document).on(
- "input propertychange",
- ".field-choice-data-attr",
+ 'input propertychange',
+ '.field-choice-data-attr',
  function() {
  var $this = jQuery(this);
- var i = $this.closest("li.field-choice-row").data("index");
+ var i = $this.closest('li.field-choice-row').data('index');
 
  var field = GetSelectedField();
- field.choices[i][$this.data("attrName")] = $this.val();
+ field.choices[i][$this.data('attrName')] = $this.val();
  }
 );

composer.json

@@ -21,5 +21,13 @@
  "require": {
  "php": ">=7.1.0",
  "composer/installers": "^1.6"
+ },
+ "require-dev": {
+ "squizlabs/php_codesniffer": "^3.3"
+ },
+ "scripts": {
+ "test": [
+ "phpcs -n --standard=PSR2 *.php app/"
+ ]
  }
 }