Add JS coding standards

Author: cconard96

source/coding_standards/global.rst

@@ -4,8 +4,10 @@ Global Coding standards
 Indentation
 -----------
 
-- 3 spaces
-- Max line width: 100
+Line length SHOULD NOT exceed 100 characters but there is no hard limit.
+
+Line indentation MUST be 3 spaces.
+
 
 .. code-block:: php
 
@@ -88,3 +90,37 @@ Variables and Constants
    $users_groups = ['glpi', 'glpi2', 'glpi3'];
    
    $CFG_GLPI = [];
+
+Checking standards
+------------------
+
+In order to check some stabdards are respected, we provide some custom `PHP CodeSniffer <http://pear.php.net/package/PHP_CodeSniffer>`_ rules. From the GLPI directory, just run:
+
+.. code-block:: bash
+
+   phpcs --standard=vendor/glpi-project/coding-standard/GlpiStandard/ inc/ front/ ajax/ tests/
+
+If you want to check the coding standard for the main GLPI codebase, you can use the provided Composer script.
+
+.. code-block:: bash
+
+   composer run-script cs
+
+If the above commands do not provide any output, then, all is OK :)
+
+An example error output would looks like:
+
+.. code-block:: bash
+
+   phpcs --standard=vendor/glpi-project/coding-standard/GlpiStandard/ inc/ front/ ajax/ tests/
+   
+   FILE: /var/www/webapps/glpi/tests/HtmlTest.php
+   ----------------------------------------------------------------------
+   FOUND 3 ERRORS AFFECTING 3 LINES
+   ----------------------------------------------------------------------
+    40 | ERROR | [x] Line indented incorrectly; expected 3 spaces, found
+       |       |     4
+    59 | ERROR | [x] Line indented incorrectly; expected 3 spaces, found
+       |       |     4
+    64 | ERROR | [x] Line indented incorrectly; expected 3 spaces, found
+       |       |     4

source/coding_standards/index.rst

@@ -7,4 +7,5 @@ GLPI has a general set of coding standards and then additional requirements for
    :maxdepth: 2
 
    global.rst
-   php.rst
+   php.rst
+   javascript.rst

source/coding_standards/javascript.rst

@@ -0,0 +1,121 @@
+JavaScript Coding standards
+===========================
+
+ECMAScript Level
+----------------
+
+All JavaScript code should be written to support the target ECMAScript version specified for the version of GLPI you are writing the code for.
+This version can be found in the `.eslintrc.json` file in the `parserOptions.ecmaVersion` property.
+
+For reference, versions of GLPI before 9.5.0 had a target ECMAScript version of 5 due to its support of Internet Explorer 11.
+Starting with GLPI 9.5.0, the target version was bumped to 6 (2015).
+
+Functions
+---------
+
+Function names must be written in *camelCaps*:
+
+.. code-block:: JavaScript
+
+   function getUserName(a, b = 'foo') {
+      //do something here!
+   }
+
+   class ExampleClass {
+
+      getUserName(a, b = 'foo') {
+         //do something here!
+      }
+   }
+
+Space after opening parenthesis and before closing parenthesis are forbidden. For parameters which have a default value, add a space before and after the equals sign.
+
+All functions MUST have a JSDoc block especially if it has parameters or is not a simple getter/setter.
+
+Classes
+-------
+
+If you are writing code for versions of GLPI before 9.5.0, you may not use classes as class support was added in EMCAScript 6.
+
+Class names must be written in `PascalCase`.
+
+..code-block:: JavaScript
+
+   class ExampleClass {
+
+   }
+
+   class ExampleClass extends BaseClass {
+
+   }
+
+In general, you should create a new file for each class.
+
+Comments
+--------
+
+For simple or one-line comments, use `//`.
+
+For multi-line or JSDoc comments, use '/** */'
+
+Function JSDoc blocks MUST contain:
+
+- Description
+- Parameter types and descriptions
+- Return type
+
+Function JSDoc blocks SHOULD contain:
+
+- The version of GLPI or the plugin that the function was introduced
+
+.. code-block:: JavaScript
+
+    /**
+     * Short description (single line)
+     *
+     * This is an optional longer description that can span
+     * multiple lines.
+     *
+     * @since 10.0.0
+     *
+     * @param {{}} a First parameter description
+     * @param {string} b Second parameter description
+     *
+     * @returns {string}
+     */
+    function getUserName(a, b = 'foo') {
+
+    }
+
+JSDoc sections MUST be in the following order with an empty line between them:
+
+- Short description (one line)
+- Long description
+- '@deprecated'
+- '@since'
+- '@param'
+- '@return'
+- '@see'
+- '@throw'
+- '@todo'
+
+Variable types
+--------------
+
+When type hinting in JSDoc blocks, you MAY use any of the native types or class names.
+
+If you want to create custom types/object shapes without creating a class, you MAY define a new type using the JSDoc '@typedef' tag.
+
+Quoting Strings
+---------------
+
+Using single quotes for simple strings is preferred. If you are writing for GLPI 9.5.0 or higher, you may use the ECMAScript 6 template literals feature.
+
+When your strings contain HTML content, you SHOULD use template literals (if possible). This lets you format your HTML across multiple lines for better readability and easily inject variable values without concatenation.
+
+Files
+-----
+
+Regular JavaScript files MUST have only lowercase characters in the name. If using modules, the file name MAY have captialized characters.
+
+JavaScript files for tests MAY contain uppercase characters.

source/coding_standards/php.rst

@@ -336,9 +336,11 @@ Examples:
 Files
 -----
 
-* Name in lower case.
-* Maximum line length: 100 characters
-* Indentation: 3 spaces
+Names MUST contain only lowercase characters and MUST have the ".class.php" ending in order for the GLPI autoloader to load them.
+
+PHP files for tests MAY contain uppercase characters and a simple ".php" extension.
+
+For plugins, the `setup` and `hook` files MUST be named "setup.php" and "hook.php" respectively.
 
 Database queries
 ----------------
@@ -364,31 +366,3 @@ Database queries
    $query = "INSERT INTO `glpi_alerts`
                    (`itemtype`, `items_id`, `type`, `date`) // put field's names to avoid mistakes when names of fields change
              VALUE ('contract', '5', '2', NOW())";
-
-Checking standards
-------------------
-
-In order to check some stabdards are respected, we provide some custom `PHP CodeSniffer <http://pear.php.net/package/PHP_CodeSniffer>`_ rules. From the GLPI directory, just run:
-
-.. code-block:: bash
-
-   phpcs --standard=vendor/glpi-project/coding-standard/GlpiStandard/ inc/ front/ ajax/ tests/
-
-If the above command does not provide any output, then, all is OK :)
-
-An example error output would looks like:
-
-.. code-block:: bash
-
-   phpcs --standard=vendor/glpi-project/coding-standard/GlpiStandard/ inc/ front/ ajax/ tests/
-   
-   FILE: /var/www/webapps/glpi/tests/HtmlTest.php
-   ----------------------------------------------------------------------
-   FOUND 3 ERRORS AFFECTING 3 LINES
-   ----------------------------------------------------------------------
-    40 | ERROR | [x] Line indented incorrectly; expected 3 spaces, found
-       |       |     4
-    59 | ERROR | [x] Line indented incorrectly; expected 3 spaces, found
-       |       |     4
-    64 | ERROR | [x] Line indented incorrectly; expected 3 spaces, found
-       |       |     4