Skip to content

Conversation

@MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented May 20, 2025

Description

This pull request includes updates to the NerdFonts PowerShell module, focusing on documentation enhancements, dependency updates, and compatibility improvements. Below are the most important changes:

Documentation Enhancements:

  • Added .LINK and .NOTES sections to Get-NerdFont and Install-NerdFont functions, providing links to the official NerdFonts documentation and GitHub repository for better user guidance. (src/functions/public/Get-NerdFont.ps1 [1] src/functions/public/Install-NerdFont.ps1 [2]

Dependency Updates:

  • Updated the required version of the Fonts module from 1.1.19 to 1.1.21 and added a new dependency on the Admin module with version 1.1.6 in the Install-NerdFont function. (src/functions/public/Install-NerdFont.ps1 src/functions/public/Install-NerdFont.ps1L1-R2)

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

@MariusStorhaug MariusStorhaug self-assigned this May 20, 2025
Copilot AI review requested due to automatic review settings May 20, 2025 20:50
@MariusStorhaug MariusStorhaug requested a review from a team as a code owner May 20, 2025 20:50
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the NerdFonts PowerShell module to improve documentation, update dependencies, and enhance compatibility. Key changes include updating module dependencies (increasing the required version for the Fonts module and adding the Admin module), adding .LINK and .NOTES documentation sections in both the Install-NerdFont and Get-NerdFont functions, and removing the PowerShellVersion constraint from the module manifest to broaden compatibility.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/manifest.psd1 Removed the PowerShellVersion constraint to improve compatibility
src/functions/public/Install-NerdFont.ps1 Updated module dependency versions and added documentation (.LINK and .NOTES)
src/functions/public/Get-NerdFont.ps1 Added documentation (.LINK and .NOTES) sections to guide users

@MariusStorhaug MariusStorhaug merged commit 74c9b0f into main May 20, 2025
34 checks passed
@MariusStorhaug MariusStorhaug deleted the fix branch May 20, 2025 21:40
@github-actions
Copy link
Contributor

Module NerdFonts - 1.0.25 published to the PowerShell Gallery.

@github-actions
Copy link
Contributor

GitHub release for NerdFonts v1.0.25 has been created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants