v3.0.0 (#104)

* All dependecies are up to date + jest.mocked instead of ts-jest mocked due to jestjs/jest#12089 * Example removed * React Styleguidist first try * Better documentation * Styled documentation, changed min & max validators, removed special validators, workflows are tuned up * Reusable docs workflow * Reusable docs workflow fix * Additional item in changelog * Reusable docs workflow fix * Validators refactored * Invert validators result * Readme * min & length validators + integration test suites * fix * fix * one more fix * Exclude/ignore file(s) from Jest coverage by not running relevant tests * fix * code dublication avoided * Seems work * Bumped dependencies * Docs

Author: boonya

.editorconfig

@@ -10,7 +10,8 @@ trim_trailing_whitespace = true
 [*.md]
 indent_style = space
 insert_final_newline = false
+indent_size = 4
 
-[package.json]
+[{*.yaml,*.yml,package.json}]
 indent_style = space
 indent_size = 2

.eslintignore

@@ -1,5 +1,4 @@
 node_modules
 dist
 coverage
-example
-docs
+styleguide

.github/dependabot.yml

@@ -8,4 +8,4 @@ updates:
  - package-ecosystem: "npm"
  directory: "/" # Location of package manifests
  schedule:
- interval: "daily"
+ interval: "weekly"

.github/workflows/push.yml renamed to .github/workflows/coverage.yml

@@ -1,4 +1,4 @@
-name: Lint and test
+name: Coverage
 
 on:
  push:
@@ -8,37 +8,14 @@ on:
  - '**.md'
  branches:
  - main
- pull_request:
 
 jobs:
- lint:
- name: Lint
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-node@v1
- with:
- node-version: 16
- - run: npm ci
- - run: npm run lint
- test:
- name: Test
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-node@master
- with:
- node-version: 16
- - run: npm ci
- - run: npm run test:ci
  coverage:
- needs: [ test ]
- if: github.ref == 'refs/heads/main'
  name: Sending test coverage to Code Climate
  runs-on: ubuntu-latest
  steps:
  - uses: actions/checkout@v2
- - uses: actions/setup-node@v1
+ - uses: actions/setup-node@v2
  with:
  node-version: 16
  - run: npm ci

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Publish documentation
+
+on:
+ workflow_call:
+ inputs:
+ targetFolder:
+ required: true
+ type: string
+
+jobs:
+ docs:
+ name: Build & publish documentation
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-node@v2
+ with:
+ node-version: 16
+ - run: npm ci
+ - run: npm run build:docs
+ - uses: JamesIves/github-pages-deploy-action@4.1.5
+ with:
+ branch: docs
+ folder: styleguide
+ target-folder: ${{ inputs.targetFolder }}
+ git-config-name: github-pages-deploy-action

.github/workflows/release.yml renamed to .github/workflows/publish.yml

@@ -1,39 +1,50 @@
-name: Lint, test, build and publish
+name: Publish
+
 on:
  release:
  types: [ published ]
+
 jobs:
  lint:
  name: Lint
  runs-on: ubuntu-latest
  steps:
  - uses: actions/checkout@v2
- - uses: actions/setup-node@v1
+ - uses: actions/setup-node@v2
  with:
  node-version: 16
  - run: npm ci
  - run: npm run lint
+
  test:
  name: Test
  runs-on: ubuntu-latest
  steps:
  - uses: actions/checkout@v2
- - uses: actions/setup-node@v1
+ - uses: actions/setup-node@v2
  with:
  node-version: 16
  - run: npm ci
  - run: npm run test:ci
+
  publish:
  needs: [ lint, test ]
- name: Build & publish
+ name: Build & publish package
  runs-on: ubuntu-latest
  steps:
  - uses: actions/checkout@v2
- - uses: actions/setup-node@v1
+ - uses: actions/setup-node@v2
  with:
  node-version: 16
  - run: npm ci
  - run: npm run build
  - uses: JS-DevTools/npm-publish@v1
  with:
  token: ${{ secrets.NPM_TOKEN }}
+
+ docs:
+ needs: [ publish ]
+ steps:
+ - uses: ./.github/workflows/docs.yml
+ with:
+ targetFolder: docs

.github/workflows/verify.yml

@@ -0,0 +1,34 @@
+name: Verify
+
+on:
+ push:
+ tags-ignore:
+ - '*'
+ paths-ignore:
+ - '**.md'
+ branches:
+ - main
+ pull_request:
+
+jobs:
+ lint:
+ name: Lint
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-node@v2
+ with:
+ node-version: 16
+ - run: npm ci
+ - run: npm run lint
+
+ test:
+ name: Test
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-node@v2
+ with:
+ node-version: 16
+ - run: npm ci
+ - run: npm run test:ci

.gitignore

@@ -15,5 +15,5 @@ node_modules/
 .npm
 
 dist/
-
+styleguide/
 *.code-workspace

.npmignore

@@ -0,0 +1,8 @@
+*
+.*
+!CHANGELOG
+!dist/*/*
+!src/**/*
+**/*.test.ts
+**/*.spec.ts
+**/.*

.nvmrc

@@ -1 +1 @@
-16.12
+16