fea: test ci with coveralls

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: Test
+
+on:
+  pull_request:
+    branches:
+      - main
+
+env:
+  COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+    - name: Checkout repository
+      uses: action/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: 16.20.2
+
+    - name: Install dependecies
+      run: yarn
+
+    - name: Check tests
+      run: yarn test
+
+    - name: Check liting
+      run: yarn lint
+
+    - name: Check commit message
+      run: wagoid/commitlint-github-action@v1
+
+    - name: Coveralls
+      uses: coverallsapp/github-action@v2

README.md

@@ -1,26 +1,34 @@
 # `Make Mask`
 
-#### `0` — Digits
-> Only numbers
+[![NPM](https://img.shields.io/npm/l/make-mask)]
+(https://www.npmjs.com/package/make-mask)
+[![Coverage Status](https://coveralls.io/repos/github/holasoycael/make-mask/badge.svg?branch=main)](https://coveralls.io/github/holasoycael/make-mask?branch=main)
+[![npm](https://img.shields.io/npm/v/make-mask)](https://www.npmjs.com/package/make-mask)
+[![gzip size](https://img.badgesize.io/https://unpkg.com/make-mask/dist/make.min.js?compression=gzip)](https://unpkg.com/make-mask/dist/make.min.js)
 
-#### `9` — Optional digits
-> Indicates whether there will be a number or not
+`0` — Digits<br />
+Only numbers
 
-#### `#` — Recursive digits
-> Use this pattern to create infinitely repeatable formulas
+`9` — Optional digits<br />
+Indicates whether there will be a number or not
 
-#### `A` — Letters and numbers
-> Uppercase, lowercase letters and numbers
+`#` — Recursive digits<br />
+Use this pattern to create infinitely repeatable formulas
 
-#### `S` — Letters
-> Uppercase, lowercase letters
+`A` — Letters and numbers<br />
+Uppercase, lowercase letters and numbers
+
+`S` — Letters<br />
+Uppercase, lowercase letters
 
 #
 ### Default function arguments
 ```js
 fn(value, mask[ , options])
 ```
 
+## Exemples
+
 ### `Date `
 
 ```js

package.json

@@ -8,7 +8,8 @@
     "dev": "yarn build --watch",
     "test": "jest",
     "test:watch": "yarn test --watchAll",
-    "lint": "eslint src --max-warnings=0"
+    "lint": "eslint src --max-warnings=0",
+    "coveralls": "cat ./coverage/lcov.info | coveralls"
   },
   "repository": {
     "type": "git",
@@ -49,6 +50,7 @@
     "@typescript-eslint/eslint-plugin": "^4.32.0",
     "@typescript-eslint/parser": "^4.32.0",
     "babel-plugin-module-resolver": "^5.0.0",
+    "coveralls": "^3.1.1",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",