feat!: yargs is now ESM first

BREAKING CHANGE: command names are not derived from modules passed to `command`.
BREAKING CHANGE: Supported Node.js versions are now ^20.19.0 || ^22.12.0 || >=23.
BREAKING CHANGE: singleton usage of yargs yargs.foo, yargs().argv, has been removed.

Author: Benjamin E. Coe

.eslintrc.json

@@ -6,8 +6,19 @@
       "rules": {
         "@typescript-eslint/no-var-requires": "off",
         "@typescript-eslint/no-unused-vars": "off",
-        "@typescript-eslint/no-explicit-any": "off"
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unsafe-function-type": "off",
+        "@typescript-eslint/no-empty-object-type": "off"
       }
     }
-  ]
+  ],
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "requireConfigFile": false,
+    "babelOptions": {
+      "babelrc": false,
+      "configFile": false,
+      "presets": ["@babel/preset-typescript"]
+    }
+  }
 }

.github/workflows/ci.yaml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [16, 18, 20]
+        node: [20, 22, 23]
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
@@ -29,31 +29,17 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 20
+          node-version: 23
       - run: npm install -g npm@8
       - run: npm install
       - run: npm test
-  esm:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [20]
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node }}
-      - run: npm install -g npm@8
-      - run: node --version
-      - run: npm install --engine-strict
-      - run: npm run test:esm
   deno:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 20
+          node-version: 22
       - run: npm install -g npm@8
       - run: npm install
       - run: npm run compile
@@ -69,7 +55,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 20
+          node-version: 22
       - run: npm install -g npm@8
       - run: npm install
       - run: npm test

.github/workflows/release-please.yml

@@ -20,7 +20,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 20
+          node-version: 22
       - run: npm install npm@latest -g
       - run: npm install
       - run: npm run compile
@@ -38,7 +38,7 @@ jobs:
         if: ${{ steps.release.outputs.release_created }}
       - uses: actions/setup-node@v1
         with:
-          node-version: 14
+          node-version: 22
           registry-url: 'https://external-dot-oss-automation.appspot.com/'
         if: ${{ steps.release.outputs.release_created }}
       - run: npm install

.gitignore

@@ -9,3 +9,5 @@ package-lock.json
 example.*
 .DS_Store
 .npmrc
+test-docs.cjs
+test-docs.mjs

.nycrc

@@ -8,7 +8,7 @@
     "html",
     "text"
   ],
-  "lines": 99,
+  "lines": 100,
   "branches": "96",
   "statements": "100"
 }

CHANGELOG.md

@@ -59,8 +59,8 @@ npm i yargs@next
 
 ```javascript
 #!/usr/bin/env node
-const yargs = require('yargs/yargs')
-const { hideBin } = require('yargs/helpers')
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
 const argv = yargs(hideBin(process.argv)).parse()
 
 if (argv.ships > 3 && argv.distance < 53.5) {
@@ -84,8 +84,8 @@ Retreat from the xupptumblers!
 
 ```javascript
 #!/usr/bin/env node
-const yargs = require('yargs/yargs')
-const { hideBin } = require('yargs/helpers')
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
 
 yargs(hideBin(process.argv))
   .command('serve [port]', 'start the server', (yargs) => {
@@ -143,22 +143,6 @@ yargs(Deno.args)
 
 > Note: If you use version tags in url then you also have to add `-deno` flag on the end, like `@17.7.2-deno`
 
-### ESM
-
-As of `v16`,`yargs` supports ESM imports:
-
-```js
-import yargs from 'yargs'
-import { hideBin } from 'yargs/helpers'
-
-yargs(hideBin(process.argv))
-  .command('curl <url>', 'fetch the contents of the URL', () => {}, (argv) => {
-    console.info(argv)
-  })
-  .demandCommand(1)
-  .parse()
-```
-
 ### Usage in Browser
 
 See examples of using yargs in the browser in [docs](/docs/browser.md).
@@ -184,7 +168,6 @@ Having problems? want to contribute? join our [community slack](http://devtoolsc
   * [Composing Your App Using Commands](/docs/advanced.md#commands)
   * [Building Configurable CLI Apps](/docs/advanced.md#configuration)
   * [Customizing Yargs' Parser](/docs/advanced.md#customizing)
-  * [Bundling yargs](/docs/bundling.md)
 * [Contributing](/contributing.md)
 
 ## Supported Node.js Versions