Merge remote-tracking branch 'upstream/main'

Author: podfeet

.github/workflows/xkpasswd.yml

@@ -0,0 +1,53 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy xkpasswd to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Use Node.js '18.x'
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test
+      - run: npm run docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: 'dist'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,11 +1,17 @@
+![XKPasswdJS](https://github.com/bartificer/xkpasswd-js/actions/workflows/xkpasswd.yml/badge.svg)
+
 # XKPasswdJS — The Official JavaScript Port of Crypt::HSXKPasswd
 
 [Bart Busschots](https://www.bartb.ie/) created the [Crypt::HSXKPasswd](https://metacpan.org/pod/Crypt::HSXKPasswd) Perl module to be a liberally licensed ([2-clause BSD](https://opensource.org/licenses/BSD-2-Clause)) password generator for producing secure but memorable passwords using the word-based approach made famous by the [*Correct Horse Battery Staple* XKCD comic](https://xkcd.com/936/).
 
 ![To anyone who understands information theory and security and is in an infuriating argument with someone who does not (possibly involving mixed case), I sincerely apologize.](https://imgs.xkcd.com/comics/password_strength.png)
- 
+
 Bart is leading this port of the Perl module to JavaScript with the [NosillaCast community](https://podfeet.com/slack) as part of the on-going Programming By Stealth blog/podcast series](https://pbs.bartificer.net) he produces with [Allison Sheridan](https://www.podfeet.com/blog/about/).
 
+## Current version of the app
+
+For anyone interesting in just playing with the current version, which is rather limited in functionality, you can check out the app here: <a href="https://bartificer.github.io/xkpasswd-js/">XKPasswd</a>
+
 ## Project Plan
 
 The plan is to develop this port in the following broad stages:
@@ -118,4 +124,4 @@ When writing code, make sure it's in line with the project's ESLint configuratio
 When writing doc comments:
 
 1. Use `@param` to specify parameters (don't use `@args`).
-2. Use `@returns` to describe return values (don't use `@return`).
+2. Use `@returns` to describe return values (don't use `@return`).

jsdoc.conf.json

@@ -8,8 +8,10 @@
     "include": [
       "./src/"
     ],
-    "includePattern": ".+\\.(mjs|js|jsdoc)$"
+    "includePattern": ".+\\.(mjs|js|jsdoc)$",
+    "excludePattern": ".*statistics.*"
   },
+  "sourceType": "module",
   "plugins": [
     "plugins/markdown"
   ],