Merge pull request #38 from tawk/coding-standard-and-linting

add linter and ensure coding standards

.gitignore

@@ -1,3 +1,5 @@
 *.zip
 ./build/tawkto
 **/vendor
+.phpcs.cache
+node_modules/

.husky/pre-commit

@@ -0,0 +1 @@
+lint-staged

.lintstagedrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+	'*.php': [
+		'composer run lint:fix',
+		'composer run lint'
+	]
+}

.nvmrc

@@ -0,0 +1 @@
+v20.14.0

.phpcs.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0"?>
+<ruleset name="CS">
+	<description>Custom coding standards.</description>
+	<config name="testVersion" value="5.6-"/>
+	<exclude-pattern>\.github/*</exclude-pattern>
+	<exclude-pattern>*/docker/*</exclude-pattern>
+	<exclude-pattern>*/vendor/*</exclude-pattern>
+	<exclude-pattern>*/node_modules/*</exclude-pattern>
+
+	<arg value="ps"/>
+	<arg name="colors"/>
+	<arg name="parallel" value="100"/>
+	<arg name="extensions" value="php,md"/>
+	<arg name="cache" value=".phpcs.cache"/>
+
+	<rule ref="Drupal">
+		<exclude name="Drupal.Classes.ClassFileName.NoMatch"/>
+		<exclude name="Drupal.Commenting"/>
+	</rule>
+
+	<rule ref="Squiz.Commenting.FunctionComment" />
+	<rule ref="Squiz.Commenting.FunctionCommentThrowTag" />
+	<rule ref="Squiz.Commenting.ClassComment" />
+	<rule ref="Squiz.Commenting.VariableComment" />
+	<rule ref="Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure" />
+</ruleset>

README.md

@@ -4,27 +4,36 @@ Free live chat widget for your site
 
 ## Description
 
-The tawk.to Live Chat app makes it easy to monitor and chat with visitors on your website. Be there when they need you with unlimited messaging, ticketing and your own Knowledge Base — all 100% FREE.
+The tawk.to Live Chat app makes it easy to monitor and chat with visitors on
+your website. Be there when they need you with unlimited messaging, ticketing
+and your own Knowledge Base — all 100% FREE.
 
-Compatible with all modern browsers, tawk.to was created in response to the growing need for businesses to respond in real time, with real people.
+Compatible with all modern browsers, tawk.to was created in response to the
+growing need for businesses to respond in real time, with real people.
 
-Never lose another lead or sale again — tawk.to offers iOS, Android, Windows and Mac OSX apps to keep you connected wherever you go.
+Never lose another lead or sale again — tawk.to offers iOS, Android, Windows and
+Mac OSX apps to keep you connected wherever you go.
 
-Don’t have a tawk.to account yet? [Create one here.](https://www.tawk.to/?utm_source=prestashop&utm_medium=link&utm_campaign=signup)
+Don’t have a tawk.to account yet?
+[Create one here.](https://www.tawk.to/?utm_source=prestashop&utm_medium=link&utm_campaign=signup)
 
 ## Installation
 
 ### Prestashop 1.6
-This section describes how to install the plugin and get it working on Prestashop 1.6
+This section describes how to install the plugin and get it working on
+Prestashop 1.6
 
 #### Module Installer
-1. Download the `tawk-prestashop-1.6-<release_verion>.zip` from [latest release.](https://github.com/tawk/tawk-prestashop/releases)
+1. Download the `tawk-prestashop-1.6-<release_verion>.zip` from
+[latest release.](https://github.com/tawk/tawk-prestashop/releases)
 2. Go to `Dashboard` -> `Modules and Services`.
-3. Click `Add a new module`, upload the zip file, and click `Upload this module`.
+3. Click `Add a new module`, upload the zip file, and click
+`Upload this module`.
 4. Search for the `tawk.to` plugin and `install`.
 
 #### Manual Installation
-1. Download and extract the `tawk-prestashop-1.6-<release_verion>.zip` from [latest release.](https://github.com/tawk/tawk-prestashop/releases)
+1. Download and extract the `tawk-prestashop-1.6-<release_verion>.zip` from
+[latest release.](https://github.com/tawk/tawk-prestashop/releases)
 2. Upload `tawkto` directory to the `/modules/` directory.
 3. Go to `Dashboard` -> `Modules and Services`.
 4. Search for the `tawk.to` plugin and `install`.
@@ -33,15 +42,19 @@ This section describes how to install the plugin and get it working on Prestasho
 It is under `Dashboard` -> `Administration` -> `tawk.to`.
 
 ### Prestashop 1.7
-This section describes how to install the plugin and get it working on Prestashop 1.7
+This section describes how to install the plugin and get it working on
+Prestashop 1.7
 
 #### Module Installer
-1. Download the `tawk-prestashop-1.7-<release_verion>.zip` from [latest release.](https://github.com/tawk/tawk-prestashop/releases)
+1. Download the `tawk-prestashop-1.7-<release_verion>.zip` from
+[latest release.](https://github.com/tawk/tawk-prestashop/releases)
 2. Go to `Dashboard` -> `Modules` -> `Module Manager`.
-3. Click `Upload a module`, upload the zip file, and the module will install automatically.
+3. Click `Upload a module`, upload the zip file, and the module will install
+automatically.
 
 #### Manual Installation
-1. Download and extract the `tawk-prestashop-1.7-<release_verion>.zip` from [latest release.](https://github.com/tawk/tawk-prestashop/releases)
+1. Download and extract the `tawk-prestashop-1.7-<release_verion>.zip` from
+[latest release.](https://github.com/tawk/tawk-prestashop/releases)
 2. Upload `tawkto` directory to the `/modules/` directory.
 3. Go to `Dashboard` -> `Modules` -> `Module Catalog`.
 4. Search for the `tawk.to` plugin and `install`.
@@ -52,7 +65,8 @@ It is under `Dashboard` -> `More` -> `tawk.to`.
 ### Widget Configuration
 1. Go to the configuration page.
 2. Log in to your tawk.to account.
-3. Select the property and the widget you want to place on your store and click `Use selected widget`.
+3. Select the property and the widget you want to place on your store and click
+`Use selected widget`.
 4. The widget will now appear on your store.
 
 ## Frequently Asked Questions

composer.json

@@ -13,16 +13,26 @@
     },
     "license": "AFL-3.0",
     "scripts": {
+        "post-install-cmd": "npm install",
+        "lint": "phpcs -p -s -v --runtime-set ignore_warnings_on_exit true .",
+        "lint:fix": "phpcbf -p -s -v .; err=$?; if [ $err -eq 1 ]; then exit 0; else exit $err; fi;",
         "auto-index": "composer run auto-index:1.6 && composer run auto-index:1.7",
         "auto-index:1.6": "autoindex prestashop:add:index ./prestashop1.6",
         "auto-index:1.7": "autoindex prestashop:add:index ./prestashop1.7",
         "build": "composer run build:dev && composer run build:prod",
-        "build:dev" : "composer install",
-        "build:prod" : "composer run build:1.6 && composer run build:1.7",
-        "build:1.6" : "COMPOSER_VENDOR_DIR=./prestashop1.6/vendor composer install --no-dev",
-        "build:1.7" : "COMPOSER_VENDOR_DIR=./prestashop1.7/vendor composer install --no-dev"
+        "build:dev": "composer install",
+        "build:prod": "composer run build:1.6 && composer run build:1.7",
+        "build:1.6": "COMPOSER_VENDOR_DIR=./prestashop1.6/vendor composer install --no-dev",
+        "build:1.7": "COMPOSER_VENDOR_DIR=./prestashop1.7/vendor composer install --no-dev"
     },
     "require-dev": {
-        "prestashop/autoindex": "^2.0"
+        "prestashop/autoindex": "^2.0",
+        "squizlabs/php_codesniffer": "^3.10",
+        "drupal/coder": "^8.3"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     }
 }