Builder & headers

- fixed builder for union types
- rename "validatorFn" by "buildingFn" in builder(s)
- fixed default kind/type for Subflowstate, Function, Eventdef
- added file header
- "installed" husky
- updated lint-staged config

Signed-off-by: JBBianchi <[email protected]>

.eslintignore

@@ -1,7 +1,7 @@
-# don't ever lint node_modules
-node_modules
-# don't lint definitions
-src/lib/definitions/**/*
-# don't lint build output
-dist
+# don't ever lint node_modules
+node_modules
+# don't lint definitions
+src/lib/definitions/**/*
+# don't lint build output
+dist
 out-tsc

.eslintrc.js

@@ -1,17 +1,17 @@
-module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  plugins: [
-    '@typescript-eslint',
-  ],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier'
-  ],
-  rules: {
-    '@typescript-eslint/no-explicit-any': 0,
-    '@typescript-eslint/no-inferrable-types': 0
-  }
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: [
+    '@typescript-eslint',
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier'
+  ],
+  rules: {
+    '@typescript-eslint/no-explicit-any': 0,
+    '@typescript-eslint/no-inferrable-types': 0
+  }
 };

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,16 +1,16 @@
----
-name: Bug Report
-about: Report a bug encountered with the Serverless Workflow Typescript SDK
-labels: kind/bug
-
----
-
-**What happened**:
-
-**What you expected to happen**:
-
-**How to reproduce it**:
-
-**Anything else we need to know?**:
-
+---
+name: Bug Report
+about: Report a bug encountered with the Serverless Workflow Typescript SDK
+labels: kind/bug
+
+---
+
+**What happened**:
+
+**What you expected to happen**:
+
+**How to reproduce it**:
+
+**Anything else we need to know?**:
+
 **Environment**:

.github/ISSUE_TEMPLATE/enhancement.md

@@ -1,10 +1,10 @@
----
-name: Enhancement Request
-about: Suggest an enhancement to the Serverless Workflow Typescript SDK
-labels: kind/feature
-
----
-
-**What would you like to be added**:
-
+---
+name: Enhancement Request
+about: Suggest an enhancement to the Serverless Workflow Typescript SDK
+labels: kind/feature
+
+---
+
+**What would you like to be added**:
+
 **Why is this needed**:

.github/ISSUE_TEMPLATE/question.md

@@ -1,8 +1,8 @@
----
-name: Question
-about: Ask a question about the Serverless Workflow Typescript SDK
-labels: kind/question
-
----
-
+---
+name: Question
+about: Ask a question about the Serverless Workflow Typescript SDK
+labels: kind/question
+
+---
+
 **What is the question**:

.github/OWNERS

@@ -1,12 +1,12 @@
-reviewers:
-  - tsurdilo
-  - manuelstein
-  - ricardozanini
-  - antmendoza
-approvers:
-  - tsurdilo
-  - manuelstein
-  - ricardozanini
-  - antmendoza
-labels:
+reviewers:
+  - tsurdilo
+  - manuelstein
+  - ricardozanini
+  - antmendoza
+approvers:
+  - tsurdilo
+  - manuelstein
+  - ricardozanini
+  - antmendoza
+labels:
   - sig/contributor-experience

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
-**Many thanks for submitting your Pull Request :heart:!**
-
-**What this PR does / why we need it**:
-
-**Special notes for reviewers**:
-
+**Many thanks for submitting your Pull Request :heart:!**
+
+**What this PR does / why we need it**:
+
+**Special notes for reviewers**:
+
 **Additional information (if needed):**

.github/workflows/node-ci.yml

@@ -1,26 +1,26 @@
-name: Node CI
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x]
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm ci
-      - run: npm run build --if-present
+name: Node CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x, 15.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
       - run: npm test

.gitignore

@@ -1,19 +1,19 @@
-# Dependency directory
-node_modules
-bower_components
-
-# Editors
-.idea
-.vscode
-*.iml
-
-# OS metadata
-.DS_Store
-Thumbs.db
-
-# Ignore built ts files
-dist/**/*
-out-tsc
-
-# ignore yarn.lock
+# Dependency directory
+node_modules
+bower_components
+
+# Editors
+.idea
+.vscode
+*.iml
+
+# OS metadata
+.DS_Store
+Thumbs.db
+
+# Ignore built ts files
+dist/**/*
+out-tsc
+
+# ignore yarn.lock
 yarn.lock

.gitpod.Dockerfile

@@ -1 +1 @@
-FROM node:16-buster
+FROM node:16-buster

.gitpod.yml

@@ -1,20 +1,20 @@
-image:
-  file: .gitpod.Dockerfile
-
-# List the start up tasks. You can start them in parallel in multiple terminals.
-# https://www.gitpod.io/docs/config-start-tasks/
-tasks:
-  - init: >
-      npm install &&
-      npm run build
-    command: npm run test
-
-# Enable prebuilds of your project to enable faster workspace start times.
-# https://www.gitpod.io/docs/prebuilds/#configure-the-github-app
-github:
-  prebuilds:
-    master: true
-    branches: true
-    pullRequests: true
-    pullRequestsFromForks: true
-    addCheck: true
+image:
+  file: .gitpod.Dockerfile
+
+# List the start up tasks. You can start them in parallel in multiple terminals.
+# https://www.gitpod.io/docs/config-start-tasks/
+tasks:
+  - init: >
+      npm install &&
+      npm run build
+    command: npm run test
+
+# Enable prebuilds of your project to enable faster workspace start times.
+# https://www.gitpod.io/docs/prebuilds/#configure-the-github-app
+github:
+  prebuilds:
+    master: true
+    branches: true
+    pullRequests: true
+    pullRequestsFromForks: true
+    addCheck: true

.husky/.gitignore

@@ -0,0 +1 @@
+_

.huskyrc.json

@@ -1,6 +1,6 @@
-{
-  "hooks": {
-    "pre-commit": "lint-staged",
-    "pre-push": "npm run test"
-  }
+{
+  "hooks": {
+    "pre-commit": "lint-staged",
+    "pre-push": "npm run test"
+  }
 }

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*.ts": "prettier --write"
+}

.prettierignore

@@ -1,4 +1,4 @@
-node_modules
-dist
-out-tsc
+node_modules
+dist
+out-tsc
 src/lib/validation/validators-paths.ts

CONTRIBUTING.md

@@ -1,5 +1,5 @@
-## Hacking on Serverless Workflow Typescript SDK in Gitpod
-
-If you have a web browser, you can get a fully pre-configured development environment in one click:
-
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/serverlessworkflow/sdk-typescript)
+## Hacking on Serverless Workflow Typescript SDK in Gitpod
+
+If you have a web browser, you can get a fully pre-configured development environment in one click:
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/serverlessworkflow/sdk-typescript)