Skip to content

Comments / formatting #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# don't ever lint node_modules
node_modules
# don't lint definitions
src/lib/definitions/**/*
# don't lint build output
dist
out-tsc
17 changes: 17 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +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
}
};
30 changes: 15 additions & 15 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -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?**:

---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also the md files are been formatting, cool !!!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

prettier supports MD indeed but I don't really understand why they have been formatted... I thought I specified .ts only...

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**:
18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -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**:
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -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**:
22 changes: 11 additions & 11 deletions .github/OWNERS
Original file line number Diff line number Diff line change
@@ -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
12 changes: 6 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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):**
50 changes: 25 additions & 25 deletions .github/workflows/node-ci.yml
Original file line number Diff line number Diff line change
@@ -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
36 changes: 18 additions & 18 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion .gitpod.Dockerfile
Original file line number Diff line number Diff line change
@@ -1 +1 @@
FROM node:16-buster
FROM node:16-buster
40 changes: 20 additions & 20 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions .husky/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am just curious, what this is supposing to do?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's added by husky. When doing husky install, it creates .husky/ with that .gitignore and a _/ with a .sh in it.

6 changes: 6 additions & 0 deletions .huskyrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"hooks": {
"pre-commit": "lint-staged",
"pre-push": "npm run test"
}
}
3 changes: 3 additions & 0 deletions .lintstagedrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"*.ts": "prettier --write"
}
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules
dist
out-tsc
src/lib/validation/validators-paths.ts
24 changes: 24 additions & 0 deletions .prettierrc.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)
Loading