Skip to content

Commit 41a4e8a

Browse files
antmendozaantmendoza
authored
Merge pull request #84 from neuroglia-io/comments-formatting
Improved Comments and formatting
2 parents 5316360 + 5df3e28 commit 41a4e8a

File tree

124 files changed

+12375
-7158
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+12375
-7158
lines changed

‎.eslintignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# don't ever lint node_modules
2+
node_modules
3+
# don't lint definitions
4+
src/lib/definitions/**/*
5+
# don't lint build output
6+
dist
7+
out-tsc

‎.eslintrc.js

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
module.exports = {
2+
root: true,
3+
parser: '@typescript-eslint/parser',
4+
plugins: [
5+
'@typescript-eslint',
6+
],
7+
extends: [
8+
'eslint:recommended',
9+
'plugin:@typescript-eslint/eslint-recommended',
10+
'plugin:@typescript-eslint/recommended',
11+
'prettier'
12+
],
13+
rules: {
14+
'@typescript-eslint/no-explicit-any': 0,
15+
'@typescript-eslint/no-inferrable-types': 0
16+
}
17+
};

‎.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
---
2-
name: Bug Report
3-
about: Report a bug encountered with the Serverless Workflow Typescript SDK
4-
labels: kind/bug
5-
6-
---
7-
8-
**What happened**:
9-
10-
**What you expected to happen**:
11-
12-
**How to reproduce it**:
13-
14-
**Anything else we need to know?**:
15-
1+
---
2+
name: Bug Report
3+
about: Report a bug encountered with the Serverless Workflow Typescript SDK
4+
labels: kind/bug
5+
6+
---
7+
8+
**What happened**:
9+
10+
**What you expected to happen**:
11+
12+
**How to reproduce it**:
13+
14+
**Anything else we need to know?**:
15+
1616
**Environment**:

‎.github/ISSUE_TEMPLATE/enhancement.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
---
2-
name: Enhancement Request
3-
about: Suggest an enhancement to the Serverless Workflow Typescript SDK
4-
labels: kind/feature
5-
6-
---
7-
8-
**What would you like to be added**:
9-
1+
---
2+
name: Enhancement Request
3+
about: Suggest an enhancement to the Serverless Workflow Typescript SDK
4+
labels: kind/feature
5+
6+
---
7+
8+
**What would you like to be added**:
9+
1010
**Why is this needed**:

‎.github/ISSUE_TEMPLATE/question.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
---
2-
name: Question
3-
about: Ask a question about the Serverless Workflow Typescript SDK
4-
labels: kind/question
5-
6-
---
7-
1+
---
2+
name: Question
3+
about: Ask a question about the Serverless Workflow Typescript SDK
4+
labels: kind/question
5+
6+
---
7+
88
**What is the question**:

‎.github/OWNERS

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
reviewers:
2-
- tsurdilo
3-
- manuelstein
4-
- ricardozanini
5-
- antmendoza
6-
approvers:
7-
- tsurdilo
8-
- manuelstein
9-
- ricardozanini
10-
- antmendoza
11-
labels:
1+
reviewers:
2+
- tsurdilo
3+
- manuelstein
4+
- ricardozanini
5+
- antmendoza
6+
approvers:
7+
- tsurdilo
8+
- manuelstein
9+
- ricardozanini
10+
- antmendoza
11+
labels:
1212
- sig/contributor-experience

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
**Many thanks for submitting your Pull Request :heart:!**
2-
3-
**What this PR does / why we need it**:
4-
5-
**Special notes for reviewers**:
6-
1+
**Many thanks for submitting your Pull Request :heart:!**
2+
3+
**What this PR does / why we need it**:
4+
5+
**Special notes for reviewers**:
6+
77
**Additional information (if needed):**

