Add CI

.github/actions/package-install/action.yaml

@@ -0,0 +1,22 @@
+name: 📥 Install Package
+description: Install Node.js, NPM, and the package's NPM dependencies, and cache it.
+
+runs:
+  using: composite
+  steps:
+    - name: Install Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: "latest"
+        cache: "npm"
+
+    - name: Output versions
+      shell: bash
+      run: |
+        echo Node and NPM versions
+        node --version
+        npm --version
+
+    - name: Install NPM dependencies
+      shell: bash
+      run: npm install

.github/workflows/_build-lint.yaml

@@ -0,0 +1,20 @@
+name: ⚒️ Build - 🧹 Lint
+
+on: workflow_call
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: 📥 Install
+        uses: ./.github/actions/package-install
+
+      - name: Build
+        run: npm run build
+
+      - name: Lint
+        run: npm run lint

.github/workflows/_docs.yaml

@@ -0,0 +1,17 @@
+name: 📙 Documentation
+
+on: workflow_call
+
+jobs:
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: 📥 Install
+        uses: ./.github/actions/package-install
+
+      - name: Biuld documentation
+        run: npm run doc

.github/workflows/_tests.yaml

@@ -0,0 +1,37 @@
+name: 📝 Tests
+
+on: workflow_call
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: 📥 Install
+        uses: ./.github/actions/package-install
+
+      - name: Run tests
+        run: npm run testci
+        env:
+          JEST_JUNIT_OUTPUT_DIR: coverage/reports
+          JEST_JUNIT_OUTPUT_NAME: jest-junit.xml
+          JEST_JUNIT_ANCESTOR_SEPARATOR: " > "
+          JEST_JUNIT_UNIQUE_OUTPUT_NAME: false
+          JEST_JUNIT_SUITE_NAME: "{filepath}"
+          JEST_JUNIT_CLASSNAME: "{classname}"
+          JEST_JUNIT_TITLE: "{title}"
+
+      - name: Report test results
+        if: success() || failure()
+        uses: dorny/test-reporter@v1
+        with:
+          name: Jest Tests Report
+          path: coverage/reports/jest-*.xml
+          reporter: jest-junit
+          list-suites: failed
+          list-tests: failed
+          fail-on-error: false
+          token: ${{ github.token  }}

.github/workflows/ci.yaml

@@ -0,0 +1,29 @@
+name: ⚙️ CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  actions: read
+  checks: write
+
+jobs:
+  call-build-lint:
+    name: ⚒️ Build - 🧹 Lint
+    uses: ./.github/workflows/_build-lint.yaml
+
+  call-tests:
+    name: 📝 Tests
+    uses: ./.github/workflows/_tests.yaml
+
+  call-docs:
+    name: 📙 Documentation
+    uses: ./.github/workflows/_docs.yaml

.npmignore

@@ -1,4 +1,5 @@
 # config
+.github/
 .clang-format
 .editorconfig
 .eslintrc.json

README.md

@@ -1,4 +1,7 @@
 vcard-io
 ========
 
+[![License: MIT](https://img.shields.io/github/license/remileduc/vcards-io)](./LICENSE)
+[![⚙️ CI Status](https://github.com/remileduc/vcards-io/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/remileduc/vcards-io/actions/workflows/ci.yaml?query=branch%3Amain)
+
 vCard reader and writer - represents a vCard as a JSON object that can be exported

package.json

@@ -1,39 +1,41 @@
 {
-  "name": "vcards-io",
-  "version": "0.1.0",
-  "description": "vCard reader and writer - represents a vCard as a JSON object that can be exported",
-  "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "prepublish": "npm run build",
-    "build": "tsc",
-    "clean": "tsc --build --clean",
-    "test": "jest",
-	"lint": "eslint lib/",
-    "doc": "typedoc --plugin @mxssfd/typedoc-theme --theme my-theme --cleanOutputDir --includeVersion --readme ./README.md --out ./docs/ ./lib/index.ts"
-  },
-  "keywords": [
-    "vCard",
-    "vCards",
-	"vcf",
-    "contacts"
-  ],
-  "author": {
-    "name": "Rémi Ducceschi",
-    "url": "https://github.com/remileduc",
-    "email": "[email protected]"
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "@mxssfd/typedoc-theme": "^1.1.3",
-    "@types/jest": "^29.5.7",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
-    "eslint": "^8.53.0",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.1.1",
-    "typedoc": "^0.25.3",
-    "typescript": "^5.2.2"
-  }
+	"name": "vcards-io",
+	"version": "0.1.0",
+	"description": "vCard reader and writer - represents a vCard as a JSON object that can be exported",
+	"type": "module",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"scripts": {
+		"prepublish": "npm run build",
+		"build": "tsc",
+		"clean": "tsc --build --clean",
+		"test": "jest",
+		"testci": "jest --ci --testResultsProcessor='jest-junit'",
+		"lint": "eslint lib/",
+		"doc": "typedoc --plugin @mxssfd/typedoc-theme --theme my-theme --cleanOutputDir --includeVersion --readme ./README.md --out ./docs/ ./lib/index.ts"
+	},
+	"keywords": [
+		"vCard",
+		"vCards",
+		"vcf",
+		"contacts"
+	],
+	"author": {
+		"name": "Rémi Ducceschi",
+		"url": "https://github.com/remileduc",
+		"email": "[email protected]"
+	},
+	"license": "MIT",
+	"devDependencies": {
+		"@mxssfd/typedoc-theme": "^1.1.3",
+		"@types/jest": "^29.5.7",
+		"@typescript-eslint/eslint-plugin": "^6.10.0",
+		"@typescript-eslint/parser": "^6.10.0",
+		"eslint": "^8.53.0",
+		"jest": "^29.7.0",
+		"jest-junit": "^16.0.0",
+		"ts-jest": "^29.1.1",
+		"typedoc": "^0.25.3",
+		"typescript": "^5.2.2"
+	}
 }