🩹 [Patch]: Current Jwt module ready for maintained publication

.github/PSModule.yml

@@ -5,3 +5,27 @@
 Test:
  CodeCoverage:
  PercentTarget: 0
+# TestResults:
+# Skip: true
+# SourceCode:
+# Skip: true
+# PSModule:
+# Skip: true
+# Module:
+# Windows:
+# Skip: true
+# MacOS:
+# Skip: true
+Build:
+ Docs:
+ Skip: true
+
+Linter:
+ env:
+ VALIDATE_BIOME_FORMAT: false
+ VALIDATE_BIOME_LINT: false
+ VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
+ VALIDATE_JSCPD: false
+ VALIDATE_JSON_PRETTIER: false
+ VALIDATE_MARKDOWN_PRETTIER: false
+ VALIDATE_YAML_PRETTIER: false

.github/linters/.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = ./.github/linters
+ignore-words-list = afterall

.github/linters/.markdown-lint.yml

@@ -8,18 +8,19 @@
 ###############
 # Rules by id #
 ###############
-MD004: false # Unordered list style
+MD004: false # Unordered list style
 MD007:
- indent: 2 # Unordered list indentation
+ indent: 2 # Unordered list indentation
 MD013:
- line_length: 808 # Line length
+ line_length: 808 # Line length
+MD024: false # no-duplicate-heading, INPUTS and OUTPUTS _can_ be the same item
 MD026:
- punctuation: ".,;:!。，；:"  # List of not allowed
-MD029: false # Ordered list item prefix
-MD033: false # Allow inline HTML
-MD036: false # Emphasis used instead of a heading
+ punctuation: '.,;:!。，；:' # List of not allowed
+MD029: false # Ordered list item prefix
+MD033: false # Allow inline HTML
+MD036: false # Emphasis used instead of a heading
 
 #################
 # Rules by tags #
 #################
-blank_lines: false # Error on blank lines
+blank_lines: false # Error on blank lines

.github/linters/trivy.yaml

@@ -0,0 +1,10 @@
+scan:
+ disable-telemetry: true
+ scanners:
+ - vuln
+ - misconfig
+ - secret
+ skip-files:
+ # src/JWT.psm1 is a build artifact generated by Process-PSModule and is
+ # not present in source. Skip it so lint runs against checked-in files only.
+ - src/JWT.psm1

.github/workflows/Process-PSModule.yml

@@ -1,8 +1,9 @@
 name: Process-PSModule
 
-run-name: "Process-PSModule - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
-
 on:
+ workflow_dispatch:
+ schedule:
+ - cron: '0 0 * * *'
  pull_request:
  branches:
  - main
@@ -26,6 +27,5 @@ permissions:
 
 jobs:
  Process-PSModule:
- uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v4
- secrets:
- APIKEY: ${{ secrets.APIKEY }}
+ uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@11117919e65242d3388727819a751f74ad24ea9e # v5.5.0
+ secrets: inherit

README.md

@@ -1,53 +1,54 @@
-# {{ NAME }}
+# Jwt
 
-{{ DESCRIPTION }}
-
-## Prerequisites
-
-This uses the following external resources:
-- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module.
+`Jwt` is a PowerShell module for creating and verifying JSON Web Tokens. This repository maintains the current `Jwt` module command surface under PSModule maintenance so existing users can continue to install and use the package from PowerShell Gallery.
 
 ## Installation
 
-To install the module from the PowerShell Gallery, you can use the following command:
-
 ```powershell
-Install-PSResource -Name {{ NAME }}
-Import-Module -Name {{ NAME }}
+Install-PSResource -Name Jwt
+Import-Module -Name Jwt
 ```
 
-## Usage
+## Commands
 
-Here is a list of example that are typical use cases for the module.
-
-### Example 1: Greet an entity
-
-Provide examples for typical commands that a user would like to do with the module.
+The maintained module exports the same JWT commands and alias used by the current package:
 
 ```powershell
-Greet-Entity -Name 'World'
-Hello, World!
+ConvertFrom-Base64UrlString
+ConvertTo-Base64UrlString
+Get-JwtHeader
+Get-JwtPayload
+New-Jwt
+Test-Jwt
+Verify-JwtSignature
 ```
 
-### Example 2
+## Usage
 
-Provide examples for typical commands that a user would like to do with the module.
+Create and validate an HMAC-signed JWT:
 
 ```powershell
-Import-Module -Name PSModuleTemplate
-```
+$header = '{"alg":"HS256","typ":"JWT"}'
+$payload = '{"sub":"1234567890","name":"John Doe","admin":true,"iat":1516239022}'
+$secret = 'a-string-secret-at-least-256-bits-long'
 
-### Find more examples
+$jwt = New-Jwt -Header $header -PayloadJson $payload -Secret $secret
+Test-Jwt -jwt $jwt -Secret $secret
+```
 
-To find more examples of how to use the module, please refer to the [examples](examples) folder.
+Read the header and payload from an existing token:
 
-Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module.
-To find examples of each of the commands you can use Get-Help -Examples 'CommandName'.
+```powershell
+Get-JwtHeader -jwt $jwt
+Get-JwtPayload -jwt $jwt
+```
 
-## Documentation
+For more information about each command, use PowerShell help:
 
-Link to further documentation if available, or describe where in the repository users can find more detailed documentation about
-the module's functions and features.
+```powershell
+Get-Command -Module Jwt
+Get-Help New-Jwt -Full
+```
 
 ## Contributing