Merge branch 'main' into support-big-int-in-approximently

.github/workflows/browsers.yml

@@ -5,9 +5,9 @@ name: Browsers CI
 
 on:
   push:
-    branches: [ main, 4.x.x, 5.x.x ]
+    branches: [ main, 4.x.x ]
   pull_request:
-    branches: [ main, 4.x.x, 5.x.x ]
+    branches: [ main, 4.x.x ]
 
 jobs:
   build:
@@ -23,7 +23,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: ${{ matrix.browser-name }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
     - run: npm ci
     - run: npx playwright install --with-deps
     - run: npm run build --if-present

.github/workflows/node.js.yml

@@ -5,9 +5,9 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ main, 4.x.x, 5.x.x ]
+    branches: [ main, 4.x.x ]
   pull_request:
-    branches: [ main, 4.x.x, 5.x.x ]
+    branches: [ main, 4.x.x ]
 
 jobs:
   build:
@@ -17,17 +17,17 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 16 # to be removed 2023-09-11
-          - 18 # to be removed 2025-04-30
-          - 19 # to be removed 2023-06-01
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+          - 18      # to be removed 2025-04-30
+          - 20      # to be removed 2026-04-30
+          - latest
+        # See supported Node.js release schedule at https://github.com/nodejs/release#release-schedule
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm ci
     - run: npm run build --if-present
-    - run: npm test
+    - run: npm run test-node

.github/workflows/npm-publish.yml

@@ -1,7 +1,7 @@
 # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
 # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
 
-name: Node.js Package
+name: Publish to npm
 
 on:
   release:
@@ -11,37 +11,32 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
       - run: npm ci
+      - run: npx playwright install --with-deps
+      - run: npm run build --if-present
       - run: npm test
 
   publish-npm:
     needs: build
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
-          registry-url: https://registry.npmjs.org/
+          node-version: 22.x
+          registry-url: "https://registry.npmjs.org"
+          cache: "npm"
       - run: npm ci
-      - run: npm publish
+      - run: npm run build --if-present
+      - run: npm version ${TAG_NAME} --git-tag-version=false
         env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
-
-  publish-gpr:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 18
-          registry-url: https://npm.pkg.github.com/
-      - run: npm ci
-      - run: npm publish
+          TAG_NAME: ${{ github.ref_name }}
+      - run: npm publish --provenance --access public
         env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          NODE_AUTH_TOKEN: ${{ secrets.npm_secret }}

README.md

@@ -71,54 +71,36 @@ You can also use it within the browser; install via npm and use the `chai.js` fi
 Import the library in your code, and then pick one of the styles you'd like to use - either `assert`, `expect` or `should`:
 
 ```js
-var chai = require('chai');  
-var assert = chai.assert;    // Using Assert style
-var expect = chai.expect;    // Using Expect style
-var should = chai.should();  // Using Should style
-```
-
-### Pre-Native Modules Usage (_registers the chai testing style globally_)
-
-```js
-require('chai/register-assert');  // Using Assert style
-require('chai/register-expect');  // Using Expect style
-require('chai/register-should');  // Using Should style
-```
-
-### Pre-Native Modules Usage (_as local variables_)
-
-```js
-const { assert } = require('chai');  // Using Assert style
-const { expect } = require('chai');  // Using Expect style
-const { should } = require('chai');  // Using Should style
-should();  // Modifies `Object.prototype`
-
-const { expect, use } = require('chai');  // Creates local variables `expect` and `use`; useful for plugin use
+import { assert } from 'chai';  // Using Assert style
+import { expect } from 'chai';  // Using Expect style
+import { should } from 'chai';  // Using Should style
 ```
 
-### Native Modules Usage (_registers the chai testing style globally_)
+### Register the chai testing style globally
 
 ```js
 import 'chai/register-assert';  // Using Assert style
 import 'chai/register-expect';  // Using Expect style
 import 'chai/register-should';  // Using Should style
 ```
 
-### Native Modules Usage (_local import only_)
+### Import assertion styles as local variables
 
 ```js
 import { assert } from 'chai';  // Using Assert style
 import { expect } from 'chai';  // Using Expect style
 import { should } from 'chai';  // Using Should style
 should();  // Modifies `Object.prototype`
+
+import { expect, use } from 'chai';  // Creates local variables `expect` and `use`; useful for plugin use
 ```
 
 ### Usage with Mocha
 
 ```bash
-mocha spec.js -r chai/register-assert  # Using Assert style
-mocha spec.js -r chai/register-expect  # Using Expect style
-mocha spec.js -r chai/register-should  # Using Should style
+mocha spec.js --require chai/register-assert.js  # Using Assert style
+mocha spec.js --require chai/register-expect.js  # Using Expect style
+mocha spec.js --require chai/register-should.js  # Using Should style
 ```
 
 [Read more about these styles in our docs](http://chaijs.com/guide/styles/).

eslint.config.js

@@ -0,0 +1,12 @@
+import jsdoc from "eslint-plugin-jsdoc";
+
+export default [
+  jsdoc.configs["flat/recommended"],
+  {
+    rules: {
+      "jsdoc/require-param-description": "off",
+      "jsdoc/require-returns-description": "off",
+      "jsdoc/tag-lines": ["error", "any", { startLines: 1 }],
+    },
+  },
+];

lib/chai.js

@@ -15,22 +15,18 @@ import {assert} from './chai/interface/assert.js';
 
 const used = [];
 
-/*!
- * Assertion Error
- */
-
+// Assertion Error
 export {AssertionError};
 
 /**
  * # .use(function)
  *
  * Provides a way to extend the internals of Chai.
  *
- * @param {Function}
+ * @param {Function} fn
  * @returns {this} for chaining
- * @api public
+ * @public
  */
-
 export function use(fn) {
   const exports = {
     AssertionError,
@@ -50,38 +46,20 @@ export function use(fn) {
   return exports;
 };
 
-/*!
- * Utility Functions
- */
-
+// Utility Functions
 export {util};
 
-/*!
- * Configuration
- */
-
+// Configuration
 export {config};
 
-/*!
- * Primary `Assertion` prototype
- */
-
+// Primary `Assertion` prototype
 export * from './chai/assertion.js';
 
-/*!
- * Expect interface
- */
-
+// Expect interface
 export * from './chai/interface/expect.js';
 
-/*!
- * Should interface
- */
-
+// Should interface
 export * from './chai/interface/should.js';
 
-/*!
- * Assert interface
- */
-
+// Assert interface
 export * from './chai/interface/assert.js';