Should we migrate documentation examples to ESM?

[oscard0m]

In the context of migrating to Node 18, would make sense to plan the migration of code examples of README.md and other documentation files?

@octokit/js-community @octokit/maintainers

Context: octokit/request.js#609 (comment)

[wolfy1339]

Officially, the main entry point for NodeJS is still CommonJS.
One can still use ESM and it should pick up the right files

[oscard0m]

I guess the discussion is if we want to swap the "priority" of ESM over CJS or not in our docs. We can do something like this:

- const { request } = require("@octokit/request");
- // or: import { request } from "@octokit/request";
+ import { request } from "@octokit/request";
+ // or: const { request } = require("@octokit/request");

[wolfy1339]

A lot of modules are going that way, simply look through the PRs opened by renovate that are blocked by ESM. I think it's a good call to make

[gr2m]

I'm okay either way. Thanks for opening the discussion @oscard0m

[kfcampbell]

Perhaps prioritizing ESM would make docs changes ever so slightly quicker when we do convert to ESM fully. I would be good to ship Oscar's changes in octokit/request.js#609.