Skip to content
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

Bump command reference and fix PowerShell casing #212

Merged
merged 8 commits into from
Jun 30, 2022
Merged

Bump command reference and fix PowerShell casing #212

merged 8 commits into from
Jun 30, 2022

Conversation

bravo-kernel
Copy link
Collaborator

@bravo-kernel bravo-kernel commented Jun 26, 2022

This fixes:

  • The indentation issues for complex multiline code examples in the Alt3.Docusaurus.PowerShell module (not released yet)
  • Spelling of PowerShell. FYI the PowerShell keyword in mdx front matter is coming from the -MetaKeywords parameter used by the generate-command-reference.ps1 in this repo

@fflaten:

  1. Please review carefully and let me know if I can merge. Looks good to me 💃
  2. FYI when using code blocks: empty lines below a line with single opening curly bracket are causing havoc. Fixed in the Alt3 module by removing those empty lines but I think it should be fixed in the Pester source as well. An example: https://github.com/pester/Pester/blob/main/src/Main.ps1#L36.
  3. Same for empty lines above a single closing curly bracket.

docs/commands/InModuleScope.mdx Outdated Show resolved Hide resolved
docs/commands/InModuleScope.mdx Outdated Show resolved Hide resolved
docs/commands/InModuleScope.mdx Outdated Show resolved Hide resolved
docs/commands/Mock.mdx Show resolved Hide resolved
docs/commands/New-Fixture.mdx Outdated Show resolved Hide resolved
docs/commands/New-PesterConfiguration.mdx Show resolved Hide resolved
@fflaten
Copy link
Collaborator

fflaten commented Jun 26, 2022

  1. FYI when using code blocks: empty lines below a line with single opening curly bracket are causing havoc. Fixed in the Alt3 module by removing those empty lines but I think it should be fixed in the Pester source as well. An example: https://github.com/pester/Pester/blob/main/src/Main.ps1#L36.
  2. Same for empty lines above a single closing curly bracket.

We can fix those in source. Guessing it's mostly examples since they won't get formatted by VSCode to follow our Stroustrup-style. Do you want to our should I?

@bravo-kernel
Copy link
Collaborator Author

Thanks, I would prefer not to touch the Pester repo to be honest so if you could.. awesome 💃

@bravo-kernel
Copy link
Collaborator Author

bravo-kernel commented Jun 26, 2022

Pester is hands on the best test suite for my module 👍

I think all fixes have been resolved except for:

@bravo-kernel
Copy link
Collaborator Author

It think we should merge this, then take it from there. @fflaten you ok with that?

Copy link
Collaborator

@fflaten fflaten left a comment

Choose a reason for hiding this comment

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

Broken indentation = new linebreaks in the middle of line. Ready to merge after.

Comment on lines +67 to +68
SkipRun: Runs the discovery phase but skips run.
Use it with PassThru to get object populated with all tests.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

Comment on lines +60 to +61
Throw: Throw an exception when test run fails.
When used together with Exit, throwing an exception is preferred.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

Comment on lines +56 to +57
Exit: Exit with non-zero exit code when the test run fails.
When used together with Throw, throwing an exception is preferred.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

Comment on lines +81 to +82
Line: Filter by file and scriptblock start line, useful to run parsed tests programmatically to avoid problems with expanded names.
Example: 'C:\tests\file1.Tests.ps1:37'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

Comment on lines +88 to +89
FullName: Full name of test with -like wildcards, joined by dot.
Example: '*.describe Get-Item.test1'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

Comment on lines +109 to +110
ExcludeTests: Exclude tests from code coverage.
This uses the TestFilter from general configuration.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

Comment on lines +129 to +130
OutputFormat: Format to use for test result report.
Possible values: NUnitXml, NUnit2.5 or JUnitXml
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

Comment on lines +143 to +144
ErrorAction: Controls if Should throws on error.
Use 'Stop' to throw on error, or 'Continue' to fail at the end of the test.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

Comment on lines +155 to +156
WriteDebugMessagesFrom: Write Debug messages from a given source, WriteDebugMessages must be set to true for this to work.
You can use like wildcards to get messages from multiple sources, as well as * to get everything.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

Comment on lines +162 to +163
ReturnRawResultObject: Returns unfiltered result object, this is for development only.
Do not rely on this object for additional properties, non-public properties will be renamed without previous notice.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Broken indentation

@bravo-kernel
Copy link
Collaborator Author

Yeah man, see this comment earlier #212 (comment).

One of the two points I think we should just accept for now.

@bravo-kernel
Copy link
Collaborator Author

Merging as discussed. Will release a new version of the Alt3 module the coming days so we can start (and start debugging) from this point.

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.

None yet

2 participants