build: migrate from CommonJs to ESM

README.md

@@ -280,7 +280,7 @@ colorizeOutput: false
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   colorizeOutput: false
 };
 </pre>
@@ -326,7 +326,7 @@ errorsOnly: true
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   errorsOnly: true
 };
 </pre>
@@ -377,7 +377,7 @@ files:
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   files: [
     'file1.json',
     'file2.yaml'
@@ -436,7 +436,7 @@ ignoreFiles:
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   ignoreFiles: [
     '/my/apis/file1.yml'
   ]
@@ -489,7 +489,7 @@ limits:
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   limits: {
     warnings: 25
   }
@@ -542,7 +542,7 @@ logLevels:
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   logLevels: {
     root: 'error',
     'ibm-schema-description-exists': 'debug'
@@ -591,7 +591,7 @@ outputFormat: json
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   outputFormat: 'json'
 };
 </pre>
@@ -647,7 +647,7 @@ ruleset: my-custom-rules.yaml
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   ruleset: 'my-custom-rules.yaml'
 };
 </pre>
@@ -693,7 +693,7 @@ summaryOnly: true
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   summaryOnly: true
 };
 </pre>
@@ -746,7 +746,7 @@ produceQualityScore: true
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   produceQualityScore: true
 };
 </pre>
@@ -798,7 +798,7 @@ markdownReport: true
 </td>
 <td>
 <pre>
-module.exports = {
+export default {
   markdownReport: true
 };
 </pre>
@@ -814,13 +814,13 @@ and the [IBM OpenAPI Ruleset package](https://www.npmjs.com/package/@ibm-cloud/o
 Here is a simple example of what that might look like:
 
 ```js
-const ibmOpenapiRuleset = require('@ibm-cloud/openapi-ruleset');
-const { Spectral } = require('@stoplight/spectral-core');
+import ibmOpenapiRuleset from '@ibm-cloud/openapi-ruleset';
+import { Spectral } from '@stoplight/spectral-core';
 
-function async runSpectral(openapiDocument) {
+async function runSpectral(openapiDocument) {
   const spectral = new Spectral();
   spectral.setRuleset(ibmOpenapiRuleset);
-  results = await spectral.run(openapiDocument);
+  const results = await spectral.run(openapiDocument);
   console.log(results);
 }
 ```

docs/ibm-cloud-rules.md

@@ -844,11 +844,11 @@ For this reason, we must implement our custom ruleset using javascript instead o
 Here is our custom ruleset file (`.spectral.js`):
 
 ```javascript
-const ibmCloudValidationRules = require('@ibm-cloud/openapi-ruleset');                           // Note 1
-const { propertyCasingConvention } = require('@ibm-cloud/openapi-ruleset/src/functions');
-const { schemas } = require('@ibm-cloud/openapi-ruleset-utilities/src/collections');
+import ibmCloudValidationRules from '@ibm-cloud/openapi-ruleset';                               // Note 1
+import { propertyCasingConvention } from '@ibm-cloud/openapi-ruleset/src/functions';
+import { schemas } from '@ibm-cloud/openapi-ruleset-utilities/src/collections';
 
-module.exports = {
+export default {
   extends: ibmCloudValidationRules,
   rules: {
     'ibm-property-casing-convention': {                                                          // Note 2
@@ -869,7 +869,7 @@ module.exports = {
 ```
 Notes:
 1. This custom ruleset extends `@ibm-cloud/openapi-ruleset` and also references the `propertyCasingConvention` function and the
-`schemas` JSONPath collection, so we need to import each of these with `require` statements.  In addition, be sure to install
+`schemas` JSONPath collection, so we need to import each of these with `import` statements.  In addition, be sure to install
 the `@ibm-cloud/openapi-ruleset` package: `npm install @ibm-cloud/openapi-ruleset`.
 2. This custom rule is re-defining (overriding) the `ibm-property-casing-convention` rule from the `@ibm-cloud/openapi-ruleset` package
 so we need to use the same rule id (`ibm-property-casing-convention`).  Alternatively, we could have used a different rule id of our choosing,

eslint.config.mjs

@@ -13,7 +13,7 @@ export default [
     languageOptions: {
       globals: {
         ...globals.node,
-        ...globals.jest,
+        ...globals.vitest,
         ...globals.mocha,
       },
     },
@@ -22,8 +22,8 @@ export default [
     ...prettier,
     files: ['**/*.js'],
     languageOptions: {
-      ecmaVersion: 13,
-      sourceType: 'commonjs',
+      ecmaVersion: 2025,
+      sourceType: 'module',
       globals: {
         ...globals.node,
         ...globals.es2021,