Add Yaml Linting (terraform + workflows) (#117)

Co-authored-by: Trajan0x <trajan0x@users.noreply.github.com>

.codecov.yml

@@ -6,8 +6,10 @@ coverage:
   precision: 5
 
 ignore:
-  - "**/_generated.go"
-  - "**/*.abigen.go"
-  - "**/_string.go"
+  - '**/*_generated.go'
+  - '**/*.abigen.go'
+  - '**/*_string.go'
 # solidity test files
-  - "packages/contracts/test/*"
+  - '*/test/*.sol'
+  - '*/lib/*.sol'
+  - 'packages/contracts/libs/*.sol'

.editorconfig

@@ -14,4 +14,7 @@ indent_size = 4
 
 [*.go]
 indent_size = 4
-indent_style = tab
+indent_style = tab
+
+[*.yml]
+quote_type = single

.github/label-requires-reviews.yml

@@ -1,3 +1,2 @@
----
   - label: 2-reviewers
     reviews: 2

.github/labeler.yml

@@ -1,4 +1,3 @@
----
 2-reviewers:
   - 'packages/contracts/**/*'
 

.github/workflows/changesets.yml

@@ -1,4 +1,3 @@
----
 name: Changeset integrity checker
 on:
   pull_request_target:
@@ -20,7 +19,7 @@ jobs:
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
-      - name: "Use NodeJS by nvmrc"
+      - name: 'Use NodeJS by nvmrc'
         uses: actions/setup-node@v2
         with:
           node-version: '${{steps.nvmrc.outputs.NVMRC}}'

.github/workflows/foundry-tests.yml

@@ -20,7 +20,7 @@ jobs:
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
-      - name: "Use NodeJS by nvmrc"
+      - name: 'Use NodeJS by nvmrc'
         uses: actions/setup-node@v2
         with:
           node-version: '${{steps.nvmrc.outputs.NVMRC}}'

.github/workflows/go.yml

@@ -123,7 +123,7 @@ jobs:
 
       # For pull requests it's not necessary to checkout the code
       - uses: dorny/paths-filter@v2
-        name: "Check for Go Changes"
+        name: 'Check for Go Changes'
         id: filter_go
         with:
           filters: |
@@ -235,7 +235,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           # see: https://github.com/golangci/golangci-lint/issues/337#issuecomment-510136513
           GOGC: 20
-          GOPRIVATE: "GOPRIVATE=github.com/synapsecns/synapse-node"
+          GOPRIVATE: 'GOPRIVATE=github.com/synapsecns/synapse-node'
 
   # check if we need to rerun go generate as a result of solidity changes. Note, this will only run on solidity changes.
   check-generation:
@@ -262,7 +262,7 @@ jobs:
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
-      - name: "Use NodeJS by nvmrc"
+      - name: 'Use NodeJS by nvmrc'
         uses: actions/setup-node@v2
         with:
           node-version: '${{steps.nvmrc.outputs.NVMRC}}'
@@ -333,14 +333,14 @@ jobs:
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         uses: andymckay/labeler@3a4296e9dcdf9576b0456050db78cfd34853f260
         with:
-          add-labels: "needs-go-generate"
+          add-labels: 'needs-go-generate'
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           issue-number: ${{ steps.find_pr.outputs.pr }}
 
       - name: Remove Label
         if: steps.verify-changed-files.outputs.files_changed != 'true'
         uses: andymckay/labeler@3a4296e9dcdf9576b0456050db78cfd34853f260
         with:
-          remove-labels: "needs-go-generate"
+          remove-labels: 'needs-go-generate'
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           issue-number: ${{ steps.find_pr.outputs.pr }}

.github/workflows/label-statuses.yml

@@ -17,10 +17,10 @@ jobs:
         with:
           mode: exactly
           count: 0
-          labels: "do not merge"
+          labels: 'do not merge'
 
       - uses: mheap/github-action-required-labels@v2
         with:
           mode: exactly
           count: 0
-          labels: "needs go generate"
+          labels: 'needs go generate'

.github/workflows/labeler.yml

@@ -1,5 +1,4 @@
----
-name: "Pull Request Labeler"
+name: 'Pull Request Labeler'
 on:
   - pull_request_target
 
@@ -9,5 +8,5 @@ jobs:
     steps:
       - uses: actions/labeler@main
         with:
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          repo-token: '${{ secrets.GITHUB_TOKEN }}'
           configuration-path: .github/labeler.yml

.github/workflows/lint.yml

@@ -0,0 +1,13 @@
+name: Yaml Lint
+on: [push]
+jobs:
+  # TODO: add editor config linter
+  # https://github.com/editorconfig-checker/editorconfig-checker#continuous-integration
+  yaml:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: yaml-lint
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          config_file: .yamllint.yml

.github/workflows/solidity.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: "Checkout"
+      - name: 'Checkout'
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
@@ -24,7 +24,7 @@ jobs:
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
-      - name: "Use NodeJS by nvmrc"
+      - name: 'Use NodeJS by nvmrc'
         uses: actions/setup-node@v2
         with:
           node-version: '${{steps.nvmrc.outputs.NVMRC}}'
@@ -73,7 +73,7 @@ jobs:
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
-      - name: "Use NodeJS by nvmrc"
+      - name: 'Use NodeJS by nvmrc'
         uses: actions/setup-node@v2
         with:
           node-version: '${{steps.nvmrc.outputs.NVMRC}}'

.golangci.yml

@@ -4,8 +4,8 @@ run:
   skip-dirs-use-default: false
   timeout: 15m
   skip-files:
-    - ".*\\.abigen\\.go$"
-    - ".*\\.metadata\\.go$"
+    - '.*\\.abigen\\.go$'
+    - '.*\\.metadata\\.go$'
 
 
 linters-settings:
@@ -95,11 +95,11 @@ issues:
       linters:
         - revive
         - stylecheck
-      text: "should not use dot imports"
+      text: 'should not use dot imports'
     - path: contracts/
       linters:
         - revive
-      text: "and that stutters; consider calling this"
+      text: 'and that stutters; consider calling this'
     - path: ethergo/example/*
       linters:
         - wrapcheck

.yamllint.yml

@@ -0,0 +1,9 @@
+ignore: |
+  **/node_modules/**
+
+rules:
+  document-start:
+    present: false
+  quoted-strings:
+    quote-type: single
+    required: false