EV-244: Added lint tool

.github/workflows/pr.yaml

@@ -202,7 +202,7 @@ jobs:
  node-version: '18'
  - run: yarn install
  - name: markdownlint
- run: yarn markdownlint README.md docs/README.md
+ run: yarn run coding-standards-check
 
  apispec:
  runs-on: ubuntu-latest

.gitignore

@@ -13,3 +13,5 @@
 /.php-cs-fixer.php
 /.php-cs-fixer.cache
 ###< friendsofphp/php-cs-fixer ###
+
+node_modules/

.markdownlint.json

@@ -0,0 +1,10 @@
+{
+ "default": true,
+ "MD013": {
+ "line_length": 120,
+ "code_blocks": false
+ },
+ "no-duplicate-heading": {
+ "siblings_only": true
+ }
+}

README.md

@@ -3,7 +3,7 @@
 This is the next iteration of [the event database](https://github.com/itk-event-database/event-database-api) use by the
 municipality of Aarhus.
 
-This API is build using [Symfony](https://symfony.com/) with their Symfony Messenger and 
-[API platform](https://api-platform.com/) utilizing basic CORS pattern. 
+This API is build using [Symfony](https://symfony.com/) with their Symfony Messenger and
+[API platform](https://api-platform.com/) utilizing basic CORS pattern.
 
 For more detailed and technical documentation see the docs folder in this repository.

docker-compose.override.yml

@@ -0,0 +1,10 @@
+version: "3"
+
+services:
+ node:
+ image: node:18
+ networks:
+ - app
+ working_dir: /app
+ volumes:
+ - .:/app

docs/README.md

@@ -2,7 +2,7 @@
 
 This is the technical documentation for the project.
 
-# Abstracted data flow
+## Abstracted data flow
 
 ![System input data flow](./images/data_flow.png)
 
@@ -15,7 +15,7 @@ This is the technical documentation for the project.
 * Geo encoding filter
 * Postel code filter (or filter)
 
-# User handling
+## User handling
 
 ![User handling concept](./images/user_handling.png)
 
@@ -25,6 +25,6 @@ This is the technical documentation for the project.
 * User enable/disable (soft delete)
 * Is context handler in play
 
-# API access
+## API access
 
 ![Api user creation flow](./images/api_user.png)