Setting up ESLint

.circleci/config.yml

@@ -126,25 +126,6 @@ browsers_unit_tests: &browsers_unit_tests
         command: if [ "$CIRCLE_NODE_VERSION" = "v12" ]; then npm run codecov:browser; fi
 
 jobs:
-  lint:
-    docker:
-      - image: node:12
-        environment:
-          NPM_CONFIG_UNSAFE_PERM: true
-    steps:
-      - checkout
-      - run:
-          name: Install minimal lint modules globally
-          command: npm i -g tslint lerna typescript tslint-consistent-codestyle tslint-microsoft-contrib
-      - run:
-          name: Install gts version 1.1.0 globally
-          command: npm i -g [email protected]
-      - run:
-          name: Symlink global modules into all lerna packages
-          command: lerna exec 'npm link tslint lerna typescript gts tslint-consistent-codestyle tslint-microsoft-contrib'
-      - run:
-          name: Check code style and linting
-          command: npm run lint
   node8:
     docker:
       - image: node:8
@@ -181,10 +162,6 @@ workflows:
   version: 2
   build:
     jobs:
-      - lint:
-          filters:
-            branches:
-              only: /.*/
       - node8
       - node10
       - node12

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: restore lerna
+        uses: actions/cache@master # must use unreleased master to cache multiple paths
+        id: cache
+        with:
+          path: |
+            node_modules
+            packages/*/node_modules
+            metapackages/*/node_modules
+          key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
+
+      - name: Bootstrap
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          npm install --only=dev --ignore-scripts
+          npx lerna bootstrap --no-ci --ignore-scripts -- --only=dev
+      - name: Lint
+        run: npm run lint

eslint.config.js

@@ -0,0 +1,49 @@
+module.exports = {
+  plugins: [
+    "@typescript-eslint",
+    "header"
+  ],
+  extends: [
+      "./node_modules/gts",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+      "project": "./tsconfig.json"
+  },
+  rules: {
+    "@typescript-eslint/no-this-alias": "off",
+    "eqeqeq": "off",
+    "prefer-rest-params": "off",
+    "@typescript-eslint/naming-convention": [
+        "error",
+        {
+          "selector": "memberLike",
+          "modifiers": ["private", "protected"],
+          "format": ["camelCase"],
+          "leadingUnderscore": "require"
+        }
+    ],
+    "@typescript-eslint/no-inferrable-types": ["error", { ignoreProperties: true }],
+    "arrow-parens": ["error", "as-needed"],
+    "prettier/prettier": ["error", { "singleQuote": true, "arrowParens": "avoid" }],
+    "node/no-deprecated-api": ["warn"],
+    "header/header": [2, "block", [{
+        pattern: / \* Copyright The OpenTelemetry Authors[\r\n]+ \*[\r\n]+ \* Licensed under the Apache License, Version 2\.0 \(the \"License\"\);[\r\n]+ \* you may not use this file except in compliance with the License\.[\r\n]+ \* You may obtain a copy of the License at[\r\n]+ \*[\r\n]+ \*      https:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0[\r\n]+ \*[\r\n]+ \* Unless required by applicable law or agreed to in writing, software[\r\n]+ \* distributed under the License is distributed on an \"AS IS\" BASIS,[\r\n]+ \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.[\r\n]+ \* See the License for the specific language governing permissions and[\r\n]+ \* limitations under the License\./gm,
+        template:
+        `\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the "License");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an "AS IS" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n `
+    }]]
+  },
+  overrides: [
+    {
+      "files": ["test/**/*.ts"],
+      "rules": {
+        "no-empty": "off",
+        "@typescript-eslint/ban-ts-ignore": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/no-var-requires": "off"
+      }
+    }
+  ]
+};

package.json

@@ -42,14 +42,16 @@
   "devDependencies": {
     "@commitlint/cli": "9.0.1",
     "@commitlint/config-conventional": "9.0.1",
+    "@typescript-eslint/eslint-plugin": "3.3.0",
+    "@typescript-eslint/parser": "3.3.0",
     "eslint": "7.4.0",
     "eslint-config-airbnb-base": "14.2.0",
+    "eslint-plugin-header": "3.0.0",
     "eslint-plugin-import": "2.22.0",
     "gts": "2.0.2",
     "husky": "4.2.5",
     "lerna": "3.22.1",
     "lerna-changelog": "1.0.1",
-    "tslint": "5.20.1",
     "typescript": "3.9.6"
   },
   "husky": {

packages/opentelemetry-test-utils/.eslintignore

@@ -0,0 +1 @@
+build

packages/opentelemetry-test-utils/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+    "env": {
+        "mocha": true,
+        "node": true
+    },
+    ...require('../../eslint.config.js')
+}

packages/opentelemetry-test-utils/package.json

@@ -5,8 +5,8 @@
   "description": "Test utilities.",
   "main": "build/testUtils.js",
   "scripts": {
-    "lint": "gts check",
-    "lint:fix": "gts fix",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
     "compile": "tsc -p .",
     "precompile": "tsc --version",
     "prepare": "npm run compile"
@@ -23,13 +23,14 @@
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme",
   "devDependencies": {
-    "@opentelemetry/api": "0.9.0",
-    "@opentelemetry/core": "0.9.0",
-    "@opentelemetry/tracing": "0.9.0",
     "gts": "2.0.2",
     "ts-node": "8.10.2",
     "tslint-consistent-codestyle": "1.16.0",
     "tslint-microsoft-contrib": "6.2.0",
     "typescript": "3.9.6"
-  }
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^0.9.0",
+    "@opentelemetry/core": "^0.9.0",
+    "@opentelemetry/tracing": "^0.9.0"  }
 }

packages/opentelemetry-test-utils/testUtils.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/.eslintignore

@@ -0,0 +1 @@
+build

plugins/node/opentelemetry-plugin-dns/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+    "env": {
+        "mocha": true,
+        "node": true
+    },
+    ...require('../../../eslint.config.js')
+}

plugins/node/opentelemetry-plugin-dns/package.json

@@ -9,8 +9,8 @@
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
     "tdd": "npm run test -- --watch-extensions ts --watch",
     "clean": "rimraf build/*",
-    "lint": "gts check",
-    "lint:fix": "gts fix",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
     "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
     "precompile": "tsc --version",
     "prepare": "npm run compile",

plugins/node/opentelemetry-plugin-dns/src/dns.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/src/enums/AddressFamily.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/src/enums/AttributeNames.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.
@@ -13,10 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-/**
- * Attributes Names according [OpenTelemetry attributes specs](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md)
- */
 export enum AttributeNames {
   COMPONENT = 'component',
   PEER_HOSTNAME = 'peer.hostname',

plugins/node/opentelemetry-plugin-dns/src/index.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/src/types.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/src/utils.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/src/version.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/test/functionals/dns-disable.test.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/test/functionals/dns-enable.test.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/test/functionals/utils.test.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.

plugins/node/opentelemetry-plugin-dns/test/integrations/dns-lookup.test.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2019, OpenTelemetry Authors
+/*
+ * 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.
@@ -33,7 +33,7 @@ const provider = new NodeTracerProvider({ logger });
 provider.addSpanProcessor(new SimpleSpanProcessor(memoryExporter));
 
 describe('dns.lookup()', () => {
-  before(function(done) {
+  before(function (done) {
     // mandatory
     if (process.env.CI) {
       plugin.enable(dns, provider, provider.logger);