Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#5,773 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
75/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
javascript, node.js
Domaine
documentation

Piste de recherche

Lisez docs/assertions.md, docs/helpers/ExpectHelper.md et astro.config.mjs autour de l’entrée citée dans la barre latérale ; comparez le fichier obsolète src/content/docs/helpers/expect.md à la page actuelle expect-helper. Mettez à jour les exemples d’Expect Helper pour qu’ils utilisent la configuration du package indiquée dans l’issue et faites pointer la barre latérale vers la page actuelle. Le travail est terminé lorsque les deux exemples de documentation fonctionnent avec la configuration du package 4.x et que la barre latérale renvoie vers la page actuelle.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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)

Langage dominant
JavaScript
Étoiles
4.2k
Forks
754
Merge moyen
2 j 6 h
PR mergées (30 j)
33

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de codeceptjs/CodeceptJS

Toutes les issues de codeceptjs/CodeceptJS

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.