From 3cbe717af54b5e526ec156fa0a35f89005c5a012 Mon Sep 17 00:00:00 2001 From: Harwin Date: Tue, 3 Mar 2026 17:21:14 +0100 Subject: [PATCH 01/15] Add workflow to auto-update dependent repos on new version publish Co-Authored-By: Claude Opus 4.6 --- .github/workflows/update-dependents.yaml | 229 +++++++++++++++++++++++ 1 file changed, 229 insertions(+) create mode 100644 .github/workflows/update-dependents.yaml diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml new file mode 100644 index 0000000..db420f8 --- /dev/null +++ b/.github/workflows/update-dependents.yaml @@ -0,0 +1,229 @@ +name: Update Dependent Repos + +on: + workflow_run: + workflows: ["Publish to GitHub Packages Registry"] + types: + - completed + + workflow_dispatch: + inputs: + dry_run: + description: 'Discover dependents only, do not create PRs' + required: false + default: false + type: boolean + version_override: + description: 'Override version (e.g. 1.6.3) instead of reading from package.json' + required: false + type: string + +jobs: + update-dependents: + name: Update Dependent Repos + runs-on: ubuntu-latest + if: > + github.event_name == 'workflow_dispatch' || + github.event.workflow_run.conclusion == 'success' + steps: + - name: Checkout production branch + uses: actions/checkout@v4 + with: + ref: production + + - name: Extract version + id: version + run: | + if [ -n "${{ inputs.version_override }}" ]; then + VERSION="${{ inputs.version_override }}" + else + VERSION=$(jq -r .version package.json) + fi + echo "version=$VERSION" >> "$GITHUB_OUTPUT" + echo "Package version: $VERSION" + + - name: Discover dependent repos + id: discover + env: + GH_TOKEN: ${{ secrets.DEPENDENTS_PAT }} + run: | + echo "Searching for repos that depend on @athombv/jsdoc-template..." + + REPOS=$(gh api -X GET /search/code \ + --paginate \ + -f q='org:athombv "@athombv/jsdoc-template" filename:package.json' \ + --jq '.items[].repository.full_name' | sort -u) + + # Filter out this repo itself + SOURCE_REPO="${{ github.repository }}" + REPOS=$(echo "$REPOS" | grep -v "^${SOURCE_REPO}$" || true) + + if [ -z "$REPOS" ]; then + echo "No dependent repos found." + echo "repos=" >> "$GITHUB_OUTPUT" + exit 0 + fi + + echo "Found dependent repos:" + echo "$REPOS" + echo "repos<> "$GITHUB_OUTPUT" + echo "$REPOS" >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + - name: Create PRs in dependent repos + if: steps.discover.outputs.repos != '' + env: + GH_TOKEN: ${{ secrets.DEPENDENTS_PAT }} + VERSION: ${{ steps.version.outputs.version }} + DRY_RUN: ${{ inputs.dry_run || 'false' }} + run: | + BRANCH_NAME="chore/update-jsdoc-template-${VERSION}" + REPOS="${{ steps.discover.outputs.repos }}" + + SUCCESSES=0 + SKIPS=0 + FAILURES=0 + SUMMARY="" + + while IFS= read -r REPO; do + [ -z "$REPO" ] && continue + echo "" + echo "================================================" + echo "Processing: $REPO" + echo "================================================" + + # Check if a PR already exists for this branch + EXISTING_PR=$(gh pr list --repo "$REPO" --head "$BRANCH_NAME" --json number --jq '.[0].number' 2>/dev/null || true) + if [ -n "$EXISTING_PR" ]; then + echo "SKIP: PR #$EXISTING_PR already exists for branch $BRANCH_NAME" + SKIPS=$((SKIPS + 1)) + SUMMARY="${SUMMARY}\n SKIP: ${REPO} (PR #${EXISTING_PR} already exists)" + continue + fi + + if [ "$DRY_RUN" = "true" ]; then + echo "DRY RUN: Would create PR in $REPO" + SKIPS=$((SKIPS + 1)) + SUMMARY="${SUMMARY}\n DRY RUN: ${REPO}" + continue + fi + + # Clone the repo + WORK_DIR=$(mktemp -d) + if ! gh repo clone "$REPO" "$WORK_DIR" -- --depth 1 2>&1; then + echo "FAIL: Could not clone $REPO" + FAILURES=$((FAILURES + 1)) + SUMMARY="${SUMMARY}\n FAIL: ${REPO} (clone failed)" + rm -rf "$WORK_DIR" + sleep 2 + continue + fi + + cd "$WORK_DIR" + + # Check current version in package.json + CURRENT=$(jq -r ' + (.devDependencies // {} | .["@athombv/jsdoc-template"] // empty), + (.dependencies // {} | .["@athombv/jsdoc-template"] // empty) + ' package.json 2>/dev/null | head -1) + + if [ -z "$CURRENT" ]; then + echo "SKIP: @athombv/jsdoc-template not found in package.json" + SKIPS=$((SKIPS + 1)) + SUMMARY="${SUMMARY}\n SKIP: ${REPO} (dependency not found in package.json)" + cd - > /dev/null + rm -rf "$WORK_DIR" + sleep 2 + continue + fi + + echo "Current version spec: $CURRENT" + + # Extract semver prefix (^, ~, or empty) + PREFIX=$(echo "$CURRENT" | sed -E 's/^([^0-9]*).*/\1/') + CURRENT_VERSION=$(echo "$CURRENT" | sed -E 's/^[^0-9]*//') + + if [ "$CURRENT_VERSION" = "$VERSION" ]; then + echo "SKIP: Already on version $VERSION" + SKIPS=$((SKIPS + 1)) + SUMMARY="${SUMMARY}\n SKIP: ${REPO} (already on ${VERSION})" + cd - > /dev/null + rm -rf "$WORK_DIR" + sleep 2 + continue + fi + + NEW_SPEC="${PREFIX}${VERSION}" + echo "Updating: $CURRENT -> $NEW_SPEC" + + # Create branch + git checkout -b "$BRANCH_NAME" + + # Update package.json, checking both dependencies and devDependencies + jq --arg new "$NEW_SPEC" ' + if .dependencies["@athombv/jsdoc-template"] then + .dependencies["@athombv/jsdoc-template"] = $new + else . end | + if .devDependencies["@athombv/jsdoc-template"] then + .devDependencies["@athombv/jsdoc-template"] = $new + else . end + ' package.json > package.json.tmp && mv package.json.tmp package.json + + # Commit and push + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + git add package.json + git commit -m "chore: update @athombv/jsdoc-template to ${NEW_SPEC}" + + if ! git push origin "$BRANCH_NAME" 2>&1; then + echo "FAIL: Could not push to $REPO" + FAILURES=$((FAILURES + 1)) + SUMMARY="${SUMMARY}\n FAIL: ${REPO} (push failed)" + cd - > /dev/null + rm -rf "$WORK_DIR" + sleep 2 + continue + fi + + # Create PR + PR_URL=$(gh pr create \ + --repo "$REPO" \ + --head "$BRANCH_NAME" \ + --title "chore: update @athombv/jsdoc-template to ${NEW_SPEC}" \ + --body "$(cat <&1) || true + + if [ -n "$PR_URL" ]; then + echo "SUCCESS: Created PR -> $PR_URL" + SUCCESSES=$((SUCCESSES + 1)) + SUMMARY="${SUMMARY}\n OK: ${REPO} -> ${PR_URL}" + else + echo "FAIL: Could not create PR in $REPO" + FAILURES=$((FAILURES + 1)) + SUMMARY="${SUMMARY}\n FAIL: ${REPO} (PR creation failed)" + fi + + cd - > /dev/null + rm -rf "$WORK_DIR" + sleep 2 + done <<< "$REPOS" + + echo "" + echo "================================================" + echo "SUMMARY" + echo "================================================" + echo "Successes: $SUCCESSES" + echo "Skips: $SKIPS" + echo "Failures: $FAILURES" + echo -e "$SUMMARY" + + if [ "$FAILURES" -gt 0 ]; then + echo "" + echo "::warning::${FAILURES} repo(s) failed to update" + fi From 897ba42fc97d25341bdf75b0bd29bc37a7bd5c22 Mon Sep 17 00:00:00 2001 From: Harwin Date: Tue, 3 Mar 2026 17:32:49 +0100 Subject: [PATCH 02/15] Fix script injection vulnerabilities in update-dependents workflow Pass user inputs and step outputs via env vars instead of direct ${{ }} interpolation in run scripts to prevent shell injection. Add explicit permissions block and fix PR creation error handling. Co-Authored-By: Claude Opus 4.6 --- .github/workflows/update-dependents.yaml | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml index db420f8..3b11209 100644 --- a/.github/workflows/update-dependents.yaml +++ b/.github/workflows/update-dependents.yaml @@ -18,6 +18,9 @@ on: required: false type: string +permissions: + contents: read + jobs: update-dependents: name: Update Dependent Repos @@ -33,9 +36,11 @@ jobs: - name: Extract version id: version + env: + VERSION_OVERRIDE: ${{ inputs.version_override }} run: | - if [ -n "${{ inputs.version_override }}" ]; then - VERSION="${{ inputs.version_override }}" + if [ -n "$VERSION_OVERRIDE" ]; then + VERSION="$VERSION_OVERRIDE" else VERSION=$(jq -r .version package.json) fi @@ -46,6 +51,7 @@ jobs: id: discover env: GH_TOKEN: ${{ secrets.DEPENDENTS_PAT }} + SOURCE_REPO: ${{ github.repository }} run: | echo "Searching for repos that depend on @athombv/jsdoc-template..." @@ -55,7 +61,6 @@ jobs: --jq '.items[].repository.full_name' | sort -u) # Filter out this repo itself - SOURCE_REPO="${{ github.repository }}" REPOS=$(echo "$REPOS" | grep -v "^${SOURCE_REPO}$" || true) if [ -z "$REPOS" ]; then @@ -76,9 +81,9 @@ jobs: GH_TOKEN: ${{ secrets.DEPENDENTS_PAT }} VERSION: ${{ steps.version.outputs.version }} DRY_RUN: ${{ inputs.dry_run || 'false' }} + REPOS: ${{ steps.discover.outputs.repos }} run: | BRANCH_NAME="chore/update-jsdoc-template-${VERSION}" - REPOS="${{ steps.discover.outputs.repos }}" SUCCESSES=0 SKIPS=0 @@ -186,7 +191,7 @@ jobs: fi # Create PR - PR_URL=$(gh pr create \ + if PR_URL=$(gh pr create \ --repo "$REPO" \ --head "$BRANCH_NAME" \ --title "chore: update @athombv/jsdoc-template to ${NEW_SPEC}" \ @@ -197,9 +202,7 @@ jobs: - [ ] Run \`npm install\` locally to update \`package-lock.json\` - [ ] Verify the build still works EOF - )" 2>&1) || true - - if [ -n "$PR_URL" ]; then + )" 2>/dev/null); then echo "SUCCESS: Created PR -> $PR_URL" SUCCESSES=$((SUCCESSES + 1)) SUMMARY="${SUMMARY}\n OK: ${REPO} -> ${PR_URL}" From 8fc6311dcc447f6e536154c5d99985e74a76c919 Mon Sep 17 00:00:00 2001 From: Harwin Date: Thu, 5 Mar 2026 09:06:05 +0100 Subject: [PATCH 03/15] Use HOMEY_GITHUB_ACTIONS_BOT_PERSONAL_ACCESS_TOKEN in update-dependents workflow Co-Authored-By: Claude Opus 4.6 --- .github/workflows/update-dependents.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml index 3b11209..3dfeaf2 100644 --- a/.github/workflows/update-dependents.yaml +++ b/.github/workflows/update-dependents.yaml @@ -50,7 +50,7 @@ jobs: - name: Discover dependent repos id: discover env: - GH_TOKEN: ${{ secrets.DEPENDENTS_PAT }} + GH_TOKEN: ${{ secrets.HOMEY_GITHUB_ACTIONS_BOT_PERSONAL_ACCESS_TOKEN }} SOURCE_REPO: ${{ github.repository }} run: | echo "Searching for repos that depend on @athombv/jsdoc-template..." @@ -78,7 +78,7 @@ jobs: - name: Create PRs in dependent repos if: steps.discover.outputs.repos != '' env: - GH_TOKEN: ${{ secrets.DEPENDENTS_PAT }} + GH_TOKEN: ${{ secrets.HOMEY_GITHUB_ACTIONS_BOT_PERSONAL_ACCESS_TOKEN }} VERSION: ${{ steps.version.outputs.version }} DRY_RUN: ${{ inputs.dry_run || 'false' }} REPOS: ${{ steps.discover.outputs.repos }} From 9d5abca106c79b32e72dd5236e98966d3c808920 Mon Sep 17 00:00:00 2001 From: Harwin Date: Thu, 5 Mar 2026 09:12:12 +0100 Subject: [PATCH 04/15] Fix git push auth in update-dependents workflow Configure credential helper to use GH_TOKEN for HTTPS push operations. Co-Authored-By: Claude Opus 4.6 --- .github/workflows/update-dependents.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml index 3dfeaf2..2667a05 100644 --- a/.github/workflows/update-dependents.yaml +++ b/.github/workflows/update-dependents.yaml @@ -126,6 +126,9 @@ jobs: cd "$WORK_DIR" + # Configure git to use the token for pushing + git config credential.helper '!f() { echo "username=x-access-token"; echo "password=${GH_TOKEN}"; }; f' + # Check current version in package.json CURRENT=$(jq -r ' (.devDependencies // {} | .["@athombv/jsdoc-template"] // empty), From 64b2cb3706a54cfc0d581f054de9445566cadec7 Mon Sep 17 00:00:00 2001 From: Harwin Date: Thu, 5 Mar 2026 10:03:38 +0100 Subject: [PATCH 05/15] Update publishing instructions in README Co-Authored-By: Claude Opus 4.6 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9200c3e..22048ce 100644 --- a/README.md +++ b/README.md @@ -69,9 +69,9 @@ npm link @athombv/jsdoc-template > You have to relink the repository each time after you run `npm install` ## Publishing -1. On the `master` branch run `npm version [version]` (using a semantic version). -2. Push your changes, don't forget to push the git tags' as well. -3. Merge `master` to `production`, this will automatically publish the release. +1. Bump the version on `master` via the [Version workflow](https://github.com/athombv/jsdoc-template/actions/workflows/version.yaml). +2. Merge `master` to `production` — this will automatically publish the release to the GitHub Packages Registry. +3. Create PRs in dependent repos via the [Update Dependents workflow](https://github.com/athombv/jsdoc-template/actions/workflows/update-dependents.yaml). This will automatically discover repos in the `athombv` org that use `@athombv/jsdoc-template` and open PRs to update them to the new version. ## Configuration From a85b4ff939a02b5fae3890bee527f237f7278474 Mon Sep 17 00:00:00 2001 From: Harwin Date: Thu, 5 Mar 2026 10:12:25 +0100 Subject: [PATCH 06/15] Allow re-running update-dependents to update existing PRs Force-push to existing branches and skip PR creation when one already exists. Also removes the same-version skip so the workflow can be re-run to pick up changes without a version bump. Co-Authored-By: Claude Opus 4.6 --- .github/workflows/update-dependents.yaml | 32 ++++++++---------------- 1 file changed, 11 insertions(+), 21 deletions(-) diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml index 2667a05..4d12263 100644 --- a/.github/workflows/update-dependents.yaml +++ b/.github/workflows/update-dependents.yaml @@ -99,12 +99,6 @@ jobs: # Check if a PR already exists for this branch EXISTING_PR=$(gh pr list --repo "$REPO" --head "$BRANCH_NAME" --json number --jq '.[0].number' 2>/dev/null || true) - if [ -n "$EXISTING_PR" ]; then - echo "SKIP: PR #$EXISTING_PR already exists for branch $BRANCH_NAME" - SKIPS=$((SKIPS + 1)) - SUMMARY="${SUMMARY}\n SKIP: ${REPO} (PR #${EXISTING_PR} already exists)" - continue - fi if [ "$DRY_RUN" = "true" ]; then echo "DRY RUN: Would create PR in $REPO" @@ -151,16 +145,6 @@ jobs: PREFIX=$(echo "$CURRENT" | sed -E 's/^([^0-9]*).*/\1/') CURRENT_VERSION=$(echo "$CURRENT" | sed -E 's/^[^0-9]*//') - if [ "$CURRENT_VERSION" = "$VERSION" ]; then - echo "SKIP: Already on version $VERSION" - SKIPS=$((SKIPS + 1)) - SUMMARY="${SUMMARY}\n SKIP: ${REPO} (already on ${VERSION})" - cd - > /dev/null - rm -rf "$WORK_DIR" - sleep 2 - continue - fi - NEW_SPEC="${PREFIX}${VERSION}" echo "Updating: $CURRENT -> $NEW_SPEC" @@ -177,13 +161,16 @@ jobs: else . end ' package.json > package.json.tmp && mv package.json.tmp package.json + # Update lockfile + npm install --package-lock-only + # Commit and push git config user.name "github-actions[bot]" git config user.email "github-actions[bot]@users.noreply.github.com" - git add package.json + git add package.json package-lock.json git commit -m "chore: update @athombv/jsdoc-template to ${NEW_SPEC}" - if ! git push origin "$BRANCH_NAME" 2>&1; then + if ! git push --force origin "$BRANCH_NAME" 2>&1; then echo "FAIL: Could not push to $REPO" FAILURES=$((FAILURES + 1)) SUMMARY="${SUMMARY}\n FAIL: ${REPO} (push failed)" @@ -193,8 +180,12 @@ jobs: continue fi - # Create PR - if PR_URL=$(gh pr create \ + # Create PR if one doesn't already exist + if [ -n "$EXISTING_PR" ]; then + echo "SUCCESS: Updated existing PR #$EXISTING_PR" + SUCCESSES=$((SUCCESSES + 1)) + SUMMARY="${SUMMARY}\n OK: ${REPO} (updated PR #${EXISTING_PR})" + elif PR_URL=$(gh pr create \ --repo "$REPO" \ --head "$BRANCH_NAME" \ --title "chore: update @athombv/jsdoc-template to ${NEW_SPEC}" \ @@ -202,7 +193,6 @@ jobs: Automated update of \`@athombv/jsdoc-template\` from \`${CURRENT}\` to \`${NEW_SPEC}\`. ## Checklist - - [ ] Run \`npm install\` locally to update \`package-lock.json\` - [ ] Verify the build still works EOF )" 2>/dev/null); then From c2fabc04753a3a77d68099e5ca518bac1880fafa Mon Sep 17 00:00:00 2001 From: Harwin Date: Thu, 5 Mar 2026 10:27:29 +0100 Subject: [PATCH 07/15] Fix npm auth for GitHub Packages in update-dependents workflow Co-Authored-By: Claude Opus 4.6 --- .github/workflows/update-dependents.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml index 4d12263..efe22cd 100644 --- a/.github/workflows/update-dependents.yaml +++ b/.github/workflows/update-dependents.yaml @@ -161,6 +161,9 @@ jobs: else . end ' package.json > package.json.tmp && mv package.json.tmp package.json + # Authenticate npm with GitHub Packages + echo "//npm.pkg.github.com/:_authToken=${GH_TOKEN}" >> .npmrc + # Update lockfile npm install --package-lock-only From 84dcc69382e48db0166c764c8ec8de46127462eb Mon Sep 17 00:00:00 2001 From: Harwin Date: Thu, 5 Mar 2026 10:28:24 +0100 Subject: [PATCH 08/15] Add @athombv registry config for npm in update-dependents workflow Co-Authored-By: Claude Opus 4.6 --- .github/workflows/update-dependents.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml index efe22cd..5abc131 100644 --- a/.github/workflows/update-dependents.yaml +++ b/.github/workflows/update-dependents.yaml @@ -161,7 +161,8 @@ jobs: else . end ' package.json > package.json.tmp && mv package.json.tmp package.json - # Authenticate npm with GitHub Packages + # Configure npm to use GitHub Packages for @athombv scope + echo "@athombv:registry=https://npm.pkg.github.com" >> .npmrc echo "//npm.pkg.github.com/:_authToken=${GH_TOKEN}" >> .npmrc # Update lockfile From 0c9aae384b13bfd7eb08d7f33e772496a7253554 Mon Sep 17 00:00:00 2001 From: Harwin Date: Thu, 5 Mar 2026 10:44:19 +0100 Subject: [PATCH 09/15] Skip install scripts when updating lockfile in update-dependents workflow Prevents native compilation failures (e.g. node-gyp) in repos that don't have build dependencies available in the CI runner. Co-Authored-By: Claude Opus 4.6 --- .github/workflows/update-dependents.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml index 5abc131..e1bc074 100644 --- a/.github/workflows/update-dependents.yaml +++ b/.github/workflows/update-dependents.yaml @@ -166,7 +166,7 @@ jobs: echo "//npm.pkg.github.com/:_authToken=${GH_TOKEN}" >> .npmrc # Update lockfile - npm install --package-lock-only + npm install --package-lock-only --ignore-scripts # Commit and push git config user.name "github-actions[bot]" From b725074f9edd554898bd1040e443794bceb37561 Mon Sep 17 00:00:00 2001 From: Robin Bolscher Date: Mon, 18 May 2026 09:56:45 +0200 Subject: [PATCH 10/15] chore: prepare package for public distribution - Add GPL-3.0 LICENSE file - Document required .npmrc scope mapping in README - Set license to GPL-3.0 and fill in description and author in package.json --- LICENSE | 674 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 12 +- package.json | 6 +- 3 files changed, 687 insertions(+), 5 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..30ace6a --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/README.md b/README.md index 22048ce..56e3f92 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,21 @@ ## How to use this template -1. Install as a dev dependency +This package is publicly distributed via [GitHub Packages](https://github.com/athombv/homey-jsdoc-template/pkgs/npm/jsdoc-template). + +1. Add a `.npmrc` in the root of your project so npm resolves the `@athombv` scope to GitHub Packages: + +``` +@athombv:registry=https://npm.pkg.github.com +``` + +2. Install as a dev dependency ```bash $ npm i --save-dev @athombv/jsdoc-template ``` -2. Create `./jsdoc.json`: +3. Create `./jsdoc.json`: ```json { diff --git a/package.json b/package.json index 703af35..918d17c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@athombv/jsdoc-template", "version": "1.6.3", - "description": "", + "description": "JSDoc template used for Athom (Homey) developer documentation.", "main": "publish.js", "scripts": { "build": "NODE_ENV=none webpack", @@ -13,8 +13,8 @@ "/tmpl", "/publish.js" ], - "author": "", - "license": "ISC", + "author": "Athom B.V.", + "license": "GPL-3.0", "dependencies": { "css-loader": "^5.2.4", "highlight.js": "^10.7.2", From 5b6dcc8034205046c8afcb9b7b9e1fc2572a64e7 Mon Sep 17 00:00:00 2001 From: Robin Bolscher Date: Mon, 18 May 2026 10:06:39 +0200 Subject: [PATCH 11/15] chore: address copilot review feedback - Note in README that no GitHub token is required for install - Regenerate package-lock.json so root license reflects GPL-3.0 --- README.md | 2 +- package-lock.json | 412 +--------------------------------------------- 2 files changed, 8 insertions(+), 406 deletions(-) diff --git a/README.md b/README.md index 56e3f92..9a3d6e8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## How to use this template -This package is publicly distributed via [GitHub Packages](https://github.com/athombv/homey-jsdoc-template/pkgs/npm/jsdoc-template). +This package is publicly distributed via [GitHub Packages](https://github.com/athombv/homey-jsdoc-template/pkgs/npm/jsdoc-template). No GitHub token is required to install it. 1. Add a `.npmrc` in the root of your project so npm resolves the `@athombv` scope to GitHub Packages: diff --git a/package-lock.json b/package-lock.json index 728970a..f211a90 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,7 +7,7 @@ "": { "name": "@athombv/jsdoc-template", "version": "1.6.3", - "license": "ISC", + "license": "GPL-3.0", "dependencies": { "css-loader": "^5.2.4", "highlight.js": "^10.7.2", @@ -30,9 +30,6 @@ "url-loader": "^4.1.1", "webpack": "^5.37.0", "webpack-cli": "^4.6.0" - }, - "peerDependencies": { - "jsdoc": "3.6.x" } }, "node_modules/@ampproject/remapping": { @@ -471,6 +468,7 @@ "version": "7.18.6", "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.18.6.tgz", "integrity": "sha512-uQVSa9jJUe/G/304lXspfWVpKpK4euFLgGiMQFOCpM/bgcAdeoHwi/OQz23O9GK2osz26ZiXRRV9aV+Yl1O8tw==", + "dev": true, "bin": { "parser": "bin/babel-parser.js" }, @@ -1753,28 +1751,6 @@ "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.11.tgz", "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==" }, - "node_modules/@types/linkify-it": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-3.0.2.tgz", - "integrity": "sha512-HZQYqbiFVWufzCwexrvh694SOim8z2d+xJl5UNamcvQFejLY/2YUtzXHYi3cHdI7PMlS8ejH2slRAOJQ32aNbA==", - "peer": true - }, - "node_modules/@types/markdown-it": { - "version": "12.2.3", - "resolved": "https://registry.npmjs.org/@types/markdown-it/-/markdown-it-12.2.3.tgz", - "integrity": "sha512-GKMHFfv3458yYy+v/N8gjufHO6MSZKCOXpZc5GXIWWy8uldwfmPn98vp81gZ5f9SVw8YYBctgfJ22a2d7AOMeQ==", - "peer": true, - "dependencies": { - "@types/linkify-it": "*", - "@types/mdurl": "*" - } - }, - "node_modules/@types/mdurl": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@types/mdurl/-/mdurl-1.0.2.tgz", - "integrity": "sha512-eC4U9MlIcu2q0KQmXszyn5Akca/0jrQmwDRgpAMJai7qBWq4amIQhZyNau4VYGtCeALvW1/NtjzJJ567aZxfKA==", - "peer": true - }, "node_modules/@types/node": { "version": "18.0.0", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.0.0.tgz", @@ -2026,12 +2002,6 @@ "node": ">=4" } }, - "node_modules/argparse": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "peer": true - }, "node_modules/autoprefixer": { "version": "10.4.7", "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.7.tgz", @@ -2146,12 +2116,6 @@ "node": "*" } }, - "node_modules/bluebird": { - "version": "3.7.2", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", - "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", - "peer": true - }, "node_modules/boolbase": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", @@ -2239,18 +2203,6 @@ } ] }, - "node_modules/catharsis": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz", - "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==", - "peer": true, - "dependencies": { - "lodash": "^4.17.15" - }, - "engines": { - "node": ">= 10" - } - }, "node_modules/chalk": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", @@ -2902,6 +2854,7 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/entities/-/entities-2.1.0.tgz", "integrity": "sha512-hCx1oky9PFrJ611mf0ifBLBRW8lUUVRlFolb5gWRfIELabBlbp9xZvrqZLZAs+NxFnbfQoeGd8wDkygjg7U85w==", + "dev": true, "funding": { "url": "https://github.com/fb55/entities?sponsor=1" } @@ -3375,59 +3328,6 @@ "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", "dev": true }, - "node_modules/js2xmlparser": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.2.tgz", - "integrity": "sha512-6n4D8gLlLf1n5mNLQPRfViYzu9RATblzPEtm1SthMX1Pjao0r9YI9nw7ZIfRxQMERS87mcswrg+r/OYrPRX6jA==", - "peer": true, - "dependencies": { - "xmlcreate": "^2.0.4" - } - }, - "node_modules/jsdoc": { - "version": "3.6.10", - "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.10.tgz", - "integrity": "sha512-IdQ8ppSo5LKZ9o3M+LKIIK8i00DIe5msDvG3G81Km+1dhy0XrOWD0Ji8H61ElgyEj/O9KRLokgKbAM9XX9CJAg==", - "peer": true, - "dependencies": { - "@babel/parser": "^7.9.4", - "@types/markdown-it": "^12.2.3", - "bluebird": "^3.7.2", - "catharsis": "^0.9.0", - "escape-string-regexp": "^2.0.0", - "js2xmlparser": "^4.0.2", - "klaw": "^4.0.1", - "markdown-it": "^12.3.2", - "markdown-it-anchor": "^8.4.1", - "marked": "^4.0.10", - "mkdirp": "^1.0.4", - "requizzle": "^0.2.3", - "strip-json-comments": "^3.1.0", - "taffydb": "2.6.2", - "underscore": "~1.13.2" - }, - "bin": { - "jsdoc": "jsdoc.js" - }, - "engines": { - "node": ">=8.15.0" - } - }, - "node_modules/jsdoc/node_modules/escape-string-regexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", - "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", - "peer": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/jsdoc/node_modules/taffydb": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz", - "integrity": "sha512-y3JaeRSplks6NYQuCOj3ZFMO3j60rTwbuKCvZxsAraGYH2epusatvZ0baZYA01WsGqJBq/Dl6vOrMUJqyMj8kA==", - "peer": true - }, "node_modules/jsesc": { "version": "2.5.2", "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", @@ -3470,15 +3370,6 @@ "node": ">=0.10.0" } }, - "node_modules/klaw": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/klaw/-/klaw-4.0.1.tgz", - "integrity": "sha512-pgsE40/SvC7st04AHiISNewaIMUbY5V/K8b21ekiPiFoYs/EYSdsGa+FJArB1d441uq4Q8zZyIxvAzkGNlBdRw==", - "peer": true, - "engines": { - "node": ">=14.14.0" - } - }, "node_modules/klona": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/klona/-/klona-2.0.5.tgz", @@ -3503,15 +3394,6 @@ "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", "dev": true }, - "node_modules/linkify-it": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-3.0.3.tgz", - "integrity": "sha512-ynTsyrFSdE5oZ/O9GEf00kPngmOfVwazR5GKDq6EYfhlpFug3J2zybX56a2PRRpc9P+FuSoGNAwjlbDs9jJBPQ==", - "peer": true, - "dependencies": { - "uc.micro": "^1.0.1" - } - }, "node_modules/loader-runner": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.0.tgz", @@ -3545,12 +3427,6 @@ "node": ">=8" } }, - "node_modules/lodash": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", - "peer": true - }, "node_modules/lodash.debounce": { "version": "4.0.8", "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", @@ -3595,56 +3471,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/markdown-it": { - "version": "12.3.2", - "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-12.3.2.tgz", - "integrity": "sha512-TchMembfxfNVpHkbtriWltGWc+m3xszaRD0CZup7GFFhzIgQqxIfn3eGj1yZpfuflzPvfkt611B2Q/Bsk1YnGg==", - "peer": true, - "dependencies": { - "argparse": "^2.0.1", - "entities": "~2.1.0", - "linkify-it": "^3.0.1", - "mdurl": "^1.0.1", - "uc.micro": "^1.0.5" - }, - "bin": { - "markdown-it": "bin/markdown-it.js" - } - }, - "node_modules/markdown-it-anchor": { - "version": "8.6.4", - "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-8.6.4.tgz", - "integrity": "sha512-Ul4YVYZNxMJYALpKtu+ZRdrryYt/GlQ5CK+4l1bp/gWXOG2QWElt6AqF3Mih/wfUKdZbNAZVXGR73/n6U/8img==", - "peer": true, - "peerDependencies": { - "@types/markdown-it": "*", - "markdown-it": "*" - } - }, - "node_modules/marked": { - "version": "4.0.17", - "resolved": "https://registry.npmjs.org/marked/-/marked-4.0.17.tgz", - "integrity": "sha512-Wfk0ATOK5iPxM4ptrORkFemqroz0ZDxp5MWfYA7H/F+wO17NRWV5Ypxi6p3g2Xmw2bKeiYOl6oVnLHKxBA0VhA==", - "peer": true, - "bin": { - "marked": "bin/marked.js" - }, - "engines": { - "node": ">= 12" - } - }, "node_modules/mdn-data": { "version": "2.0.14", "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.14.tgz", "integrity": "sha512-dn6wd0uw5GsdswPFfsgMp5NSB0/aDe6fK94YJV/AJDYXL6HVLWBsxeq7js7Ad+mU2K9LAlwpk6kN2D5mwCPVow==", "dev": true }, - "node_modules/mdurl": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", - "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==", - "peer": true - }, "node_modules/merge-stream": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", @@ -3714,18 +3546,6 @@ "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==", "dev": true }, - "node_modules/mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "peer": true, - "bin": { - "mkdirp": "bin/cmd.js" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/ms": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", @@ -6039,15 +5859,6 @@ "jsesc": "bin/jsesc" } }, - "node_modules/requizzle": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.3.tgz", - "integrity": "sha512-YanoyJjykPxGHii0fZP0uUPEXpvqfBDxWV7s6GKAiiOsiqhX6vHNyW3Qzdmqp/iq/ExbhaGbVrjB4ruEVSM4GQ==", - "peer": true, - "dependencies": { - "lodash": "^4.17.14" - } - }, "node_modules/resolve": { "version": "1.22.1", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", @@ -6227,18 +6038,6 @@ "node": ">=0.10.0" } }, - "node_modules/strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "peer": true, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/style-loader": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/style-loader/-/style-loader-2.0.0.tgz", @@ -6454,18 +6253,6 @@ "node": ">=4" } }, - "node_modules/uc.micro": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", - "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", - "peer": true - }, - "node_modules/underscore": { - "version": "1.13.4", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.4.tgz", - "integrity": "sha512-BQFnUDuAQ4Yf/cYY5LNrK9NCJFKriaRbD9uR1fTeXnBeoa97W0i41qkZfGO9pSo8I5KzjAcSY2XYtdf0oKd7KQ==", - "peer": true - }, "node_modules/unicode-canonical-property-names-ecmascript": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz", @@ -6769,12 +6556,6 @@ "integrity": "sha512-JcKqAHLPxcdb9KM49dufGXn2x3ssnfjbcaQdLlfZsL9rH9wgDQjUtDxbo8NE0F6SFvydeu1VhZe7hZuHsB2/pw==", "dev": true }, - "node_modules/xmlcreate": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.4.tgz", - "integrity": "sha512-nquOebG4sngPmGPICTS5EnxqhKbCmz5Ox5hsszI2T6U5qdrJizBc+0ilYSEjTSzU0yZcmvppztXe/5Al5fUwdg==", - "peer": true - }, "node_modules/yallist": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", @@ -7119,7 +6900,8 @@ "@babel/parser": { "version": "7.18.6", "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.18.6.tgz", - "integrity": "sha512-uQVSa9jJUe/G/304lXspfWVpKpK4euFLgGiMQFOCpM/bgcAdeoHwi/OQz23O9GK2osz26ZiXRRV9aV+Yl1O8tw==" + "integrity": "sha512-uQVSa9jJUe/G/304lXspfWVpKpK4euFLgGiMQFOCpM/bgcAdeoHwi/OQz23O9GK2osz26ZiXRRV9aV+Yl1O8tw==", + "dev": true }, "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { "version": "7.18.6", @@ -8002,28 +7784,6 @@ "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.11.tgz", "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==" }, - "@types/linkify-it": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-3.0.2.tgz", - "integrity": "sha512-HZQYqbiFVWufzCwexrvh694SOim8z2d+xJl5UNamcvQFejLY/2YUtzXHYi3cHdI7PMlS8ejH2slRAOJQ32aNbA==", - "peer": true - }, - "@types/markdown-it": { - "version": "12.2.3", - "resolved": "https://registry.npmjs.org/@types/markdown-it/-/markdown-it-12.2.3.tgz", - "integrity": "sha512-GKMHFfv3458yYy+v/N8gjufHO6MSZKCOXpZc5GXIWWy8uldwfmPn98vp81gZ5f9SVw8YYBctgfJ22a2d7AOMeQ==", - "peer": true, - "requires": { - "@types/linkify-it": "*", - "@types/mdurl": "*" - } - }, - "@types/mdurl": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@types/mdurl/-/mdurl-1.0.2.tgz", - "integrity": "sha512-eC4U9MlIcu2q0KQmXszyn5Akca/0jrQmwDRgpAMJai7qBWq4amIQhZyNau4VYGtCeALvW1/NtjzJJ567aZxfKA==", - "peer": true - }, "@types/node": { "version": "18.0.0", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.0.0.tgz", @@ -8242,12 +8002,6 @@ "color-convert": "^1.9.0" } }, - "argparse": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "peer": true - }, "autoprefixer": { "version": "10.4.7", "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.7.tgz", @@ -8324,12 +8078,6 @@ "resolved": "https://registry.npmjs.org/big.js/-/big.js-5.2.2.tgz", "integrity": "sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==" }, - "bluebird": { - "version": "3.7.2", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", - "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", - "peer": true - }, "boolbase": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", @@ -8385,15 +8133,6 @@ "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001361.tgz", "integrity": "sha512-ybhCrjNtkFji1/Wto6SSJKkWk6kZgVQsDq5QI83SafsF6FXv2JB4df9eEdH6g8sdGgqTXrFLjAxqBGgYoU3azQ==" }, - "catharsis": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz", - "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==", - "peer": true, - "requires": { - "lodash": "^4.17.15" - } - }, "chalk": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", @@ -8864,7 +8603,8 @@ "entities": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/entities/-/entities-2.1.0.tgz", - "integrity": "sha512-hCx1oky9PFrJ611mf0ifBLBRW8lUUVRlFolb5gWRfIELabBlbp9xZvrqZLZAs+NxFnbfQoeGd8wDkygjg7U85w==" + "integrity": "sha512-hCx1oky9PFrJ611mf0ifBLBRW8lUUVRlFolb5gWRfIELabBlbp9xZvrqZLZAs+NxFnbfQoeGd8wDkygjg7U85w==", + "dev": true }, "envinfo": { "version": "7.8.1", @@ -9203,52 +8943,6 @@ "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", "dev": true }, - "js2xmlparser": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.2.tgz", - "integrity": "sha512-6n4D8gLlLf1n5mNLQPRfViYzu9RATblzPEtm1SthMX1Pjao0r9YI9nw7ZIfRxQMERS87mcswrg+r/OYrPRX6jA==", - "peer": true, - "requires": { - "xmlcreate": "^2.0.4" - } - }, - "jsdoc": { - "version": "3.6.10", - "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.10.tgz", - "integrity": "sha512-IdQ8ppSo5LKZ9o3M+LKIIK8i00DIe5msDvG3G81Km+1dhy0XrOWD0Ji8H61ElgyEj/O9KRLokgKbAM9XX9CJAg==", - "peer": true, - "requires": { - "@babel/parser": "^7.9.4", - "@types/markdown-it": "^12.2.3", - "bluebird": "^3.7.2", - "catharsis": "^0.9.0", - "escape-string-regexp": "^2.0.0", - "js2xmlparser": "^4.0.2", - "klaw": "^4.0.1", - "markdown-it": "^12.3.2", - "markdown-it-anchor": "^8.4.1", - "marked": "^4.0.10", - "mkdirp": "^1.0.4", - "requizzle": "^0.2.3", - "strip-json-comments": "^3.1.0", - "taffydb": "2.6.2", - "underscore": "~1.13.2" - }, - "dependencies": { - "escape-string-regexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", - "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", - "peer": true - }, - "taffydb": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz", - "integrity": "sha512-y3JaeRSplks6NYQuCOj3ZFMO3j60rTwbuKCvZxsAraGYH2epusatvZ0baZYA01WsGqJBq/Dl6vOrMUJqyMj8kA==", - "peer": true - } - } - }, "jsesc": { "version": "2.5.2", "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", @@ -9276,12 +8970,6 @@ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", "dev": true }, - "klaw": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/klaw/-/klaw-4.0.1.tgz", - "integrity": "sha512-pgsE40/SvC7st04AHiISNewaIMUbY5V/K8b21ekiPiFoYs/EYSdsGa+FJArB1d441uq4Q8zZyIxvAzkGNlBdRw==", - "peer": true - }, "klona": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/klona/-/klona-2.0.5.tgz", @@ -9300,15 +8988,6 @@ "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", "dev": true }, - "linkify-it": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-3.0.3.tgz", - "integrity": "sha512-ynTsyrFSdE5oZ/O9GEf00kPngmOfVwazR5GKDq6EYfhlpFug3J2zybX56a2PRRpc9P+FuSoGNAwjlbDs9jJBPQ==", - "peer": true, - "requires": { - "uc.micro": "^1.0.1" - } - }, "loader-runner": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.0.tgz", @@ -9333,12 +9012,6 @@ "p-locate": "^4.1.0" } }, - "lodash": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", - "peer": true - }, "lodash.debounce": { "version": "4.0.8", "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", @@ -9374,44 +9047,12 @@ "semver": "^6.0.0" } }, - "markdown-it": { - "version": "12.3.2", - "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-12.3.2.tgz", - "integrity": "sha512-TchMembfxfNVpHkbtriWltGWc+m3xszaRD0CZup7GFFhzIgQqxIfn3eGj1yZpfuflzPvfkt611B2Q/Bsk1YnGg==", - "peer": true, - "requires": { - "argparse": "^2.0.1", - "entities": "~2.1.0", - "linkify-it": "^3.0.1", - "mdurl": "^1.0.1", - "uc.micro": "^1.0.5" - } - }, - "markdown-it-anchor": { - "version": "8.6.4", - "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-8.6.4.tgz", - "integrity": "sha512-Ul4YVYZNxMJYALpKtu+ZRdrryYt/GlQ5CK+4l1bp/gWXOG2QWElt6AqF3Mih/wfUKdZbNAZVXGR73/n6U/8img==", - "peer": true, - "requires": {} - }, - "marked": { - "version": "4.0.17", - "resolved": "https://registry.npmjs.org/marked/-/marked-4.0.17.tgz", - "integrity": "sha512-Wfk0ATOK5iPxM4ptrORkFemqroz0ZDxp5MWfYA7H/F+wO17NRWV5Ypxi6p3g2Xmw2bKeiYOl6oVnLHKxBA0VhA==", - "peer": true - }, "mdn-data": { "version": "2.0.14", "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.14.tgz", "integrity": "sha512-dn6wd0uw5GsdswPFfsgMp5NSB0/aDe6fK94YJV/AJDYXL6HVLWBsxeq7js7Ad+mU2K9LAlwpk6kN2D5mwCPVow==", "dev": true }, - "mdurl": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", - "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==", - "peer": true - }, "merge-stream": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", @@ -9460,12 +9101,6 @@ "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==", "dev": true }, - "mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "peer": true - }, "ms": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", @@ -11193,15 +10828,6 @@ } } }, - "requizzle": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.3.tgz", - "integrity": "sha512-YanoyJjykPxGHii0fZP0uUPEXpvqfBDxWV7s6GKAiiOsiqhX6vHNyW3Qzdmqp/iq/ExbhaGbVrjB4ruEVSM4GQ==", - "peer": true, - "requires": { - "lodash": "^4.17.14" - } - }, "resolve": { "version": "1.22.1", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", @@ -11336,12 +10962,6 @@ "ansi-regex": "^2.0.0" } }, - "strip-json-comments": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "peer": true - }, "style-loader": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/style-loader/-/style-loader-2.0.0.tgz", @@ -11479,18 +11099,6 @@ "integrity": "sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==", "dev": true }, - "uc.micro": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", - "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", - "peer": true - }, - "underscore": { - "version": "1.13.4", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.4.tgz", - "integrity": "sha512-BQFnUDuAQ4Yf/cYY5LNrK9NCJFKriaRbD9uR1fTeXnBeoa97W0i41qkZfGO9pSo8I5KzjAcSY2XYtdf0oKd7KQ==", - "peer": true - }, "unicode-canonical-property-names-ecmascript": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz", @@ -11683,12 +11291,6 @@ "integrity": "sha512-JcKqAHLPxcdb9KM49dufGXn2x3ssnfjbcaQdLlfZsL9rH9wgDQjUtDxbo8NE0F6SFvydeu1VhZe7hZuHsB2/pw==", "dev": true }, - "xmlcreate": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.4.tgz", - "integrity": "sha512-nquOebG4sngPmGPICTS5EnxqhKbCmz5Ox5hsszI2T6U5qdrJizBc+0ilYSEjTSzU0yZcmvppztXe/5Al5fUwdg==", - "peer": true - }, "yallist": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", From ba5fb0fada47eefb0ffd1e3ff34c5c2fcb8044be Mon Sep 17 00:00:00 2001 From: Robin Bolscher Date: Mon, 18 May 2026 10:30:06 +0200 Subject: [PATCH 12/15] chore: publish to npmjs.org via OIDC - Replace GitHub Packages publish workflow with OIDC publish to registry.npmjs.org based on the node-homey template. - Add publishConfig.access:public required for a public scoped package. - Remove .npmrc instructions from README; the default npm registry now serves the package without any consumer-side config. - Update update-dependents workflow to point at the new publish workflow and strip the legacy @athombv -> GitHub Packages mapping from any dependent .npmrc when bumping the version. --- .github/workflows/gpr-publish.yaml | 46 ---------------- .github/workflows/publish-package-npm.yml | 66 +++++++++++++++++++++++ .github/workflows/update-dependents.yaml | 16 ++++-- README.md | 14 ++--- package.json | 3 ++ 5 files changed, 84 insertions(+), 61 deletions(-) delete mode 100644 .github/workflows/gpr-publish.yaml create mode 100644 .github/workflows/publish-package-npm.yml diff --git a/.github/workflows/gpr-publish.yaml b/.github/workflows/gpr-publish.yaml deleted file mode 100644 index 0459893..0000000 --- a/.github/workflows/gpr-publish.yaml +++ /dev/null @@ -1,46 +0,0 @@ -name: Publish to GitHub Packages Registry - -# Version: 1.0.0 -# Modified: No -# Requirements: -# - The `name` in `package.json` should start with `@athombv/`. -# -# Ensure you've run `npm version major|minor|patch` on the `master` branch before merging to `production`. -# -# This GitHub Workflow: -# 1. [Optional] If `npm run build` exists. If so, it runs `npm ci` and `npm run build`. -# 2. Publishes the package to the GitHub Packages Registry. - -on: - push: - branches: - - production - -jobs: - publish: - name: Publish - runs-on: ubuntu-latest - steps: - - - name: Checkout git repository - uses: actions/checkout@v3 - - - name: Set up node 16 environment - uses: actions/setup-node@v3 - with: - node-version: 16 - registry-url: 'https://npm.pkg.github.com' - - - name: Build - run: | - if cat package.json | jq -e .scripts.build; then - echo "`npm run build` does exist. Building..." - npm ci - npm run build - else - echo "`npm run build` does not exist. Skipping build..." - fi - - name: Publish - run: npm publish - env: - NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/publish-package-npm.yml b/.github/workflows/publish-package-npm.yml new file mode 100644 index 0000000..5d08c3d --- /dev/null +++ b/.github/workflows/publish-package-npm.yml @@ -0,0 +1,66 @@ +name: Publish to NPM + +# Publishes the package to npmjs.org using OIDC (Trusted Publisher). +# +# Requirements: +# - The `@athombv/jsdoc-template` package must have a Trusted Publisher +# configured on npmjs.org pointing at this repository and workflow file. +# - Bump the version on `master` via the Version workflow before merging to +# `production`. +# +# Steps: +# 1. Verifies a `files` array is present in package.json. +# 2. Installs dependencies and runs `npm run build` if it exists. +# 3. On `workflow_dispatch`: runs `npm publish --dry-run`. +# 4. On push to `production`: publishes to npmjs.org. + +on: + workflow_dispatch: + push: + branches: + - production + +permissions: + id-token: write + contents: read + +jobs: + publish: + name: Publish + runs-on: ubuntu-latest + steps: + - name: Checkout git repository + uses: actions/checkout@v4 + + - name: Set up node + uses: actions/setup-node@v4 + with: + node-version: '20' + registry-url: 'https://registry.npmjs.org/' + + - name: Verify files field in package.json + run: | + if ! jq -e .files package.json > /dev/null; then + echo "Missing 'files' array in package.json." + exit 1 + fi + + - name: Install dependencies + run: npm ci --ignore-scripts --audit=false + + - name: Build + run: | + if jq --exit-status '.scripts | has("build")' package.json > /dev/null; then + echo "Running npm run build..." + npm run build + else + echo "No build script; skipping." + fi + + - name: Publish dry run + if: github.event_name == 'workflow_dispatch' + run: npm publish --dry-run + + - name: Publish + if: github.ref == 'refs/heads/production' + run: npm publish diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml index e1bc074..e3968f9 100644 --- a/.github/workflows/update-dependents.yaml +++ b/.github/workflows/update-dependents.yaml @@ -2,7 +2,7 @@ name: Update Dependent Repos on: workflow_run: - workflows: ["Publish to GitHub Packages Registry"] + workflows: ["Publish to NPM"] types: - completed @@ -161,9 +161,15 @@ jobs: else . end ' package.json > package.json.tmp && mv package.json.tmp package.json - # Configure npm to use GitHub Packages for @athombv scope - echo "@athombv:registry=https://npm.pkg.github.com" >> .npmrc - echo "//npm.pkg.github.com/:_authToken=${GH_TOKEN}" >> .npmrc + # Strip any leftover @athombv -> GitHub Packages mapping from .npmrc + # so the new version resolves from npmjs.org. Remove the file when + # nothing meaningful remains. + if [ -f .npmrc ]; then + sed -i '/@athombv:registry/d; /npm.pkg.github.com/d' .npmrc + if [ ! -s .npmrc ] || ! grep -qv '^\s*$' .npmrc; then + rm -f .npmrc + fi + fi # Update lockfile npm install --package-lock-only --ignore-scripts @@ -171,6 +177,8 @@ jobs: # Commit and push git config user.name "github-actions[bot]" git config user.email "github-actions[bot]@users.noreply.github.com" + # Stage updates and any .npmrc add/modify/delete + git add -A -- package.json package-lock.json .npmrc 2>/dev/null || true git add package.json package-lock.json git commit -m "chore: update @athombv/jsdoc-template to ${NEW_SPEC}" diff --git a/README.md b/README.md index 9a3d6e8..c4f1667 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,13 @@ ## How to use this template -This package is publicly distributed via [GitHub Packages](https://github.com/athombv/homey-jsdoc-template/pkgs/npm/jsdoc-template). No GitHub token is required to install it. - -1. Add a `.npmrc` in the root of your project so npm resolves the `@athombv` scope to GitHub Packages: - -``` -@athombv:registry=https://npm.pkg.github.com -``` - -2. Install as a dev dependency +1. Install as a dev dependency ```bash $ npm i --save-dev @athombv/jsdoc-template ``` -3. Create `./jsdoc.json`: +2. Create `./jsdoc.json`: ```json { @@ -78,7 +70,7 @@ npm link @athombv/jsdoc-template ## Publishing 1. Bump the version on `master` via the [Version workflow](https://github.com/athombv/jsdoc-template/actions/workflows/version.yaml). -2. Merge `master` to `production` — this will automatically publish the release to the GitHub Packages Registry. +2. Merge `master` to `production` - this will automatically publish the release to npmjs.org via OIDC (Trusted Publisher). 3. Create PRs in dependent repos via the [Update Dependents workflow](https://github.com/athombv/jsdoc-template/actions/workflows/update-dependents.yaml). This will automatically discover repos in the `athombv` org that use `@athombv/jsdoc-template` and open PRs to update them to the new version. diff --git a/package.json b/package.json index 918d17c..62f8402 100644 --- a/package.json +++ b/package.json @@ -13,6 +13,9 @@ "/tmpl", "/publish.js" ], + "publishConfig": { + "access": "public" + }, "author": "Athom B.V.", "license": "GPL-3.0", "dependencies": { From 2c469d39a30bb0346d43870b55fa369f2722bbe3 Mon Sep 17 00:00:00 2001 From: Robin Bolscher Date: Mon, 18 May 2026 11:21:27 +0200 Subject: [PATCH 13/15] chore: address copilot review feedback - Use Node 24 in publish workflow so the bundled npm (>=11.5.1) supports OIDC for Trusted Publisher; Node 20 ships npm 10.x and would fail auth. - Rename publish-package-npm.yml to .yaml for consistency with the other workflows in this repo, before any Trusted Publisher binding to the filename gets created on npmjs.org. - Replace the redundant git add with a guarded stage that only touches .npmrc when it exists or is tracked, and stops swallowing real errors. --- ...{publish-package-npm.yml => publish-package-npm.yaml} | 3 ++- .github/workflows/update-dependents.yaml | 9 ++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) rename .github/workflows/{publish-package-npm.yml => publish-package-npm.yaml} (94%) diff --git a/.github/workflows/publish-package-npm.yml b/.github/workflows/publish-package-npm.yaml similarity index 94% rename from .github/workflows/publish-package-npm.yml rename to .github/workflows/publish-package-npm.yaml index 5d08c3d..3ce8172 100644 --- a/.github/workflows/publish-package-npm.yml +++ b/.github/workflows/publish-package-npm.yaml @@ -35,7 +35,8 @@ jobs: - name: Set up node uses: actions/setup-node@v4 with: - node-version: '20' + # Node 24 bundles npm >= 11.5.1, required for OIDC `npm publish`. + node-version: '24' registry-url: 'https://registry.npmjs.org/' - name: Verify files field in package.json diff --git a/.github/workflows/update-dependents.yaml b/.github/workflows/update-dependents.yaml index e3968f9..c618435 100644 --- a/.github/workflows/update-dependents.yaml +++ b/.github/workflows/update-dependents.yaml @@ -177,9 +177,12 @@ jobs: # Commit and push git config user.name "github-actions[bot]" git config user.email "github-actions[bot]@users.noreply.github.com" - # Stage updates and any .npmrc add/modify/delete - git add -A -- package.json package-lock.json .npmrc 2>/dev/null || true - git add package.json package-lock.json + # Stage the version bump, plus any add/modify/delete to .npmrc + # if it currently exists or is tracked in the repo. + git add -A -- package.json package-lock.json + if [ -e .npmrc ] || git ls-files --error-unmatch .npmrc > /dev/null 2>&1; then + git add -A -- .npmrc + fi git commit -m "chore: update @athombv/jsdoc-template to ${NEW_SPEC}" if ! git push --force origin "$BRANCH_NAME" 2>&1; then From d0a0b517e661909dfea0aef0e417136b9479d9cd Mon Sep 17 00:00:00 2001 From: Robin Bolscher Date: Mon, 18 May 2026 11:27:52 +0200 Subject: [PATCH 14/15] chore: address copilot review feedback - Guard the real publish step on both event_name=push and the production ref so a manual workflow_dispatch from production cannot trigger both the dry-run and the real publish in one run. - Pass --provenance to both publish invocations to attach an OIDC-backed provenance attestation, which is the main reason to migrate to npm's Trusted Publishers. --- .github/workflows/publish-package-npm.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/publish-package-npm.yaml b/.github/workflows/publish-package-npm.yaml index 3ce8172..507f92a 100644 --- a/.github/workflows/publish-package-npm.yaml +++ b/.github/workflows/publish-package-npm.yaml @@ -60,8 +60,8 @@ jobs: - name: Publish dry run if: github.event_name == 'workflow_dispatch' - run: npm publish --dry-run + run: npm publish --dry-run --provenance - name: Publish - if: github.ref == 'refs/heads/production' - run: npm publish + if: github.event_name == 'push' && github.ref == 'refs/heads/production' + run: npm publish --provenance From d38e4821b78542dae5269545a0e8f94f7afe7a33 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 18 May 2026 09:59:35 +0000 Subject: [PATCH 15/15] 1.7.0 --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index f211a90..349ae90 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@athombv/jsdoc-template", - "version": "1.6.3", + "version": "1.7.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@athombv/jsdoc-template", - "version": "1.6.3", + "version": "1.7.0", "license": "GPL-3.0", "dependencies": { "css-loader": "^5.2.4", diff --git a/package.json b/package.json index 62f8402..a477932 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@athombv/jsdoc-template", - "version": "1.6.3", + "version": "1.7.0", "description": "JSDoc template used for Athom (Homey) developer documentation.", "main": "publish.js", "scripts": {