feat: shortcuts (#245)

Author: Maurice Faber

.env.sample

@@ -2,8 +2,6 @@ USER_ID=${UID-}
 GROUP_ID=${GID-}
 # turn this on when you don't want a git commit and push, but only want the db updates:
 DISABLE_SYNC=true
-# turn this on when you don't want to let core process the files (to encrypt etc), allowing to start api without it
-DISABLE_PROCESSING=false
 # turn this off if only working with api, but leave on when accessing via console and authz is wanted:
 NO_AUTHZ=true
 # GIT_LOCAL_PATH='/tmp/otomi'

.eslintrc.yml

@@ -1,33 +1,33 @@
 ---
 root: true
 
+parser: '@typescript-eslint/parser'
 parserOptions:
   project: ['./tsconfig.json']
   ecmaVersion: 2021
 
 extends:
+  # - airbnb-base
   - eslint:recommended
   - plugin:@typescript-eslint/eslint-recommended
   - plugin:@typescript-eslint/recommended
   - plugin:@typescript-eslint/recommended-requiring-type-checking
-  - airbnb-base
-  - plugin:prettier/recommended
-  - prettier
-  - prettier/@typescript-eslint
+  - plugin:chai-friendly/recommended
   - plugin:import/errors
-  - plugin:import/warnings
   - plugin:import/typescript
-  - plugin:chai-friendly/recommended
+  - plugin:import/warnings
+  - plugin:prettier/recommended
+  # - prettier/@typescript-eslint
 
 plugins:
   - import
-  - prettier
   - '@typescript-eslint'
 
 settings:
   import/resolver:
     node:
       extensions: ['.ts']
+      paths: [src]
 
 env:
   es6: true
@@ -49,18 +49,22 @@ rules:
   '@typescript-eslint/no-unsafe-call': off
   '@typescript-eslint/no-non-null-assertion': off
   '@typescript-eslint/no-floating-promises': off
-  func-names: 'off'
-  import/no-extraneous-dependencies: off
-  import/extensions: off
+  comma-dangle: [error, only-multiline]
+  curly: [error, multi-or-nest]
   eol-last: ['error', 'always']
-  no-shadow: warn
-  no-unused-vars: warn
-  prefer-destructuring: error
-  no-use-before-define: 'off'
-  no-console: 'off'
-  object-shorthand: error
-  no-debugger: error
+  func-names: off
+  import/extensions: off
+  import/no-extraneous-dependencies: off
+  no-console: off
+  no-debugger: warn
+  no-fallthrough: warn
   no-param-reassign:
     - error
     - props: true
       ignorePropertyModificationsFor: [memo]
+  no-shadow: warn
+  no-unused-vars: warn
+  no-use-before-define: off
+  object-shorthand: error
+  prefer-destructuring: warn
+  prefer-template: error

.github/workflows/main.yml

@@ -81,21 +81,21 @@ jobs:
           release_name: Release ${{ steps.git_tag.outputs.tag }}
           body: ${{ steps.git_tag.outputs.changes }}
 
-  check-build-push-npm:
-    runs-on: ubuntu-latest
-    needs: build-test-push-release
-    if: "contains(github.event.head_commit.message, 'chore(release)') && github.ref == 'refs/heads/master'"
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '14'
-          registry-url: https://npm.pkg.github.com/
-          scope: '@redkubes'
-      - name: Build and publish packages
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          npm install
-          npm run release:npm
+  # check-build-push-npm:
+  #   runs-on: ubuntu-latest
+  #   needs: build-test-push-release
+  #   if: "contains(github.event.head_commit.message, 'chore(release)') && github.ref == 'refs/heads/master'"
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v2
+  #     - uses: actions/setup-node@v2
+  #       with:
+  #         node-version: '14'
+  #         registry-url: https://npm.pkg.github.com/
+  #         scope: '@redkubes'
+  #     - name: Build and publish packages
+  #       env:
+  #         NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #       run: |
+  #         npm install
+  #         npm run release:client

.github/workflows/renovate.yml

@@ -0,0 +1,24 @@
+name: Renovate
+on:
+  schedule:
+    - cron: '0/30 * * * *'
+jobs:
+  renovate:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.4.0
+      - name: Setup node
+        uses: actions/setup-node@v2.5.1
+        with:
+          node-version: 14
+      - name: Install project
+        run: npm ci --ignore-scripts
+      - name: Build
+        run: npm run build
+      - name: Renovate
+        uses: renovatebot/github-action@v26.21.7
+        with:
+          configurationFile: .github/renovate.json
+          token: ${{ secrets.NPM_TOKEN }}

.mocharc.yml

@@ -0,0 +1,5 @@
+file:
+  - src/test-init.ts
+files: src/**/*.test.ts
+require: ts-node/register
+timeout: 5000

.prettierignore

@@ -1,2 +1,4 @@
 .history/
-CHANGELOG.md
+dist/
+package-*.json
+CHANGELOG.md

.prettierrc.yml

@@ -3,3 +3,9 @@ trailingComma: all
 singleQuote: true
 printWidth: 120
 jsxSingleQuote: true
+overrides:
+  - files:
+      - 'test/env/**/*.yaml'
+    options:
+      tabWidth: 4
+      useTabs: true

.vscode/extensions.json

@@ -6,6 +6,7 @@
     "donjayamanne.githistory",
     "eamodio.gitlens",
     "esbenp.prettier-vscode",
+    "foxundermoon.shell-format",
     "pascalreitermann93.vscode-yaml-sort",
     "quicktype.quicktype",
     "hbenl.vscode-mocha-test-adapter",

.vscode/launch.json

@@ -39,7 +39,7 @@
       "type": "pwa-node",
       "resolveSourceMapLocations": ["${workspaceFolder}/**", "!**/node_modules/**"],
       "request": "launch",
-      "name": "Mocha All (transpiled)",
+      "name": "Mocha All",
       "args": ["--timeout", "999999", "--colors", "${workspaceFolder}/src/**/*.test.ts"],
       "env": {
         "NODE_ENV": "test"

.vscode/settings.json

@@ -2,24 +2,32 @@
   "[dotenv]": {
     "editor.defaultFormatter": "foxundermoon.shell-format"
   },
+  "[javascript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[shellscript]": {
+    "editor.defaultFormatter": "foxundermoon.shell-format"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
   "cSpell.diagnosticLevel": "Hint",
+  "cSpell.enabled": true,
   "editor.codeActionsOnSave": {
-    "source.fixAll": true
+    "source.addMissingImports": true,
+    "source.fixAll": true,
+    "source.organizeImports": true
   },
-  "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
   "eslint.format.enable": true,
   "eslint.validate": ["javascript", "typescript"],
-  "files.watcherExclude": {
-    "**/.git/objects/**": true,
-    "**/.git/subtree-cache/**": true,
-    "**/node_modules/*/**": true
-  },
   "mochaExplorer.env": {
     "NODE_ENV": "test"
   },
-  "mochaExplorer.files": "src/*.test.ts",
+  "mochaExplorer.configFile": ".mocharc.yml",
+  "mochaExplorer.files": "src/**/*.test.ts",
   "mochaExplorer.require": "ts-node/register",
-  "mochaExplorer.timeout": 20000,
+  "mochaExplorer.timeout": 5000,
   "prettier.enable": true
 }