‎.github/workflows/node-ci.yml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
name: Node CI
2-
3-
on:
4-
push:
5-
branches: [ main ]
6-
pull_request:
7-
branches: [ main ]
8-
9-
jobs:
10-
build:
11-
12-
runs-on: ubuntu-latest
13-
14-
strategy:
15-
matrix:
16-
node-version: [10.x, 12.x, 14.x, 15.x]
17-
18-
steps:
19-
- uses: actions/checkout@v2
20-
- name: Use Node.js ${{ matrix.node-version }}
21-
uses: actions/setup-node@v1
22-
with:
23-
node-version: ${{ matrix.node-version }}
24-
- run: npm ci
25-
- run: npm run build --if-present
1+
name: Node CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build:
11+
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
matrix:
16+
node-version: [10.x, 12.x, 14.x, 15.x]
17+
18+
steps:
19+
- uses: actions/checkout@v2
20+
- name: Use Node.js ${{ matrix.node-version }}
21+
uses: actions/setup-node@v1
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
- run: npm ci
25+
- run: npm run build --if-present
2626
- run: npm test

‎.gitignore

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# Dependency directory
2-
node_modules
3-
bower_components
4-
5-
# Editors
6-
.idea
7-
.vscode
8-
*.iml
9-
10-
# OS metadata
11-
.DS_Store
12-
Thumbs.db
13-
14-
# Ignore built ts files
15-
dist/**/*
16-
out-tsc
17-
18-
# ignore yarn.lock
1+
# Dependency directory
2+
node_modules
3+
bower_components
4+
5+
# Editors
6+
.idea
7+
.vscode
8+
*.iml
9+
10+
# OS metadata
11+
.DS_Store
12+
Thumbs.db
13+
14+
# Ignore built ts files
15+
dist/**/*
16+
out-tsc
17+
18+
# ignore yarn.lock
1919
yarn.lock

‎.gitpod.Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
FROM node:16-buster
1+
FROM node:16-buster

‎.gitpod.yml

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
image:
2-
file: .gitpod.Dockerfile
3-
4-
# List the start up tasks. You can start them in parallel in multiple terminals.
5-
# https://www.gitpod.io/docs/config-start-tasks/
6-
tasks:
7-
- init: >
8-
npm install &&
9-
npm run build
10-
command: npm run test
11-
12-
# Enable prebuilds of your project to enable faster workspace start times.
13-
# https://www.gitpod.io/docs/prebuilds/#configure-the-github-app
14-
github:
15-
prebuilds:
16-
master: true
17-
branches: true
18-
pullRequests: true
19-
pullRequestsFromForks: true
20-
addCheck: true
1+
image:
2+
file: .gitpod.Dockerfile
3+
4+
# List the start up tasks. You can start them in parallel in multiple terminals.
5+
# https://www.gitpod.io/docs/config-start-tasks/
6+
tasks:
7+
- init: >
8+
npm install &&
9+
npm run build
10+
command: npm run test
11+
12+
# Enable prebuilds of your project to enable faster workspace start times.
13+
# https://www.gitpod.io/docs/prebuilds/#configure-the-github-app
14+
github:
15+
prebuilds:
16+
master: true
17+
branches: true
18+
pullRequests: true
19+
pullRequestsFromForks: true
20+
addCheck: true

‎.husky/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_

‎.huskyrc.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"hooks": {
3+
"pre-commit": "lint-staged",
4+
"pre-push": "npm run test"
5+
}
6+
}

‎.lintstagedrc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"*.ts": "prettier --write"
3+
}

‎.prettierignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
dist
3+
out-tsc
4+
src/lib/validation/validators-paths.ts

‎.prettierrc.js

Lines changed: 24 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Hacking on Serverless Workflow Typescript SDK in Gitpod
2-
3-
If you have a web browser, you can get a fully pre-configured development environment in one click:
4-
5-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/serverlessworkflow/sdk-typescript)
1+
## Hacking on Serverless Workflow Typescript SDK in Gitpod
2+
3+
If you have a web browser, you can get a fully pre-configured development environment in one click:
4+
5+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/serverlessworkflow/sdk-typescript)

0 commit comments

Comments
 (0)