eslint configuration for getting-started examples (#2297)

* chore: add eslint config to getting-started * chore: apply lint on getting-started * chore: fix strict rule in getting-started lint config * chore: import examples eslintrc for getting-started eslint config * chore: rearrage lint scripts in package.json * chore: restore removed require from getting-started example * chore: remove duplicate require in getting-started
open-telemetry · Aug 23, 2021 · c62ea11 · c62ea11
1 parent 78a78c0
commit c62ea11
Show file tree

Hide file tree

Showing 14 changed files with 137 additions and 117 deletions.
diff --git a/examples/.eslintrc → examples/.eslintrc.json b/examples/.eslintrc → examples/.eslintrc.json
diff --git a/getting-started/.eslintrc.js b/getting-started/.eslintrc.js
@@ -0,0 +1,6 @@
+/* eslint-disable global-require */
+/* eslint-disable strict */
+
+module.exports = {
+  ...require('../examples/.eslintrc.json'),
+};
diff --git a/getting-started/example/app.js b/getting-started/example/app.js
@@ -1,40 +1,40 @@
-"use strict";
+'use strict';
 
-const PORT = process.env.PORT || "8080";
+const PORT = process.env.PORT || '8080';
 
-const express = require("express");
-const axios = require("axios");
+const express = require('express');
+const axios = require('axios');
 
 const app = express();
 
-app.get("/", (req, res) => {
+app.get('/', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/middle-tier`)
     .then(() => axios.get(`http://localhost:${PORT}/middle-tier`))
-    .then(result => {
+    .then((result) => {
       res.send(result.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/middle-tier", (req, res) => {
+app.get('/middle-tier', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/backend`)
     .then(() => axios.get(`http://localhost:${PORT}/backend`))
-    .then(result => {
+    .then((result) => {
       res.send(result.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/backend", (req, res) => {
-  res.send("Hello from the backend");
+app.get('/backend', (req, res) => {
+  res.send('Hello from the backend');
 });
 
 app.listen(parseInt(PORT, 10), () => {

diff --git a/getting-started/monitored-example/app.js b/getting-started/monitored-example/app.js
@@ -1,42 +1,43 @@
-"use strict";
+'use strict';
 
-const PORT = process.env.PORT || "8080";
+const PORT = process.env.PORT || '8080';
 
-const express = require("express");
-const axios = require("axios");
+const express = require('express');
+const axios = require('axios');
+
+const { countAllRequests } = require('./monitoring');
 
-const { countAllRequests } = require("./monitoring");
 const app = express();
 app.use(countAllRequests());
 
-app.get("/", (req, res) => {
+app.get('/', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/middle-tier`)
     .then(() => axios.get(`http://localhost:${PORT}/middle-tier`))
-    .then(result => {
+    .then((result) => {
       res.send(result.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/middle-tier", (req, res) => {
+app.get('/middle-tier', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/backend`)
     .then(() => axios.get(`http://localhost:${PORT}/backend`))
-    .then(result => {
+    .then((result) => {
       res.send(result.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/backend", (req, res) => {
-  res.send("Hello from the backend");
+app.get('/backend', (req, res) => {
+  res.send('Hello from the backend');
 });
 
 app.listen(parseInt(PORT, 10), () => {

diff --git a/getting-started/monitored-example/monitoring.js b/getting-started/monitored-example/monitoring.js
@@ -1,11 +1,11 @@
-"use strict";
- 
+'use strict';
+
 const { MeterProvider } = require('@opentelemetry/sdk-metrics-base');
 const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');
- 
-const prometheusPort = PrometheusExporter.DEFAULT_OPTIONS.port
-const prometheusEndpoint = PrometheusExporter.DEFAULT_OPTIONS.endpoint
- 
+
+const prometheusPort = PrometheusExporter.DEFAULT_OPTIONS.port;
+const prometheusEndpoint = PrometheusExporter.DEFAULT_OPTIONS.endpoint;
+
 const exporter = new PrometheusExporter(
   {
     startServer: true,
@@ -16,28 +16,25 @@ const exporter = new PrometheusExporter(
     );
   },
 );
- 
+
 const meter = new MeterProvider({
   exporter,
   interval: 1000,
 }).getMeter('your-meter-name');
- 
-const requestCount = meter.createCounter("requests", {
-  description: "Count all incoming requests"
+
+const requestCount = meter.createCounter('requests', {
+  description: 'Count all incoming requests',
 });
- 
+
 const boundInstruments = new Map();
-
-module.exports.countAllRequests = () => {
-  return (req, res, next) => {
-    if (!boundInstruments.has(req.path)) {
-      const labels = { route: req.path };
-      const boundCounter = requestCount.bind(labels);
-      boundInstruments.set(req.path, boundCounter);
-    }
-
-    boundInstruments.get(req.path).add(1);
-    next();
-  };
-};
 
+module.exports.countAllRequests = () => (req, res, next) => {
+  if (!boundInstruments.has(req.path)) {
+    const labels = { route: req.path };
+    const boundCounter = requestCount.bind(labels);
+    boundInstruments.set(req.path, boundCounter);
+  }
+
+  boundInstruments.get(req.path).add(1);
+  next();
+};
diff --git a/getting-started/traced-example/app.js b/getting-started/traced-example/app.js
@@ -1,40 +1,40 @@
-"use strict";
+'use strict';
 
-const PORT = process.env.PORT || "8080";
+const PORT = process.env.PORT || '8080';
 
-const express = require("express");
-const axios = require("axios");
+const express = require('express');
+const axios = require('axios');
 
 const app = express();
 
-app.get("/", (req, res) => {
+app.get('/', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/middle-tier`)
     .then(() => axios.get(`http://localhost:${PORT}/middle-tier`))
-    .then(result => {
+    .then((result) => {
       res.send(result.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/middle-tier", (req, res) => {
+app.get('/middle-tier', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/backend`)
     .then(() => axios.get(`http://localhost:${PORT}/backend`))
-    .then(result => {
+    .then((result) => {
       res.send(result.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/backend", (req, res) => {
-  res.send("Hello from the backend");
+app.get('/backend', (req, res) => {
+  res.send('Hello from the backend');
 });
 
 app.listen(parseInt(PORT, 10), () => {

diff --git a/getting-started/traced-example/tracing.js b/getting-started/traced-example/tracing.js
@@ -1,18 +1,18 @@
-"use strict";
+'use strict';
 
-const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
-const { SimpleSpanProcessor } = require("@opentelemetry/sdk-trace-base");
+const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
+const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
 const { Resource } = require('@opentelemetry/resources');
 const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions');
-const { ZipkinExporter } = require("@opentelemetry/exporter-zipkin");
+const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
 const { registerInstrumentations } = require('@opentelemetry/instrumentation');
 const { ExpressInstrumentation } = require('@opentelemetry/instrumentation-express');
 const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
 
 const provider = new NodeTracerProvider({
   resource: new Resource({
-    [SemanticResourceAttributes.SERVICE_NAME]: "getting-started",
-  })
+    [SemanticResourceAttributes.SERVICE_NAME]: 'getting-started',
+  }),
 });
 
 provider.addSpanProcessor(
@@ -21,8 +21,8 @@ provider.addSpanProcessor(
       // If you are running your tracing backend on another host,
       // you can point to it using the `url` parameter of the
       // exporter config.
-    })
-  )
+    }),
+  ),
 );
 
 provider.register();
@@ -35,4 +35,4 @@ registerInstrumentations({
   ],
 });
 
-console.log("tracing initialized");
+console.log('tracing initialized');
diff --git a/getting-started/ts-example/.eslintrc b/getting-started/ts-example/.eslintrc
@@ -0,0 +1,16 @@
+{
+  "plugins": ["@typescript-eslint", "node"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "rules": {
+    "@typescript-eslint/no-var-requires": 0,
+    "import/prefer-default-export": "off",
+    "import/extensions": [
+      "error",
+      "ignorePackages",
+      {
+        "": "never"
+      }
+    ]
+  }
+}
diff --git a/getting-started/ts-example/example/app.ts b/getting-started/ts-example/example/app.ts
@@ -1,38 +1,38 @@
-import * as express from "express";
-import axios from "axios";
+import * as express from 'express';
+import axios from 'axios';
 
-const PORT: string = process.env.PORT || "8080";
+const PORT: string = process.env.PORT || '8080';
 
 const app = express();
 
-app.get("/", (req, res) => {
+app.get('/', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/middle-tier`)
     .then(() => axios.get(`http://localhost:${PORT}/middle-tier`))
-    .then(response => {
+    .then((response) => {
       res.send(response.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/middle-tier", (req, res) => {
+app.get('/middle-tier', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/backend`)
     .then(() => axios.get(`http://localhost:${PORT}/backend`))
-    .then(response => {
+    .then((response) => {
       res.send(response.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/backend", (req, res) => {
-  res.send("Hello from the backend");
+app.get('/backend', (req, res) => {
+  res.send('Hello from the backend');
 });
 
 app.listen(parseInt(PORT, 10), () => {

diff --git a/getting-started/ts-example/monitored-example/app.ts b/getting-started/ts-example/monitored-example/app.ts
@@ -1,40 +1,40 @@
-import * as express from "express";
-import axios from "axios";
-
-const PORT: string = process.env.PORT || "8080";
+import * as express from 'express';
+import axios from 'axios';
 
 import { countAllRequests } from './monitoring';
+
+const PORT: string = process.env.PORT || '8080';
 const app = express();
 app.use(countAllRequests());
 
-app.get("/", (req, res) => {
+app.get('/', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/middle-tier`)
     .then(() => axios.get(`http://localhost:${PORT}/middle-tier`))
-    .then(result => {
+    .then((result) => {
       res.send(result.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/middle-tier", (req, res) => {
+app.get('/middle-tier', (req, res) => {
   axios
     .get(`http://localhost:${PORT}/backend`)
     .then(() => axios.get(`http://localhost:${PORT}/backend`))
-    .then(result => {
+    .then((result) => {
       res.send(result.data);
     })
-    .catch(err => {
+    .catch((err) => {
       console.error(err);
       res.status(500).send();
     });
 });
 
-app.get("/backend", (req, res) => {
-  res.send("Hello from the backend");
+app.get('/backend', (req, res) => {
+  res.send('Hello from the backend');
 });
 
 app.listen(parseInt(PORT, 10), () => {