Skip to content

Commit dde4b24

Browse files
[Init]: Boilerplate scaffold removed (#12)
The module repository no longer contains placeholder template code from the PSModule framework scaffolding. Only the `New-Jwt` placeholder function remains, signaling that the module is ready for actual JWT implementation work. - Fixes #11 ## Changed: Repository content All template/demo artifacts are removed — classes (`Book`, `SecretWriter`), functions (`Get-PSModuleTest`, `New-PSModuleTest`, `Set-PSModuleTest`, `Test-PSModuleTest`), variables (`Planets`, `Moons`, `SolarSystems`), data files, format definitions, type extensions, init scripts, nested modules, script loaders, examples, and the manifest override file. What remains in `src/`: ``` src/ functions/ public/ New-Jwt.ps1 ``` The `New-Jwt` function emits a warning that it is not yet implemented. This gives CI a valid function to build and test against while development proceeds in #3. ## Changed: Test file The test file is renamed from `PSModuleTest.Tests.ps1` to `Jwt.Tests.ps1` with a single test verifying the placeholder warning output. ## Changed: README Rewritten to describe the Jwt module — name, purpose, installation, and current development status. ## Technical Details - Removed 32 files totaling ~660 lines of template code - Code coverage target in `.github/PSModule.yml` lowered from 50% to 0% — the placeholder function has no meaningful logic to cover - The `manifest.psd1` is removed because it is optional in the PSModule framework (only needed to override generated values); will be recreated in #3 when module metadata is defined - This PR completes the "Skeleton cleanup" section of the implementation plan in #3
1 parent 486bfb9 commit dde4b24

32 files changed

Lines changed: 56 additions & 663 deletions

.github/PSModule.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Test:
66
CodeCoverage:
7-
PercentTarget: 50
7+
PercentTarget: 0
88
# TestResults:
99
# Skip: true
1010
# SourceCode:

README.md

Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,37 @@
1-
# {{ NAME }}
1+
# Jwt
22

3-
{{ DESCRIPTION }}
3+
A PowerShell module for creating and managing JSON Web Tokens (JWT).
44

55
## Prerequisites
66

7-
This uses the following external resources:
7+
- [PowerShell 7+](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell)
88
- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module.
99

1010
## Installation
1111

12-
To install the module from the PowerShell Gallery, you can use the following command:
13-
1412
```powershell
15-
Install-PSResource -Name {{ NAME }}
16-
Import-Module -Name {{ NAME }}
13+
Install-PSResource -Name Jwt
14+
Import-Module -Name Jwt
1715
```
1816

1917
## Usage
2018

21-
Here is a list of example that are typical use cases for the module.
22-
23-
### Example 1: Greet an entity
24-
25-
Provide examples for typical commands that a user would like to do with the module.
19+
> [!NOTE]
20+
> This module is under active development. The placeholder function `New-Jwt` is available but not yet implemented.
2621
2722
```powershell
28-
Greet-Entity -Name 'World'
29-
Hello, World!
23+
New-Jwt
3024
```
3125

32-
### Example 2
26+
## Documentation
3327

34-
Provide examples for typical commands that a user would like to do with the module.
28+
For more information about the module's functions and features, use:
3529

3630
```powershell
37-
Import-Module -Name PSModuleTemplate
31+
Get-Command -Module Jwt
32+
Get-Help New-Jwt
3833
```
3934

40-
### Find more examples
41-
42-
To find more examples of how to use the module, please refer to the [examples](examples) folder.
43-
44-
Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module.
45-
To find examples of each of the commands you can use Get-Help -Examples 'CommandName'.
46-
47-
## Documentation
48-
49-
Link to further documentation if available, or describe where in the repository users can find more detailed documentation about
50-
the module's functions and features.
51-
5235
## Contributing
5336

5437
Coder or not, you can contribute to the project! We welcome all contributions.

examples/General.ps1

Lines changed: 0 additions & 19 deletions
This file was deleted.

src/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/assemblies/LsonLib.dll

-42.5 KB
Binary file not shown.

src/classes/private/SecretWriter.ps1

Lines changed: 0 additions & 15 deletions
This file was deleted.

src/classes/public/Book.ps1

Lines changed: 0 additions & 147 deletions
This file was deleted.

src/data/Config.psd1

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/data/Settings.psd1

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/finally.ps1

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)