docs: switch util.inherits to class extends

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing open issue: continues 🐛 Bug: remove util.inherits / convert to classes #5025
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Tweaks the page to mention extends instead of util.inherits.

Other parts of the page will need updating too. Out of scope for this.

🤎

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.40%. Comparing base (15fb31a) to head (5e31398).
⚠️ Report is 66 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5677      +/-   ##
==========================================
- Coverage   88.44%   88.40%   -0.04%     
==========================================
  Files          66       66              
  Lines        4794     4797       +3     
  Branches      978      982       +4     
==========================================
+ Hits         4240     4241       +1     
- Misses        554      556       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[mark-wiemer]

@JoshuaKGoldberg as an FYI this will mean the docs slightly don't match our actual releases, not even a beta release for this change is ready. I'm OK to merge if you are, but maybe we should at least get a beta for this, or add a disclaimer? Esp. if folks are still using v11, for which we don't have dedicated docs yet. (e.g. v11.mochajs.org)

[mark-wiemer]

Blocked on a beta release first

[mark-wiemer]

I'll try to act as an end-user with Mocha 11 and see if this class ... extends syntax "just works" and it was always viable. If not, no worries, we will have a beta release soon I'm sure :) We should add the "new in Mocha 12" admonition if it doesn't work in Mocha 11, of course.

[mark-wiemer]

class MyReporter(runner) { isn't valid syntax, I don't think! Even when trying to revisit this, I couldn't get the new pattern to work, we'll have to revise this. Ref https://github.com/mark-wiemer/hello-hello/tree/496f4640638d717287601fc60b4ddb5d86d62abc/packages/mocha/packages/custom-reporter

[JoshuaKGoldberg]

Confirmed on the failure:

 Exception during run: TypeError: Class constructor Base cannot be invoked without 'new'
    at new MyReporter (/Users/josh/repos/hello-hello/packages/mocha/packages/custom-reporter/my-old-reporter.cjs:5:24)
    at Mocha.run (/Users/josh/repos/hello-hello/packages/mocha/packages/custom-reporter/node_modules/mocha/lib/mocha.js:995:18)
    at singleRun (/Users/josh/repos/hello-hello/packages/mocha/packages/custom-reporter/node_modules/mocha/lib/cli/run-helpers.js:175:16)
    at async exports.handler (/Users/josh/repos/hello-hello/packages/mocha/packages/custom-reporter/node_modules/mocha/lib/cli/run.js:376:5)

Switching MyReporter to be an actual class fixes things:

class MyReporter extends mocha.reporters.Base {
  constructor(runner) {
    super(runner);
...

pass: add works
end: 1/1

[mark-wiemer]

@JoshuaKGoldberg I'll try to repro this shortly to make sure I fully understand stuff. In the meantime, let me know if you have ideas for how to draft a migration guide for this. We'll need one to close the backing issue :) Thanks for continuing this one!

stale