Initial commit

.gitattributes

@@ -0,0 +1,15 @@
+# Needed for publishing of examples, build worker defaults to core.autocrlf=input.
+* text eol=autocrlf
+
+*.mof   text eol=crlf
+*.sh    text eol=lf
+*.svg   eol=lf
+
+# Ensure any exe files are treated as binary
+*.exe binary
+*.jpg binary
+*.xl* binary
+*.pfx binary
+*.png binary
+*.dll binary
+*.so  binary

.github/CODEOWNERS

@@ -0,0 +1,50 @@
+# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+* @PSModule/module-maintainers
+
+# Order is important; the last matching pattern takes the most
+# precedence. When someone opens a pull request that only
+# modifies JS files, only @js-owner and not the global
+# owner(s) will be requested for a review.
+# *.js    @js-owner
+
+# You can also use email addresses if you prefer. They'll be
+# used to look up users just like we do for commit author
+# emails.
+# *.go docs@example.com
+
+# Teams can be specified as code owners as well. Teams should
+# be identified in the format @org/team-name. Teams must have
+# explicit write access to the repository. In this example,
+# the octocats team in the octo-org organization owns all .txt files.
+# *.txt @octo-org/octocats
+
+# In this example, @doctocat owns any files in the build/logs
+# directory at the root of the repository and any of its
+# subdirectories.
+# /build/logs/ @doctocat
+
+# The `docs/*` pattern will match files like
+# `docs/getting-started.md` but not further nested files like
+# `docs/build-app/troubleshooting.md`.
+# docs/*  docs@example.com
+
+# In this example, @octocat owns any file in an apps directory
+# anywhere in your repository.
+# apps/ @octocat
+
+# In this example, @doctocat owns any file in the `/docs`
+# directory in the root of your repository and any of its
+# subdirectories.
+# /docs/ @doctocat
+
+# In this example, @octocat owns any file in the `/apps`
+# directory in the root of your repository except for the `/apps/github`
+# subdirectory, as its owners are left empty.
+# /apps/ @octocat
+# /apps/github

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: github-actions # See documentation for possible values
+    directory: / # Location of package manifests
+    schedule:
+      interval: weekly

.github/linters/.markdown-lint.yml

@@ -0,0 +1,25 @@
+###########################
+## Markdown Linter rules ##
+###########################
+
+# Linter rules doc:
+# - https://github.com/DavidAnson/markdownlint
+
+###############
+# Rules by id #
+###############
+MD004: false                  # Unordered list style
+MD007:
+  indent: 2                   # Unordered list indentation
+MD013:
+  line_length: 808            # Line length
+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
+
+#################
+# Rules by tags #
+#################
+blank_lines: false  # Error on blank lines

.github/linters/.powershell-psscriptanalyzer.psd1

@@ -0,0 +1,17 @@
+#Documentation: https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-settings
+@{
+    #CustomRulePath='path\to\CustomRuleModule.psm1'
+    #RecurseCustomRulePath='path\of\customrules'
+    #Severity = @(
+    #    'Error'
+    #    'Warning'
+    #)
+    #IncludeDefaultRules=${true}
+    ExcludeRules = @(
+        'PSMissingModuleManifestField'
+    )
+    #IncludeRules = @(
+    #    'PSAvoidUsingWriteHost',
+    #    'MyCustomRuleName'
+    #)
+}

.github/release.yml

@@ -0,0 +1,18 @@
+# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes
+
+changelog:
+  exclude:
+    labels:
+      - NoRelease
+  categories:
+    - title: 🌟 Breaking Changes
+      labels:
+        - Major
+        - Breaking
+    - title: 🚀 New Features
+      labels:
+        - Minor
+        - Feature
+    - title: Other Changes
+      labels:
+        - '*'

.github/workflows/Linter.yml

@@ -0,0 +1,31 @@
+name: Linter
+
+run-name: "Linter - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
+
+on: [pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  packages: read
+  statuses: write
+
+jobs:
+  Lint:
+    name: Lint code base
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Lint code base
+        uses: super-linter/super-linter@latest
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+          VALIDATE_MARKDOWN_PRETTIER: false
+          VALIDATE_YAML_PRETTIER: false

.github/workflows/Nightly-Run.yml

@@ -0,0 +1,16 @@
+name: Nightly Run
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+
+permissions:
+  contents: read
+  pull-requests: write
+  statuses: write
+
+jobs:
+  Process-PSModule:
+    uses: PSModule/Process-PSModule/.github/workflows/CI.yml@v3
+    secrets: inherit

.github/workflows/Process-PSModule.yml

@@ -0,0 +1,30 @@
+name: Process-PSModule
+
+run-name: "Process-PSModule - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
+
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - closed
+      - opened
+      - reopened
+      - synchronize
+      - labeled
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  pull-requests: write
+  statuses: write
+  pages: write
+  id-token: write
+
+jobs:
+  Process-PSModule:
+    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v3
+    secrets: inherit

.gitignore

@@ -0,0 +1,13 @@
+# VS Code files for those working on multiple tools
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/*
+
+# PSModule framework outputs folder
+outputs/*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 PSModule
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,69 @@
+# {{ NAME }}
+
+{{ DESCRIPTION }}
+
+## Prerequisites
+
+This uses the following external resources:
+- The [PSModule framework](https://github.com/PSModule) for building, testing and publishing the module.
+
+## Installation
+
+To install the module from the PowerShell Gallery, you can use the following command:
+
+```powershell
+Install-PSResource -Name {{ NAME }}
+Import-Module -Name {{ NAME }}
+```
+
+## Usage
+
+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.
+
+```powershell
+Greet-Entity -Name 'World'
+Hello, World!
+```
+
+### Example 2
+
+Provide examples for typical commands that a user would like to do with the module.
+
+```powershell
+Import-Module -Name PSModuleTemplate
+```
+
+### Find more examples
+
+To find more examples of how to use the module, please refer to the [examples](examples) folder.
+
+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'.
+
+## Documentation
+
+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.
+
+## Contributing
+
+Coder or not, you can contribute to the project! We welcome all contributions.
+
+### For Users
+
+If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
+product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
+Please see the issues tab on this project and submit a new issue that matches your needs.
+
+### For Developers
+
+If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
+You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement.
+
+## Acknowledgements
+
+Here is a list of people and projects that helped this project in some way.

examples/General.ps1

@@ -0,0 +1,19 @@
+<#
+  .SYNOPSIS
+    This is a general example of how to use the module.
+#>
+
+# Import the module
+Import-Module -Name 'PSModule'
+
+# Define the path to the font file
+$FontFilePath = 'C:\Fonts\CodeNewRoman\CodeNewRomanNerdFontPropo-Regular.tff'
+
+# Install the font
+Install-Font -Path $FontFilePath -Verbose
+
+# List installed fonts
+Get-Font -Name 'CodeNewRomanNerdFontPropo-Regular'
+
+# Uninstall the font
+Get-Font -Name 'CodeNewRomanNerdFontPropo-Regular' | Uninstall-Font -Verbose