Merge pull request #3 from FiddlyDigital:devDocs

Adding Doc Generation

.eslintignore

@@ -1,4 +1,5 @@
 node_modules
 tests
 build
-dist
+dist
+docs

.github/workflows/main.yml

@@ -1,22 +1,45 @@
-name: NPM Publish
+name: Release Pipeline
 
 on:
   push:
     branches:
      - main
+
+permissions:
+  contents: write
 
 jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
         with:
-          node-version: 16
-      - run: npm i
-      - run: npm run build
-      - run: npm run test
-      - uses: JS-DevTools/npm-publish@v1
+          node-version: 18
+
+      - name: Install Package Dependencies
+        run: npm ci
+
+      - name: Build the Package
+        run: npm run build
+
+      - name: Run Tests
+        run: npm run test
+
+      - name: Publish Package to NPM 🚀
+        uses: JS-DevTools/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}
           access: public
+
+      - name: Generate Documentation
+        run: npm run docs:generate
+
+      - name: Publish Docs to ghpages 📕
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -22,6 +22,7 @@
 *.swp
 
 dist
+docs
 build
 coverage
 lib-cov

package.json

@@ -33,6 +33,8 @@
   ],
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "docs:generate": "typedoc --options ./typedoc.json",
+    "docs:host": "http-server -p 3030 -c -1",
     "lint": "eslint --ignore-path .eslintignore --ext .js,.ts .",
     "test": "jest tests --verbose --config=./tests/jest.config.cjs"
   },
@@ -52,9 +54,11 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-promise": "^6.1.1",
+    "http-server": "^14.1.1",
     "jest": "^29.5.0",
     "ts-jest": "^29.1.0",
     "tsup": "^7.1.0",
+    "typedoc": "^0.24.8",
     "typescript": "^5.1.3"
   }
-}
+}

typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "entryPoints": ["./src/index.ts"],
+    "out": "docs"
+}