chore(examples): lint examples/ using shared top-level eslint config; add lint:examples to 'npm run lint' (#2919)

trentm · web-flow · commit 74ddb1efb2ff · 2025-07-16T13:54:03.000-07:00
Refs: #2891
diff --git a/examples/.eslintrc b/examples/.eslintrc
diff --git a/examples/connect/client.js b/examples/connect/client.js
@@ -16,7 +16,6 @@
 
 'use strict';
 
-// eslint-disable-next-line import/order
 const tracing = require('./tracing')('example-connect-client');
 
 const { tracer } = tracing;
diff --git a/examples/connect/server.js b/examples/connect/server.js
@@ -16,7 +16,6 @@
 
 'use strict';
 
-// eslint-disable-next-line
 const tracing = require('./tracing')('example-connect-server');
 
 // Require in rest of modules
@@ -27,7 +26,6 @@ const axios = require('axios');
 const app = connect();
 const PORT = 8080;
 
-// eslint-disable-next-line prefer-arrow-callback
 app.use(function middleware1(req, res, next) {
   next();
 });
diff --git a/examples/dns/client.js b/examples/dns/client.js
@@ -18,7 +18,6 @@
 
 const api = require('@opentelemetry/api');
 const tracer = require('./tracer')('example-dns');
-// eslint-disable-next-line import/order
 const dns = require('dns').promises;
 
 /** A function which makes a dns lookup and handles response. */
diff --git a/examples/express/src/client.ts b/examples/express/src/client.ts
@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-// eslint-disable-next-line import/order, import/extensions
 import { setupTracing } from './tracer';
 
 import * as api from '@opentelemetry/api';
diff --git a/examples/express/src/server.ts b/examples/express/src/server.ts
@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-// eslint-disable-next-line import/order, import/extensions
 import { setupTracing } from './tracer';
 
 // Require in rest of modules
diff --git a/examples/express/src/tracer.ts b/examples/express/src/tracer.ts
@@ -36,7 +36,6 @@ import {
 import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 
-// eslint-disable-next-line import/prefer-default-export
 export const setupTracing = (serviceName: string) => {
   const exporter = new OTLPTraceExporter({});
   const provider = new NodeTracerProvider({
diff --git a/examples/fastify/server.js b/examples/fastify/server.js
@@ -16,7 +16,6 @@
 
 'use strict';
 
-// eslint-disable-next-line
 const api = require('@opentelemetry/api');
 const tracer = api.trace.getTracer('fastify-server');
 const Fastify = require('fastify');
@@ -32,7 +31,6 @@ async function subsystem(fastify) {
     span.setAttribute('order', 2);
   });
 
-  // eslint-disable-next-line prefer-arrow-callback
   fastify.addHook('onRequest', async function onRequestHook() {
     const span = api.trace.getSpan(api.context.active());
     span.setAttribute('order', 3);
diff --git a/examples/graphql/schema.js b/examples/graphql/schema.js
@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+/* eslint-disable no-unused-vars */
+
 'use strict';
 
 const https = require('https');
diff --git a/examples/grpc-census-prop/capitalize_client.js b/examples/grpc-census-prop/capitalize_client.js
@@ -17,7 +17,6 @@
 'use strict';
 
 const api = require('@opentelemetry/api');
-/* eslint-disable global-require */
 const binaryPropagator = process.env.BINARY_PROPAGATOR === 'true';
 const censusTracer = process.env.CENSUS_TRACER === 'true';
 let tracer;
diff --git a/examples/grpc-census-prop/capitalize_server.js b/examples/grpc-census-prop/capitalize_server.js
@@ -16,7 +16,6 @@
 
 'use strict';
 
-/* eslint-disable global-require */
 const binaryPropagator = process.env.BINARY_PROPAGATOR === 'true';
 const censusTracer = process.env.CENSUS_TRACER === 'true';
 
diff --git a/examples/hapi/client.js b/examples/hapi/client.js
@@ -16,7 +16,6 @@
 
 'use strict';
 
-// eslint-disable-next-line import/order
 const tracer = require('./tracer')('example-hapi-client');
 
 const api = require('@opentelemetry/api');
diff --git a/examples/hapi/server.js b/examples/hapi/server.js
@@ -19,7 +19,6 @@
 const api = require('@opentelemetry/api');
 require('./tracer')('example-hapi-server');
 
-// eslint-disable-next-line
 const Hapi = require('@hapi/hapi');
 
 const PORT = 8081;
diff --git a/examples/koa/src/client.ts b/examples/koa/src/client.ts
@@ -16,7 +16,6 @@
 
 import * as api from '@opentelemetry/api';
 import * as axios from 'axios';
-// eslint-disable-next-line import/extensions
 import { setupTracing } from './tracer';
 
 const tracer = setupTracing('example-koa-client');
diff --git a/examples/koa/src/server.ts b/examples/koa/src/server.ts
@@ -19,7 +19,6 @@ import * as api from '@opentelemetry/api';
 // Adding Koa router (if desired)
 import * as Router from '@koa/router';
 import * as Koa from 'koa';
-// eslint-disable-next-line import/extensions
 import { setupTracing } from './tracer';
 
 setupTracing('example-koa-server');
diff --git a/examples/koa/src/tracer.ts b/examples/koa/src/tracer.ts
@@ -28,7 +28,6 @@ import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
 
 const EXPORTER = process.env.EXPORTER || '';
 
-// eslint-disable-next-line import/prefer-default-export
 export const setupTracing = (serviceName: string) => {
   let exporter;
   if (EXPORTER === 'jaeger') {
diff --git a/examples/meta-node/client.js b/examples/meta-node/client.js
@@ -16,7 +16,6 @@
 
 'use strict';
 
-// eslint-disable-next-line import/order
 const tracer = require('./tracer')('example-express-client');
 const api = require('@opentelemetry/api');
 const axios = require('axios').default;
diff --git a/examples/meta-node/server.js b/examples/meta-node/server.js
@@ -16,7 +16,6 @@
 
 'use strict';
 
-// eslint-disable-next-line
 require('./tracer')('example-meta-node');
 
 // Require in rest of modules
diff --git a/examples/mongodb/src/client.ts b/examples/mongodb/src/client.ts
@@ -16,7 +16,6 @@
 
 import * as api from '@opentelemetry/api';
 import * as http from 'http';
-// eslint-disable-next-line import/extensions
 import { setupTracing } from './tracer';
 
 const tracer = setupTracing('example-mongodb-http-client');
diff --git a/examples/mongodb/src/server.ts b/examples/mongodb/src/server.ts
@@ -19,9 +19,7 @@ import * as http from 'http';
 import { IncomingMessage, ServerResponse } from 'http';
 import * as mongodb from 'mongodb';
 import { Collection } from 'mongodb';
-// eslint-disable-next-line import/extensions
 import { setupTracing } from './tracer';
-// eslint-disable-next-line import/extensions
 import { accessDB } from './utils';
 
 setupTracing('example-mongodb-server');
diff --git a/examples/mongodb/src/tracer.ts b/examples/mongodb/src/tracer.ts
@@ -25,7 +25,6 @@ import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 import { MongoDBInstrumentation } from '@opentelemetry/instrumentation-mongodb';
 import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
 
-// eslint-disable-next-line import/prefer-default-export
 export const setupTracing = (serviceName: string): api.Tracer => {
   const provider = new NodeTracerProvider({
     resource: new Resource({
diff --git a/examples/mongodb/src/utils.ts b/examples/mongodb/src/utils.ts
@@ -22,7 +22,6 @@ import * as mongodb from 'mongodb';
  * @param dbName The mongodb database name.
  * @param options The mongodb client config options.
  */
-// eslint-disable-next-line import/prefer-default-export
 export function accessDB(
   url: string,
   dbName: string,
diff --git a/examples/mysql/src/client.ts b/examples/mysql/src/client.ts
@@ -16,7 +16,6 @@
 
 import * as api from '@opentelemetry/api';
 import * as http from 'http';
-// eslint-disable-next-line import/extensions
 import { setupTracing } from './tracer';
 
 const tracer = setupTracing('example-mysql-client');
diff --git a/examples/mysql/src/server.ts b/examples/mysql/src/server.ts
@@ -18,7 +18,6 @@ import * as api from '@opentelemetry/api';
 import * as mysql from 'mysql';
 import * as http from 'http';
 import { MysqlError, PoolConnection } from 'mysql';
-// eslint-disable-next-line import/extensions
 import { setupTracing } from './tracer';
 
 setupTracing('example-mysql-server');
diff --git a/examples/mysql/src/tracer.ts b/examples/mysql/src/tracer.ts
@@ -37,7 +37,6 @@ const {
 
 const EXPORTER = process.env.EXPORTER || '';
 
-// eslint-disable-next-line import/prefer-default-export
 export const setupTracing = (serviceName: string) => {
   // metrics:
   const metricExporter = new OTLPMetricExporter();
diff --git a/examples/react-load/preact/.eslintrc.js b/examples/react-load/preact/.eslintrc.js
@@ -22,5 +22,6 @@ module.exports = {
   ...baseConfig,
   env: {
     browser: true,
+    node: true,
   },
 };
diff --git a/examples/react-load/preact/src/components/Content.js b/examples/react-load/preact/src/components/Content.js
@@ -27,7 +27,6 @@ class Content extends BaseOpenTelemetryComponent {
     };
   }
 
-  // eslint-disable-next-line class-methods-use-this
   componentDidMount() {
     // Example, do something here
   }
diff --git a/examples/react-load/preact/src/components/Home.js b/examples/react-load/preact/src/components/Home.js
@@ -20,7 +20,6 @@ import { Link } from 'preact-router/match';
 import { BaseOpenTelemetryComponent } from '@opentelemetry/plugin-react-load';
 
 class Home extends BaseOpenTelemetryComponent {
-  // eslint-disable-next-line class-methods-use-this
   render() {
     return (
       <div>
diff --git a/examples/react-load/react/.eslintrc.js b/examples/react-load/react/.eslintrc.js
@@ -22,5 +22,6 @@ module.exports = {
   ...baseConfig,
   env: {
     browser: true,
+    node: true,
   },
 };
diff --git a/examples/redis/src/client.ts b/examples/redis/src/client.ts
@@ -16,7 +16,6 @@
 
 import * as api from '@opentelemetry/api';
 import * as axios from 'axios';
-// eslint-disable-next-line import/extensions
 import { setupTracing } from './tracer';
 
 const tracer = setupTracing('example-redis-client');
diff --git a/examples/redis/src/server.ts b/examples/redis/src/server.ts
@@ -18,13 +18,10 @@
 import * as express from 'express';
 import * as axios from 'axios';
 import { randomBytes } from 'crypto';
-// eslint-disable-next-line import/extensions
 import { setupTracing } from './tracer';
-// eslint-disable-next-line import/extensions
 import * as tracerHandlers from './express-tracer-handlers';
 
 const tracer = setupTracing('example-redis-server');
-// eslint-disable-next-line import/extensions
 const { redisPromise } = require('./setup-redis');
 
 // Setup express
diff --git a/examples/redis/src/setup-redis.ts b/examples/redis/src/setup-redis.ts
@@ -17,7 +17,6 @@
 import { createClient } from 'redis';
 
 const client = createClient('redis://localhost:6379');
-// eslint-disable-next-line import/prefer-default-export
 export const redisPromise = new Promise((resolve, reject) => {
   client.once('ready', () => {
     resolve(client);
diff --git a/examples/redis/src/tracer.ts b/examples/redis/src/tracer.ts
@@ -27,7 +27,6 @@ import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
 
 const EXPORTER = process.env.EXPORTER || '';
 
-// eslint-disable-next-line import/prefer-default-export
 export const setupTracing = (serviceName: string) => {
   let exporter;
   if (EXPORTER.toLowerCase().startsWith('z')) {
diff --git a/examples/router/client.js b/examples/router/client.js
@@ -18,7 +18,6 @@
 
 // required to initialize the service name for the auto-instrumentation
 require('./tracer')('example-client');
-// eslint-disable-next-line import/order
 const http = require('http');
 
 /** A function which makes requests and handles response. */
diff --git a/examples/router/server.js b/examples/router/server.js
@@ -37,18 +37,15 @@ router.param('name', (req, res, next, name) => {
   next();
 });
 
-// eslint-disable-next-line prefer-arrow-callback
 router.get('/hello/:name', function greetingHandler(req, res) {
   res.setHeader('Content-Type', 'text/plain; charset=utf-8');
   res.end(`Hello, ${req.params.name}!`);
 });
 
-// eslint-disable-next-line prefer-arrow-callback
 router.get('/err', function erroringRoute(req, res, next) {
   next(new Error('Broken!'));
 });
 
-// eslint-disable-next-line prefer-arrow-callback, func-names
 const server = http.createServer(function (req, res) {
   router(req, res, error => {
     if (error) {
diff --git a/examples/web/.eslintrc.js b/examples/web/.eslintrc.js
@@ -22,5 +22,6 @@ module.exports = {
   ...baseConfig,
   env: {
     browser: true,
+    node: true,
   },
 };
diff --git a/examples/web/examples/document-load/index.js b/examples/web/examples/document-load/index.js
@@ -66,7 +66,6 @@ const tracer = provider.getTracer('example-document-load');
 
 const getData = url =>
   new Promise((resolve, reject) => {
-    // eslint-disable-next-line no-undef
     const req = new XMLHttpRequest();
     req.open('GET', url, true);
     req.send();
diff --git a/examples/web/examples/meta/index.js b/examples/web/examples/meta/index.js
@@ -73,7 +73,6 @@ function btnAddClick() {
 }
 
 function prepareClickEvents() {
-  // eslint-disable-next-line no-plusplus
   for (let i = 0; i < 5; i++) {
     btnAddClick();
   }
@@ -106,7 +105,7 @@ function onClick(navigate) {
 }
 
 function getData(url) {
-  return new Promise((resolve, _reject) => {
+  return new Promise(resolve => {
     const req = new XMLHttpRequest();
     req.open('GET', url, true);
     req.setRequestHeader('Content-Type', 'application/json');
diff --git a/examples/web/examples/user-interaction/index.js b/examples/web/examples/user-interaction/index.js
@@ -74,7 +74,6 @@ function btnAddClick() {
 }
 
 function prepareClickEvents() {
-  // eslint-disable-next-line no-plusplus
   for (let i = 0; i < 5; i++) {
     btnAddClick();
   }
@@ -107,7 +106,7 @@ function onClick(navigate) {
 }
 
 function getData(url) {
-  return new Promise((resolve, _reject) => {
+  return new Promise(resolve => {
     const req = new XMLHttpRequest();
     req.open('GET', url, true);
     req.setRequestHeader('Content-Type', 'application/json');
diff --git a/package.json b/package.json
@@ -23,11 +23,11 @@
     "test-services:stop": "docker compose -f ./test/docker-compose.yaml down",
     "test:with-services-env": "cross-env NODE_OPTIONS='-r dotenv/config' DOTENV_CONFIG_PATH=./test/test-services.env npm test",
     "changelog": "lerna-changelog",
-    "lint": "nx run-many -t lint && npm run lint:deps && npm run lint:readme && npm run lint:markdown && npm run lint:semconv-deps",
+    "lint": "nx run-many -t lint && npm run lint:deps && npm run lint:readme && npm run lint:markdown && npm run lint:semconv-deps && npm run lint:examples",
     "lint:fix": "nx run-many -t lint:fix && npm run lint:markdown:fix",
     "lint:deps": "npx --yes knip@5.33.3 --dependencies --production --tags=-knipignore",
-    "lint:examples": "eslint ./examples/**/*.js",
-    "lint:examples:fix": "eslint ./examples/**/*.js --fix",
+    "lint:examples": "./scripts/npm-run-in-examples.js --if-present lint",
+    "lint:examples:fix": "./scripts/npm-run-in-examples.js --if-present lint:fix",
     "lint:markdown": "markdownlint-cli2 $(git ls-files '*.md')",
     "lint:markdown:fix": "markdownlint-cli2 --fix $(git ls-files '*.md')",
     "lint:readme": "nx run-many -t lint:readme",
diff --git a/scripts/npm-run-in-examples.js b/scripts/npm-run-in-examples.js
