chore(setup): add dev tools (husky, prettier, ...)

Author: michaelwittwer

.commitlintrc.yml

@@ -0,0 +1,2 @@
+extends:
+  - "@commitlint/config-conventional"

.eslintrc.yml

@@ -0,0 +1,13 @@
+env:
+  es6: true
+  node: true
+extends:
+  - "plugin:@typescript-eslint/eslint-recommended"
+parser: "@typescript-eslint/parser"
+parserOptions:
+  ecmaVersion: 2021
+  sourceType: module
+plugins:
+  - "@typescript-eslint"
+ignorePatterns:
+  - "node_modules/*"

.gitignore

@@ -1,7 +1,7 @@
 __tests__/runner/*
 
 # comment out in distribution branches
-# node_modules/
+node_modules/
 
 # Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
 # Logs

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx commitlint -e $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged && npm run build && git add dist/*

.lintstagedrc.yml

@@ -0,0 +1,16 @@
+# we use tslint instead of ng lint, because we can't use --project (tsconfig specifying files with include, exclude )
+# and --files argument pointing to other files
+src/{**/,}!(*.+(spec|test)).ts:
+  - npm run prettier:staged
+  - npm run lint:staged
+# test folder and specs
+test/{**/,}*.ts,src/{**/,}*.+(spec|test).ts:
+  - npm run prettier:staged
+  - npm run lint:staged
+# e2e tests (mostly in client projects)
+e2e/{**/,}*.ts:
+  - npm run prettier:staged
+  - npm run lint:staged
+# sort package.json keys
+./package.json:
+  - sort-package-json

.prettierrc.yml

@@ -0,0 +1,5 @@
+# https://github.com/prettier/prettier/blob/master/docs/options.md
+printWidth: 120
+singleQuote: true
+semi: false
+trailingComma: all

README.md

@@ -30,6 +30,13 @@ build:
     steps: ...
 ```
 
+## Development
+### new version
+1) implement your changes
+2) commit with `npx commit`
+3) set tag `git tag -a -m "my fancy release" v0.0.X`
+4) push with tags `git push --follow-tags`
+
 ## Publish to a distribution branch
 
 Actions will be consumed from GitHub repos. All the dependencies must be pushed there. This means for JS also 

action.yml

@@ -1,7 +1,7 @@
 # check doc on https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs
 name: 'Skip CI'
 description: 'Sets output param depending on commit message'
-author: 'Michael Wittwer <michael.wittwer@shiftcode.ch>'
+author: 'shiftcode GmbH <team@shiftcode.ch>'
 inputs:
   skipOnCommitMsg:
     description: 'defines an output variable depending if the commit message contains the skipOnCommitMsg string (output: true) or not (false).'
@@ -16,4 +16,4 @@ outputs:
     description: 'boolean value. True if the commit message contains the string provided in skipOnCommitMsg input param, false otherwise.'
 runs:
   using: 'node16'
-  main: 'lib/main.js'
+  main: 'dist/index.js'