Docs: migrate HOW-TO wiki pages to main documentation #5463
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Migrate 3 HOW-TO wiki pages to both docs systems: - HOW-TO: Correctly stub stdout - HOW-TO: Use environment variables - Mess with globals Part of mochajs#5248 wiki migration effort
TG199
changed the title
JoshuaKGoldberg
requested changes
Sep 25, 2025
| @@ -0,0 +1,36 @@ | |||
| --- | |||
| description: Learn how to use environment variables in Mocha tests | |||
| title: HOW-TO: Use environment variables | |||
There was a problem hiding this comment.
I get a build error on this and the other HOW-TO file:
docs → explainers/environment-variables.mdx frontmatter does not match collection schema.
title: Required
The title: frontmatter is indeed invalid. You'll need to escape it with quotes. The : is getting interpreted as invalid YML.
title: "HOW-TO: Use environment variables"That being said, I don't think there's any need to keep to the HOW-TO. All of these "Explainers" section pages are variants of "how to" guides. So, I would say it should match the existing titles convention:
Suggested change
| title: HOW-TO: Use environment variables | |
| title: Environment variables |
Comment on lines
+34
to
+36
| Any issues or questions please contact us on Gitter. | ||
|
|
||
| Thanks |
There was a problem hiding this comment.
Too much copypasta 🍝
Suggested change
| Any issues or questions please contact us on Gitter. | |
| Thanks |
| title: HOW-TO: Use environment variables | ||
| --- | ||
|
|
||
| Sometimes you might want your test to make use of variables set on an environment-level. Common reasons for this include |
There was a problem hiding this comment.
Suggested change
| Sometimes you might want your test to make use of variables set on an environment-level. Common reasons for this include | |
| Sometimes you might want your test to make use of variables set on an environment-level. Common reasons for this include: |
| @@ -0,0 +1,57 @@ | |||
| --- | |||
| description: How to work with global variables in Mocha tests | |||
| title: Mess with globals | |||
There was a problem hiding this comment.
"Mess with" is fun phrasing, but these days we're more ... cleaned up.
Suggested change
| title: Mess with globals | |
| title: Globals |
| --- | ||
| Related issue [#1582](https://github.com/mochajs/mocha/issues/1582) | ||
|
|
||
| If your test messes with globals, a reasonable expectation is that you will clean up after yourself. This is not impossible in the case of `process.stdout.write()` or `console.log()`. In fact, it's pretty easy. |
There was a problem hiding this comment.
I know this is just moving code over, but we shouldn't say things are "easy".
Suggested change
| If your test messes with globals, a reasonable expectation is that you will clean up after yourself. This is not impossible in the case of `process.stdout.write()` or `console.log()`. In fact, it's pretty easy. | |
| If your test manipulates globals, a reasonable expectation is that you will clean up after yourself. This includes commonly called methods such as `process.stdout.write()` or `console.log()`. |
JoshuaKGoldberg
added
the
status: waiting for author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
status: accepting prsOverview
Migrate 3 HOW-TO wiki pages to both docs systems:
Part of #5248 wiki migration effort