feat(specs): improve specs consistency (#51)

Author: shortcuts

.eslintrc.js

@@ -5,6 +5,37 @@ module.exports = {
     'plugin:import/errors',
     'plugin:import/warnings',
     'plugin:import/typescript',
+    'plugin:yml/standard',
+  ],
+
+  // yml linter
+  overrides: [
+    {
+      files: ['*.yml'],
+      parser: 'yaml-eslint-parser',
+      rules: {
+        '@typescript-eslint/naming-convention': 0,
+        'yml/quotes': [
+          2,
+          {
+            prefer: 'single',
+            avoidEscape: true,
+          },
+        ],
+        'yml/no-multiple-empty-lines': [
+          2,
+          {
+            max: 1,
+            maxEOF: 0,
+            maxBOF: 0,
+          },
+        ],
+        'yml/require-string-key': 2,
+
+        // Should be removed once the specs are finished
+        'yml/no-empty-document': 0,
+      },
+    },
   ],
 
   env: {

.github/actions/cache/action.yml

@@ -3,7 +3,7 @@ name: Cache
 description: Restore cached dependencies.
 
 runs:
-  using: 'composite'
+  using: composite
   steps:
     - name: Get yarn cache directory path
       shell: bash
@@ -26,5 +26,5 @@ runs:
     - name: Restore maven dependencies
       uses: actions/cache@v2
       with:
-        path: '~/.m2/repository'
+        path: ~/.m2/repository
         key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}

.github/actions/setup/action.yml

@@ -3,7 +3,7 @@ name: Setup
 description: Setup CI environment.
 
 runs:
-  using: 'composite'
+  using: composite
   steps:
     - name: Restore cache
       uses: ./.github/actions/cache
@@ -15,18 +15,14 @@ runs:
     - name: Install Java
       uses: actions/setup-java@v2
       with:
-        distribution: 'zulu'
-        java-version: '11.0.4'
+        distribution: zulu
+        java-version: 11.0.4
 
     - name: Install Node
       uses: actions/setup-node@v2
       with:
-        node-version-file: '.nvmrc'
+        node-version-file: .nvmrc
 
     - name: Install JavaScript Dependencies
       shell: bash
       run: yarn install
-
-    - name: Install spec linter
-      shell: bash
-      run: sudo apt-get -y install yamllint

.github/workflows/check.yml

@@ -37,7 +37,7 @@ jobs:
         run: yarn build:specs analytics
 
       - name: Lint
-        run: yamllint specs
+        run: yarn specs:lint
 
   client_javascript:
     runs-on: ubuntu-20.04

Dockerfile

@@ -4,7 +4,7 @@ FROM node:$NODE_VERSION-alpine
 
 ENV DOCKER=true
 
-RUN apk add openjdk11 maven jq bash yamllint perl curl
+RUN apk add openjdk11 maven jq bash perl curl
 
 WORKDIR /app