Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

docs: add ClientRedirects.astro (#5324)

Josh Goldberg ✨b88d441cc761
diff --git a/docs-next/astro.config.ts b/docs-next/astro.config.ts
index 0c40ae4b..a895d861 100644
--- a/docs-next/astro.config.ts
+++ b/docs-next/astro.config.ts
@@ -44,6 +44,7 @@ export default defineConfig({
{ label: "Arrow functions", slug: "features/arrow-functions" },
{ label: "Assertions", slug: "features/assertions" },
{ label: "Asynchronous code", slug: "features/asynchronous-code" },
+ { label: "Diffs", slug: "features/diffs" },
{ label: "Error codes", slug: "features/error-codes" },
{ label: "Global fixtures", slug: "features/global-fixtures" },
{ label: "Hooks", slug: "features/hooks" },
@@ -56,6 +57,7 @@ export default defineConfig({
{
collapsed: true,
items: [
+ { label: "About", slug: "interfaces/about" },
{ label: "BDD (default)", slug: "interfaces/bdd" },
{ label: "TDD", slug: "interfaces/tdd" },
{ label: "Exports", slug: "interfaces/exports" },
@@ -68,6 +70,7 @@ export default defineConfig({
{
collapsed: true,
items: [
+ { label: "About", slug: "reporters/about" },
{ label: "Spec (default)", slug: "reporters/spec" },
{ label: "Doc", slug: "reporters/doc" },
{ label: "Dot", slug: "reporters/dot" },
diff --git a/docs-next/src/components/ClientRedirects.astro b/docs-next/src/components/ClientRedirects.astro
new file mode 100644
index 00000000..45294a32
--- /dev/null
+++ b/docs-next/src/components/ClientRedirects.astro
@@ -0,0 +1,198 @@
+<script>
+ const knownHashes = {
+ "-allow-uncaught": "running/cli/#--allow-uncaught",
+ "-async-only-a": "running/cli/#--async-only--a",
+ "-bail-b": "running/cli/#--bail--b",
+ "-check-leaks": "running/cli/#--check-leaks",
+ "-color-c-colors": "running/cli/#--color--c---colors",
+ "-compilers": "running/cli/#--compilers",
+ "-config-path": "running/cli/#--config-path",
+ "-diff": "running/cli/#--diff",
+ "-dry-run": "running/cli/#--dry-run",
+ "-enable-source-maps": "running/cli/#--enable-source-maps",
+ "-exit": "running/cli/#--exit",
+ "-extension-ext": "running/cli/#--extension-ext",
+ "-fail-zero": "running/cli/#--fail-zero",
+ "-fgrep-string-f-string": "running/cli/#--fgrep-string--f-string",
+ "-file-file": "running/cli/#--file-file",
+ "-forbid-only": "running/cli/#--forbid-only",
+ "-forbid-pending": "running/cli/#--forbid-pending",
+ "-full-trace": "running/cli/#--full-trace",
+ "-global-variable-name": "running/cli/#--global-variable-name",
+ "-grep-regexp-g-regexp": "running/cli/#--grep-regexp--g-regexp",
+ "-ignore-filedirectoryglob-exclude-filedirectoryglob":
+ "running/cli/#--ignore-filedirectoryglob---exclude-filedirectoryglob",
+ "-inline-diffs": "running/cli/#--inline-diffs",
+ "-inspect-inspect-brk-inspect":
+ "running/cli/#--inspect---inspect-brk-inspect",
+ "-invert": "running/cli/#--invert",
+ "-jobs-count-j-count": "running/cli/#--jobs-count--j-count",
+ "-node-option-name-n-name": "running/cli/#--node-option-name--n-name",
+ "-opts-path": "running/cli/#--opts-path",
+ "-package-path": "running/cli/#--package-path",
+ "-parallel-p": "running/cli/#--parallel--p",
+ "-pass-on-failing-test-suite": "running/cli/#--pass-on-failing-test-suite",
+ "-recursive": "running/cli/#--recursive",
+ "-reporter-name-r-name": "running/cli/#--reporter-name--r-name",
+ "-reporter-option-option-o-option-reporter-options-option":
+ "running/cli/#--reporter-option-option--o-option---reporter-options-option",
+ "-require-module-r-module": "running/cli/#--require-module--r-module",
+ "-retries-n": "running/cli/#--retries-n",
+ "-slow-ms-s-ms": "#--slow-ms--s-ms",
+ "-sort-s": "running/cli/#--sort--s",
+ "-timeout-ms-t-ms": "running/cli/#--timeout-ms--t-ms",
+ "-ui-name-u-name": "running/cli/#--ui-name--u-name",
+ "-watch-files-filedirectoryglob":
+ "running/cli/#--watch-files-filedirectoryglob",
+ "-watch-ignore-filedirectoryglob":
+ "running/cli/#--watch-ignore-filedirectoryglob",
+ "-watch-w": "running/cli/#--watch--w",
+ "about-node-flags": "running/cli/#about-node-flags",
+ "about-option-types": "running/cli/#about-option-types",
+ "about-v8-flags": "running/cli/#about-v8-flags",
+ "arrow-functions": "features/arrow-functions",
+ assertions: "features/assertions",
+ "asynchronous-code": "features/asynchronous-code",
+ "asynchronous-hooks": "features/hooks/#asynchronous-hooks",
+ "available-root-hooks": "features/root-hook-plugins/#available-root-hooks",
+ backers: "#backers",
+ "bail-is-best-effort": "features/parallel-mode/#bail-is-best-effort",
+ bdd: "interfaces/bdd",
+ "browser-configuration": "running/browsers/#browser-configuration",
+ "browser-specific-options": "running/browsers/#browser-specific-options",
+ "caveats-about-testing-in-parallel":
+ "features/parallel-mode/#caveats-about-testing-in-parallel",
+ "command-line-usage": "running/cli",
+ "configuration-format": "running/configuring/#configuration-format",
+ "configuring-mocha-nodejs": "running/configuring",
+ "current-limitations":
+ "explainers/nodejs-native-esm-support#current-limitations",
+ "custom-locations": "running/configuring/#custom-locations",
+ "defining-a-root-hook-plugin":
+ "features/root-hook-plugins#defining-a-root-hook-plugin",
+ "delayed-root-suite": "features/hooks/#root-level-hooks",
+ "describing-hooks": "features/hooks/#describing-hooks",
+ "detects-multiple-calls-to-done":
+ "explainers/detecting-multiple-calls-to-done",
+ diffs: "features/diffs",
+ doc: "reporters/doc",
+ "dot-matrix": "reporters/dot-matrix",
+ "dynamically-generating-tests": "declaring/dynamic-tests",
+ "editor-plugins": "running/editor-plugins",
+ emacs: "running/editor-plugins/#emacs",
+ "environment-variables": "running/configuring/#environment-variables",
+ "error-codes": "features/error-codes",
+ examples: "getting-started#next-steps",
+ "exclusive-tests": "declaring/exclusive-tests",
+ "exclusive-tests-are-disallowed":
+ "features/parallel-mode/#exclusive-tests-are-disallowed",
+ exports: "interfaces/exports",
+ "extending-configuration": "running/configuring/#extending-configuration",
+ "file-order-is-non-deterministic":
+ "features/parallel-mode/#file-order-is-non-deterministic",
+ "getting-started": "getting-started",
+ "global-fixtures": "features/global-fixtures",
+ "global-setup-fixtures": "features/global-fixtures/#global-setup-fixtures",
+ "global-teardown-fixtures":
+ "features/global-fixtures/#global-teardown-fixtures",
+ grep: "running/browsers/#grep",
+ "hook-level": "features/timeouts#hook-level",
+ hooks: "features/hooks",
+ "html-reporter": "reporters/html",
+ "ignoring-config-files": "running/configuring/#ignoring-config-files",
+ "inclusive-tests": "declaring/inclusive-tests",
+ installation: "getting-started#1-installation",
+ interfaces: "interfaces/about",
+ jetbrains: "running/editor-plugins/#jetbrains",
+ json: "reporters/json",
+ "json-stream": "reporters/json-stream",
+ "landing-strip": "reporters/landing",
+ "limitations-of-asynchronous-callbacks":
+ "features/asynchronous-code/#limitations-of-asynchronous-callbacks",
+ "limited-reporter-api-for-third-party-reporters":
+ "features/parallel-mode/#limited-reporter-api-for-third-party-reporters",
+ list: "reporters/list",
+ markdown: "reporters/markdown",
+ merging: "running/configuring/#merging",
+ "migrating-a-library-to-use-root-hook-plugins":
+ "features/root-hook-plugins#migrating-a-library-to-use-root-hook-plugins",
+ "migrating-tests-to-use-root-hook-plugins":
+ "features/root-hook-plugins#migrating-tests-to-use-root-hook-plugins",
+ min: "reporters/min",
+ "mocha-fixture-wizard": "explainers/test-fixture-decision-tree",
+ "mocha-fixture-wizard-diagram": "explainers/test-fixture-decision-tree",
+ "mocha-sidebar-vs-code": "running/editor-plugins/#mocha-sidebar-vs-code",
+ "more-information": "#more-information",
+ "multiple-root-hook-plugins":
+ "features/root-hook-plugins#multiple-root-hook-plugins",
+ "multiple-root-hooks-in-a-single-plugin":
+ "features/root-hook-plugins#multiple-root-hooks-in-a-single-plugin",
+ "no-browser-support": "features/parallel-mode/#no-browser-support",
+ "nodejs-native-esm-support": "explainers/nodejs-native-esm-support",
+ nyan: "reporters/nyan",
+ "options-that-differ-slightly-from-cli-options":
+ "running/browsers/#options-that-differ-slightly-from-cli-options",
+ "options-that-only-function-in-browser-context":
+ "running/browsers/#options-that-only-function-in-browser-context",
+ "parallel-mode": "explainers/run-cycle-overview#parallel-mode",
+ "parallel-mode-worker-ids":
+ "features/parallel-mode/#parallel-mode-worker-ids",
+ "parallel-tests": "features/parallel-mode",
+ "pending-tests": "declaring/pending-tests",
+ priorities: "running/configuring/#priorities",
+ progress: "reporters/progress",
+ qunit: "interfaces/qunit",
+ "reporter-limitations": "features/parallel-mode/#reporter-limitations",
+ reporters: "reporters/about",
+ reporting: "running/browsers/#reporting",
+ require: "interfaces/require",
+ "retry-tests": "declaring/retrying-tests",
+ "root-hook-plugins": "features/root-hook-plugins",
+ "root-hook-plugins-can-export-a-function":
+ "features/root-hook-plugins#root-hook-plugins-can-export-a-function",
+ "root-hooks-are-not-global":
+ "features/parallel-mode/#root-hooks-are-not-global",
+ "root-level-hooks": "features/hooks/#root-level-hooks",
+ "run-cycle-overview": "explainers/run-cycle-overview",
+ "running-mocha-in-the-browser": "running/browsers",
+ "serial-mode": "explainers/run-cycle-overview#serial-mode",
+ spec: "reporters/spec",
+ sponsors: "#sponsors",
+ "suite-level": "features/timeouts#suite-level",
+ "synchronous-code": "features/asynchronous-code/#synchronous-code",
+ tap: "reporters/tap",
+ tdd: "interfaces/tdd",
+ "test-duration": "explainers/test-duration",
+ "test-duration-variability":
+ "features/parallel-mode/#test-duration-variability",
+ "test-fixture-decision-tree-wizard-thing":
+ "explainers/test-fixture-decision-tree",
+ "test-level": "features/timeouts#test-level",
+ textmate: "running/editor-plugins/#textmate",
+ "the-test-directory": "running/test-globs",
+ "third-party-reporters": "reporters/third-party",
+ timeouts: "features/timeouts",
+ "troubleshooting-parallel-mode":
+ "features/parallel-mode/#no-browser-support",
+ "using-async-await": "features/asynchronous-code/#using-async--await",
+ wallabyjs: "running/editor-plugins/#wallabyjs",
+ "when-not-to-use-global-fixtures":
+ "features/global-fixtures/#when-not-to-use-global-fixtures",
+ "when-to-use-global-fixtures":
+ "features/global-fixtures/#when-to-use-global-fixtures",
+ "with-commonjs": "features/root-hook-plugins#with-commonjs",
+ "with-es-modules": "features/root-hook-plugins#with-es-modules",
+ "working-with-promises":
+ "features/asynchronous-code/#working-with-promises",
+ xunit: "reporters/xunit",
+ };
+
+ const hash = window.location.hash.slice(1);
+
+ if (Object.hasOwn(knownHashes, hash)) {
+ window.location.href = [
+ window.location.pathname,
+ knownHashes[hash as keyof typeof knownHashes],
+ ].join("/");
+ }
+</script>
diff --git a/docs-next/src/content/docs/features/diffs.mdx b/docs-next/src/content/docs/features/diffs.mdx
new file mode 100644
index 00000000..bd05e26d
--- /dev/null
+++ b/docs-next/src/content/docs/features/diffs.mdx
@@ -0,0 +1,10 @@
+---
+description: Displaying actual vs. expected data in test failures.
+title: Diffs
+---
+
+Mocha supports the `err.expected` and `err.actual` properties of any thrown `AssertionError`s from an assertion library.
+Mocha will attempt to display the difference between what was expected and what the assertion actually saw.
+Here's an example of a "string" diff using `--inline-diffs`:
+
+![string diffs](./reporter-string-diffs.png)
diff --git a/docs-next/src/content/docs/features/timeouts.mdx b/docs-next/src/content/docs/features/timeouts.mdx
index 4c28da72..fa0dc0cf 100644
--- a/docs-next/src/content/docs/features/timeouts.mdx
+++ b/docs-next/src/content/docs/features/timeouts.mdx
@@ -3,9 +3,7 @@ description: Managing timing for non-synchronous tests.
title: Timeouts
---
-## Timeouts
-
-### Suite-level
+## Suite-level
Suite-level timeouts may be applied to entire test "suites", or disabled via `this.timeout(0)`.
This will be inherited by all nested suites and test-cases that do not override the value.
@@ -24,7 +22,7 @@ describe("a suite of tests", function () {
});
```
-### Test-level
+## Test-level
Test-specific timeouts may also be applied, or the use of `this.timeout(0)` to disable timeouts all together:
@@ -35,7 +33,7 @@ it("should take less than 500ms", function (done) {
});
```
-### Hook-level
+## Hook-level
Hook-level timeouts may also be applied:
@@ -60,11 +58,3 @@ In v8.0.0 or newer, `this.enableTimeouts()` has been removed.
:::caution
With async tests if you disable timeouts via `this.timeout(0)` and then do not call `done()`, your test will exit silently.
:::
-
-## Diffs
-
-Mocha supports the `err.expected` and `err.actual` properties of any thrown `AssertionError`s from an assertion library.
-Mocha will attempt to display the difference between what was expected and what the assertion actually saw.
-Here's an example of a "string" diff using `--inline-diffs`:
-
-![string diffs](./reporter-string-diffs.png)
diff --git a/docs-next/src/content/docs/getting-started.mdx b/docs-next/src/content/docs/getting-started.mdx
index 9d4849ff..d4e07cdf 100644
--- a/docs-next/src/content/docs/getting-started.mdx
+++ b/docs-next/src/content/docs/getting-started.mdx
@@ -75,7 +75,7 @@ See:
- [Configuring](./running/configuring) for creating a persistent test configuration file
- [Editor Plugins](./running/editor-plugins) for improving the Mocha experience in your editor
-You can see real live live example code in our example repositories:
+You can see real live example code in our example repositories:
- [Mocha examples](https://github.com/mochajs/mocha-examples)
- [Express](https://github.com/visionmedia/express/tree/master/test)
diff --git a/docs-next/src/content/docs/index.mdx b/docs-next/src/content/docs/index.mdx
index 29235bae..6662ef58 100644
--- a/docs-next/src/content/docs/index.mdx
+++ b/docs-next/src/content/docs/index.mdx
@@ -11,6 +11,7 @@ import { Image } from "astro:assets";
import supporters from "../data/supporters.json";
import Badges from "../../components/Badges.astro";
+import ClientRedirects from "../../components/ClientRedirects.astro";
import Supporters from "../../components/Supporters.astro";
:::note[New Site Preview]
@@ -55,3 +56,5 @@ spies, mocking, and shared behaviours be sure to check out the [Mocha Wiki](http
For a running example of Mocha, view [example/tests.html](example/tests.html).
For the JavaScript API, view the [API documentation](/api) or the [source](https://github.com/mochajs/mocha/blob/main/lib/mocha.js).
+
+<ClientRedirects client:load />
diff --git a/docs-next/src/content/docs/interfaces/about.mdx b/docs-next/src/content/docs/interfaces/about.mdx
new file mode 100644
index 00000000..8411620e
--- /dev/null
+++ b/docs-next/src/content/docs/interfaces/about.mdx
@@ -0,0 +1,7 @@
+---
+description: Mocha's available DSLs for writing tests.
+title: About Interfaces
+---
+
+Interfaces are how developers write tests to be executed by Mocha.
+Mocha's "interface" system allows developers to choose their style of DSL (domain-specific language).
diff --git a/docs-next/src/content/docs/reporters/about.mdx b/docs-next/src/content/docs/reporters/about.mdx
new file mode 100644
index 00000000..24b44557
--- /dev/null
+++ b/docs-next/src/content/docs/reporters/about.mdx
@@ -0,0 +1,6 @@
+---
+description: How Mocha.js displays tests results as they execute and/or as a results summary.
+title: About Reporters
+---
+
+Mocha reporters adjust to the terminal window, and always disable ANSI-escape coloring when the stdio streams are not associated with a TTY.