Skip to content

🪲 [Fix]: Fix linter settings and docs#5

Merged
MariusStorhaug merged 8 commits intomainfrom
fixDocs
Oct 11, 2025
Merged

🪲 [Fix]: Fix linter settings and docs#5
MariusStorhaug merged 8 commits intomainfrom
fixDocs

Conversation

@MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Oct 6, 2025

This pull request includes updates to configuration files and PowerShell scripts to improve linting controls and documentation. The main changes are grouped into configuration improvements and documentation enhancements.

Configuration improvements:

  • Added a new Linter section to .github/PSModule.yml to explicitly disable several validation checks in the CI environment, such as Biome format/lint, GitHub Actions Zizmor, JSCPD, and various Prettier validations.
  • Updated .github/linters/.markdown-lint.yml to disable the MD024 rule (no duplicate headings allowed) and clarified the punctuation list for MD026, allowing for more flexibility in markdown documentation.

Documentation enhancements:

  • Added a .DESCRIPTION section to the comment-based help in src/functions/private/Get-InternalPSModule.ps1 to provide more detailed documentation for the function.
  • Added a .DESCRIPTION section to the comment-based help in src/functions/private/Set-InternalPSModule.ps1 for improved clarity and completeness of the function's documentation.

@MariusStorhaug MariusStorhaug self-assigned this Oct 6, 2025
Copilot AI review requested due to automatic review settings October 6, 2025 22:57
Copy link

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 disables multiple linter validations in the PowerShell module configuration to fix linter settings issues.

  • Adds a new Linter section with environment variables to disable various validation tools
  • Disables 7 different linter validations including Biome, GitHub Actions Zizmor, JSCPD, and Prettier formatters

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI review requested due to automatic review settings October 8, 2025 09:45
Copy link

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

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


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI review requested due to automatic review settings October 9, 2025 21:08
Copy link

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI review requested due to automatic review settings October 11, 2025 07:11
Copy link

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@MariusStorhaug MariusStorhaug merged commit 802de6c into main Oct 11, 2025
38 checks passed
@MariusStorhaug MariusStorhaug deleted the fixDocs branch October 11, 2025 07:18
@github-actions
Copy link

Module MemoryMappedFile - 0.0.3 published to the PowerShell Gallery.

@github-actions
Copy link

GitHub release for MemoryMappedFile v0.0.3 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.

1 participant