chore: lint api package (open-telemetry#771)

Co-Authored-By: Mark Wolff <[email protected]>

Author: dyladan

.circleci/config.yml

@@ -174,8 +174,8 @@ jobs:
           name: Check code style and linting
           command: npm run check
       - run:
-          name: Install API dependencies
-          command: lerna bootstrap --scope @opentelemetry/api --include-filtered-dependencies
+          name: Install doc dependencies
+          command: lerna bootstrap --no-ci --scope @opentelemetry/api --include-filtered-dependencies -- --only dev
       - run:
           name: Docs tests
           command: npm run docs-test
@@ -185,7 +185,7 @@ jobs:
             - out
       - run:
           name: Install minimal modules to lint examples
-          command: npm i -D eslint eslint-plugin-import eslint-config-airbnb-base
+          command: npm i --no-save eslint eslint-plugin-import eslint-config-airbnb-base
       - run:
           name: Lint examples
           command: npm run lint-examples

packages/opentelemetry-api/package.json

@@ -17,7 +17,7 @@
     "compile": "npm run version:update && tsc -p .",
     "fix": "gts fix",
     "docs-test": "linkinator docs/out --silent --skip david-dm.org",
-    "docs": "typedoc --tsconfig tsconfig.json",
+    "docs": "typedoc --tsconfig tsconfig.json --exclude test/**/*.ts",
     "prepare": "npm run compile"
   },
   "keywords": [

packages/opentelemetry-api/src/index.ts

@@ -25,26 +25,26 @@ export * from './metrics/BoundInstrument';
 export * from './metrics/Meter';
 export * from './metrics/MeterProvider';
 export * from './metrics/Metric';
+export * from './metrics/NoopMeter';
+export * from './metrics/NoopMeterProvider';
 export * from './trace/attributes';
 export * from './trace/Event';
 export * from './trace/instrumentation/Plugin';
 export * from './trace/link';
+export * from './trace/NoopSpan';
+export * from './trace/NoopTracer';
+export * from './trace/NoopTracerProvider';
 export * from './trace/Sampler';
-export * from './trace/span';
-export * from './trace/SpanOptions';
 export * from './trace/span_context';
 export * from './trace/span_kind';
+export * from './trace/span';
+export * from './trace/SpanOptions';
 export * from './trace/status';
 export * from './trace/TimedEvent';
-export * from './trace/tracer';
-export * from './trace/tracer_provider';
 export * from './trace/trace_flags';
 export * from './trace/trace_state';
-export * from './trace/NoopSpan';
-export * from './trace/NoopTracer';
-export * from './trace/NoopTracerProvider';
-export * from './metrics/NoopMeterProvider';
-export * from './metrics/NoopMeter';
+export * from './trace/tracer_provider';
+export * from './trace/tracer';
 
 export { Context } from '@opentelemetry/scope-base';
 

packages/opentelemetry-api/test/api/api.test.ts

@@ -15,7 +15,14 @@
  */
 
 import * as assert from 'assert';
-import api, { TraceFlags, NoopSpan, NoopTracerProvider, NoopTracer, SpanOptions, Span } from '../../src';
+import api, {
+  TraceFlags,
+  NoopSpan,
+  NoopTracerProvider,
+  NoopTracer,
+  SpanOptions,
+  Span,
+} from '../../src';
 
 describe('API', () => {
   const functions = [
@@ -27,7 +34,7 @@ describe('API', () => {
   ];
 
   it('should expose a tracer provider via getTracerProvider', () => {
-    const tracer =  api.trace.getTracerProvider();
+    const tracer = api.trace.getTracerProvider();
     assert.ok(tracer);
     assert.strictEqual(typeof tracer, 'object');
   });
@@ -46,7 +53,7 @@ describe('API', () => {
 
     it('should not crash', () => {
       functions.forEach(fn => {
-        const tracer =  api.trace.getTracerProvider();
+        const tracer = api.trace.getTracerProvider();
         try {
           ((tracer as unknown) as { [fn: string]: Function })[fn](); // Try to run the function
           assert.ok(true, fn);
@@ -60,16 +67,13 @@ describe('API', () => {
 
     it('should use the global tracer provider', () => {
       api.trace.initGlobalTracerProvider(new TestTracerProvider());
-      const tracer =  api.trace.getTracerProvider().getTracer('name');
+      const tracer = api.trace.getTracerProvider().getTracer('name');
       const span = tracer.startSpan('test');
       assert.deepStrictEqual(span, dummySpan);
     });
 
     class TestTracer extends NoopTracer {
-      startSpan(
-        name: string,
-        options?: SpanOptions | undefined
-      ): Span {
+      startSpan(name: string, options?: SpanOptions): Span {
         return dummySpan;
       }
     }

packages/opentelemetry-api/test/noop-implementations/noop-meter.test.ts

@@ -23,10 +23,9 @@ import {
   NOOP_BOUND_MEASURE,
   NOOP_COUNTER_METRIC,
   NOOP_GAUGE_METRIC,
-  NOOP_MEASURE_METRIC
+  NOOP_MEASURE_METRIC,
 } from '../../src';
 
-
 describe('NoopMeter', () => {
   it('should not crash', () => {
     const meter = new NoopMeterProvider().getMeter('test-noop');

packages/opentelemetry-api/test/noop-implementations/noop-span.test.ts

@@ -15,7 +15,13 @@
  */
 
 import * as assert from 'assert';
-import { CanonicalCode, INVALID_SPAN_ID, INVALID_TRACE_ID, NoopSpan, TraceFlags } from '../../src';
+import {
+  CanonicalCode,
+  INVALID_SPAN_ID,
+  INVALID_TRACE_ID,
+  NoopSpan,
+  TraceFlags,
+} from '../../src';
 
 describe('NoopSpan', () => {
   it('do not crash', () => {

packages/opentelemetry-api/tsconfig.json

@@ -5,7 +5,8 @@
     "outDir": "build"
   },
   "include": [
-    "src/**/*.ts"
+    "src/**/*.ts",
+    "test/**/*.ts"
   ],
   "typedocOptions": {
     "name": "OpenTelemetry API for JavaScript",