chore(eslint): lint examples/bunyan and prepare eslint confing for linting .js and .mjs files (#2567)

Refs: #2891

Author: trentm

eslint.config.js

@@ -5,10 +5,10 @@ module.exports = {
     "node",
     "prettier"
   ],
-  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+  extends: ["eslint:recommended", "plugin:prettier/recommended"],
   parser: "@typescript-eslint/parser",
   parserOptions: {
-    "project": "./tsconfig.json"
+    "project": null
   },
   rules: {
     "quotes": ["error", "single", { "avoidEscape": true }],
@@ -28,6 +28,11 @@ module.exports = {
   overrides: [
     {
       files: ['*.ts'],
+      // Enable typescript-eslint for ts files.
+      extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+      parserOptions: {
+        "project": "./tsconfig.json"
+      },
       rules: {
         "@typescript-eslint/no-floating-promises": "error",
         "@typescript-eslint/no-this-alias": "off",
@@ -49,21 +54,39 @@ module.exports = {
           }
         }],
         "@typescript-eslint/no-shadow": ["warn"],
+        "prefer-rest-params": "off",
       }
     },
     {
       files: ["test/**/*.ts"],
+      // Enable typescript-eslint for ts files.
+      extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+      parserOptions: {
+        "project": "./tsconfig.json"
+      },
       rules: {
         "no-empty": "off",
         "@typescript-eslint/ban-ts-ignore": "off",
+        "@typescript-eslint/ban-types": ["warn", {
+          "types": {
+            "Function": null,
+          }
+        }],
         "@typescript-eslint/no-empty-function": "off",
         "@typescript-eslint/no-explicit-any": "off",
         "@typescript-eslint/no-unused-vars": "off",
         "@typescript-eslint/no-var-requires": "off",
         "@typescript-eslint/no-shadow": ["off"],
         "@typescript-eslint/no-floating-promises": ["off"],
         "@typescript-eslint/no-non-null-assertion": ["off"],
-        "@typescript-eslint/explicit-module-boundary-types": ["off"]
+        "@typescript-eslint/explicit-module-boundary-types": ["off"],
+        "prefer-rest-params": "off",
+      }
+    },
+    {
+      files: ["*.mjs"],
+      parserOptions: {
+        sourceType: 'module',
       }
     }
   ]

examples/bunyan/.eslintrc.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+const baseConfig = require('../../eslint.config');
+
+module.exports = {
+  ...baseConfig,
+  env: {
+    node: true,
+  },
+};

examples/bunyan/app.js

@@ -28,7 +28,7 @@ const log = bunyan.createLogger({ name: 'myapp', level: 'debug' });
 log.debug({ foo: 'bar' }, 'hi');
 
 const tracer = otel.trace.getTracer('example');
-tracer.startActiveSpan('manual-span', (span) => {
+tracer.startActiveSpan('manual-span', span => {
   log.info('this record will have trace_id et al fields for the current span');
   span.end();
 });

examples/bunyan/app.mjs

@@ -21,13 +21,12 @@
 import { trace } from '@opentelemetry/api';
 import bunyan from 'bunyan';
 
-const log = bunyan.createLogger({name: 'myapp', level: 'debug'});
+const log = bunyan.createLogger({ name: 'myapp', level: 'debug' });
 
-log.debug({foo: 'bar'}, 'hi');
+log.debug({ foo: 'bar' }, 'hi');
 
 const tracer = trace.getTracer('example');
 tracer.startActiveSpan('manual-span', span => {
   log.info('this record will have trace_id et al fields for the current span');
   span.end();
 });
-

examples/bunyan/package.json

@@ -4,6 +4,8 @@
   "version": "0.1.0",
   "description": "Example of Bunyan integration with OpenTelemetry",
   "scripts": {
+    "lint": "eslint . --ext=ts,js,mjs",
+    "lint:fix": "eslint . --ext=ts,js,mjs --fix",
     "start": "node -r ./telemetry.js app.js"
   },
   "repository": {

examples/bunyan/telemetry.js

@@ -23,10 +23,16 @@
 // for viewing and analysis.
 
 const { NodeSDK, tracing, logs } = require('@opentelemetry/sdk-node');
-const { envDetector, hostDetector, processDetector } = require('@opentelemetry/resources');
+const {
+  envDetector,
+  hostDetector,
+  processDetector,
+} = require('@opentelemetry/resources');
 // api.diag.setLogger(new api.DiagConsoleLogger(), api.DiagLogLevel.DEBUG);
 
-const { BunyanInstrumentation } = require('@opentelemetry/instrumentation-bunyan');
+const {
+  BunyanInstrumentation,
+} = require('@opentelemetry/instrumentation-bunyan');
 
 const sdk = new NodeSDK({
   serviceName: 'bunyan-example',
@@ -40,18 +46,20 @@ const sdk = new NodeSDK({
     // default detector of the `NodeSDK`.
     hostDetector,
   ],
-  spanProcessor: new tracing.SimpleSpanProcessor(new tracing.ConsoleSpanExporter()),
-  logRecordProcessor: new logs.SimpleLogRecordProcessor(new logs.ConsoleLogRecordExporter()),
-  instrumentations: [
-    new BunyanInstrumentation(),
-  ],
+  spanProcessor: new tracing.SimpleSpanProcessor(
+    new tracing.ConsoleSpanExporter()
+  ),
+  logRecordProcessor: new logs.SimpleLogRecordProcessor(
+    new logs.ConsoleLogRecordExporter()
+  ),
+  instrumentations: [new BunyanInstrumentation()],
 });
 process.on('SIGTERM', () => {
   sdk
     .shutdown()
     .then(
       () => {},
-      (err) => console.log('warning: error shutting down OTel SDK', err),
+      err => console.log('warning: error shutting down OTel SDK', err)
     )
     .finally(() => process.exit(0));
 });