Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Docs: Expect helper config example fails in 4.x, and the sidebar links to the old 3.x page

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#5,773 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 2 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
75/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
javascript, node.js
Bereich
documentation

Rechercherichtung

Lies docs/assertions.md, docs/helpers/ExpectHelper.md und astro.config.mjs im Bereich des zitierten Sidebar-Eintrags; prüfe die veraltete src/content/docs/helpers/expect.md anhand der aktuellen expect-helper-Seite. Aktualisiere die Beispiele für Expect Helper so, dass sie die im Issue gezeigte Paketkonfiguration verwenden, und verweise in der Sidebar auf die aktuelle Seite. Fertig, wenn beide Dokumentationsbeispiele mit der Paketkonfiguration für 4.x funktionieren und die Sidebar auf die aktuelle Seite verweist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

In 4.x the Expect helper is no longer built in; it is the separate package @codeceptjs/expect-helper. The docs still show the 3.x config, which fails to load in 4.x.

1. The config example is wrong

https://codecept.io/helpers/expect-helper and the "Quick Assertions with Expect Helper" section of https://codecept.io/assertions both show:

helpers: {
  Playwright: { /* ... */ },
  ExpectHelper: {},
}

Without require, getHelperModuleName() in lib/container.js resolves the key to the built-in path ./helper/ExpectHelper, which doesn't exist in 4.x. Either of these works:

ExpectHelper: { require: '@codeceptjs/expect-helper' },
// or, because a key starting with @codeceptjs/ is used as the module name:
'@codeceptjs/expect-helper': {},

Sources:

  • docs/assertions.md (around line 100)
  • docs/helpers/ExpectHelper.md, which is generated from the JSDoc example in codeceptjs/expect-helper index.js ("Zero-configuration when paired with other helpers..."). The package's own README already shows the require form.

2. The sidebar links to the old 3.x page

The "Expect" item under Helpers points to https://codecept.io/helpers/expect, an older copy of the page (title "Expect", config Expect: {}). The current page is https://codecept.io/helpers/expect-helper, which the sidebar doesn't link to.

In codeceptjs/website:

  • astro.config.mjs:311: {label: 'Expect', link: 'helpers/expect'}
  • src/content/docs/helpers/expect.md is the stale page. expect-helper.md is the one synced from [email protected].

Environment: CodeceptJS 4.2.2, @codeceptjs/expect-helper 1.0.2

Created by AI agent (Claude Code)

Vorherrschende Sprache
JavaScript
Sterne
4.2k
Forks
754
Ø Merge
2 T. 6 Std.
Gemergte PRs (30 T.)
33

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus codeceptjs/CodeceptJS

Alle Issues in codeceptjs/CodeceptJS

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.