RAGC-38 - Add and configure Commitlint

Author: PiotrGrobelak

.gitignore

@@ -5,4 +5,8 @@
 ###> ide
 /.idea
 /.DS_Store
-###< ide
+###< ide
+
+###> Dependency directories
+node_modules/
+###< Dependency directories

README.md

@@ -1,5 +1,17 @@
 ## Quick startup
 
+
+### Commitlint configuration:
+
+Install Node.js on your machine [Node via package manager](https://nodejs.org/en/download/package-manager/)
+
+After that in root directory run command in terminal ```npm install``` to install dependencies.
+
+Your commit message should contain PREFIX: FRDQ, ID as a number, and SUBJECT.
+Example: ```"RAGC-21 - Your commit message"```
+
+
+
 ### For docker (linux)
 
 Allows you to quick setup development environment
@@ -11,34 +23,34 @@ Allows you to quick setup development environment
         ###> docker/dev ###
         # Set a port where the app should be served on your localhost
         APP_PORT=8080
-      
+
         # Set a port where the database should be served on your localhost
         DB_PORT=3310
         ###< docker/dev ###
-      
+
         ###> docker/mysql ###
         # Set the database user name
         MYSQL_USER=user
-      
+
         # Set the database name
         MYSQL_DATABASE=database
-      
+
         # Set the database user password
         MYSQL_PASSWORD=pass
-      
+
         # Set the database password for the CLI usage
         MYSQL_ROOT_PASSWORD=pass
-      
+
         # It should be untouched if its running in docker
         MYSQL_HOST=database:3306
         ###< docker/mysql ###
         ```
-      
+
 - Build images using
     ```
     docker-compose -f docker-compose.yml -f docker-compose.development.yml build
     ```
-  
+
 - Download dependencies using
     ```
     docker-compose -f docker-compose.yml -f docker-compose.development.yml run --no-deps api /bin/bash -c "composer install"
@@ -55,12 +67,12 @@ Allows you to quick setup development environment
       ```
       docker-compose exec api /bin/bash
       ```
-      
+
     - If it's not running (without database access)
       ```
       docker-compose -f docker-compose.yml -f docker-compose.development.yml run --no-deps api /bin/bash
       ```
-      
+
     > If you want to stop the server, type
       `docker-compose stop` on your host machine.
 

commitlint.config.js

@@ -0,0 +1,32 @@
+const PREFIX = 'RAGC';
+
+const customParser = {
+  parserOpts: {
+    headerPattern: /^(\w+)-(\d+) - (.*)$/,
+    headerCorrespondence: ['type', 'id', 'subject'],
+  },
+};
+
+module.exports = {
+  parserPreset: customParser,
+  rules: {
+    'type-enum': [2, 'always', [`${PREFIX}`]],
+    'commit-message-rule': [2, 'always'],
+    'subject-empty': [2, 'never'],
+    'subject-case': [2, 'always', 'sentence-case'],
+  },
+  plugins: [
+    {
+      rules: {
+        'commit-message-rule': ({ type, id }) => {
+          const ID = parseInt(id, 10);
+
+          return [
+            !isNaN(ID) && type.includes(`${PREFIX}`),
+            `\x1b[31m Your commit message should contain PREFIX: ${PREFIX}, ID as a number, and SUBJECT. \r\n     Example:\x1b[34m "${PREFIX}-21 - Your commit message" \x1b[0m \x1b[0m`,
+          ];
+        },
+      },
+    },
+  ],
+};