Skip to content

Fix Build-PSBuildMarkdown + Lint Fixes #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 12 commits into from
Closed

Fix Build-PSBuildMarkdown + Lint Fixes #75

wants to merge 12 commits into from

Conversation

HeyItsGilbert
Copy link
Member

  • Remove extra item from New-MarkdownHelp splat that would result in a failure
    when using $PSBPreference.Docs.Overwrite = $true
  • Clean up some failing Script Analyzer settings, including moving the file.

Description

There was an extra item being added to the hashtable. This resolves that.

This also addresses several scriptanalyzer warnings.

Related Issue

n\a

Motivation and Context

This fixes a failure scenario with the new Overwrite feature.

How Has This Been Tested?

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have added this change to the CHANGELOG.md.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@HeyItsGilbert HeyItsGilbert marked this pull request as ready for review March 31, 2025 23:44
@HeyItsGilbert HeyItsGilbert requested a review from joshooaj March 31, 2025 23:48
@HeyItsGilbert HeyItsGilbert marked this pull request as draft April 1, 2025 00:05
@joshooaj
Copy link
Member

@HeyItsGilbert I just realized this is still pending a review. Was this not a part of what was published to the gallery on April 1st in v0.7.1?

@HeyItsGilbert
Copy link
Member Author

I guess not? I'll check when I get to my computer.

@HeyItsGilbert HeyItsGilbert changed the title 0.7.1: Fix Build-PSBuildMarkdown + Lint Fixes Fix Build-PSBuildMarkdown + Lint Fixes Jul 23, 2025
@HeyItsGilbert HeyItsGilbert marked this pull request as ready for review July 23, 2025 00:13
@HeyItsGilbert HeyItsGilbert enabled auto-merge (squash) July 23, 2025 00:14
@HeyItsGilbert HeyItsGilbert disabled auto-merge July 25, 2025 00:41
@HeyItsGilbert HeyItsGilbert marked this pull request as draft July 27, 2025 20:27
…and improve parameter formatting

* Updated `[cmdletbinding()]` to `[CmdletBinding()]` for consistency.
* Enhanced readability by aligning parameter assignments in `$newMDParams`.
* Added new words to `cspell.json` for better spell checking.
* Migrate `ScriptAnalyzerSettings.psd1` to `tests` directory and update paths.
* Enhance task definitions in `psakeFile.ps1` for better readability and consistency.
* Add new exclusion rule for `PSUseApprovedVerbs` in the script analysis settings.
…andling and suppress warnings

* Added suppression attributes for unused parameters in `Publish-PSBuildModule` and `Test-PSBuildPester`.
* Enhanced `CmdletBinding` attribute casing for consistency.
* Refined parameter validation logic for better clarity and maintainability.
…ate changelog

* Remove extra item from `New-MarkdownHelp` splat to prevent failure with `$PSBPreference.Docs.Overwrite = $true`
* Clean up failing Script Analyzer settings and relocate the configuration file.
…hance psake file

* Introduced two new launch configurations for debugging PowerShell scripts in VSCode.
* Updated `psakeFile.ps1` to correct property casing and added functionality to control documentation overwrite behavior.
* Enhanced tests to verify the documentation overwrite feature.
* Build tests now run in TempDir
* TestModule moved into fixtures folder.
* Added test for docs
…cation`

* Ensures proper stack management for directory changes in tests.
* Improves cleanup in `AfterAll` by restoring the previous location.
* Introduced a new `DotSource.psm1` file to facilitate testing of dot-sourced public functions.
* This file includes logic to import both public and private functions for comprehensive testing.
* Removed conditional logic for setting `$script:testModuleOutputPath`.
* Ensured output path is consistently set relative to the test module source.
* Updated `Start-Job` script block declaration for consistency.
… consistency

* Standardize function declaration to lowercase in `Get-HelloWorld.ps1`.
* Update module import path in `psakeFile.ps1` to use `$global:PSBOutput`.
* Clean up unnecessary `Set-Location` commands in test setup.
* Ensure output paths are correctly handled for better compatibility.
@HeyItsGilbert
Copy link
Member Author

After reviewing this again, I'm deciding to close this and I'll be fixing things in smaller batches. This got out of control way too fast.

@HeyItsGilbert HeyItsGilbert deleted the 0.7.1 branch August 2, 2025 00:24
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.

3 participants