fix formatting and add/fix comments

Author: lobsterkatie

.eslintrc.js

@@ -1,3 +1,6 @@
+// Note: All paths are relative to the directory in which eslint is being run, rather than the directory where this file
+// lives
+
 module.exports = {
   root: true,
   env: {
@@ -7,15 +10,7 @@ module.exports = {
     ecmaVersion: 2018,
   },
   extends: ['@sentry-internal/sdk'],
-  ignorePatterns: [
-    'coverage/**',
-    'build/**',
-    'dist/**',
-    'esm/**',
-    'examples/**',
-    'scripts/**',
-    'test/manual/**',
-  ],
+  ignorePatterns: ['coverage/**', 'build/**', 'dist/**', 'esm/**', 'examples/**', 'scripts/**', 'test/manual/**'],
   overrides: [
     {
       files: ['*.ts', '*.tsx', '*.d.ts'],

packages/angular/tsconfig.json

@@ -1,7 +1,10 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
     "experimentalDecorators": true
   }
 }

packages/browser/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
   }
 }

packages/core/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
   }
 }

packages/gatsby/tsconfig.json

@@ -1,7 +1,10 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
     "esModuleInterop": true,
     "jsx": "react"
   }

packages/hub/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
   }
 }

packages/integrations/tsconfig.json

@@ -1,7 +1,10 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
     "esModuleInterop": true,
   }
 }

packages/minimal/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
   }
 }

packages/nextjs/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
   }
 }

packages/node/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
   }
 }

packages/react/tsconfig.json

@@ -1,7 +1,10 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
     "esModuleInterop": true,
     "jsx": "react"
   }

packages/serverless/tsconfig.json

@@ -1,7 +1,10 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
     "target": "ES2018",
   }
 }

packages/tracing/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
   }
 }

packages/types/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
   }
 }

packages/typescript/README.md

@@ -56,3 +56,5 @@ Add the following config files to your project's root directory:
   }
 }
 ```
+
+For an example of how to use this package in a monorepo, check out this package's own parent repo, https://github.com/getsentry/sentry-javascript.

packages/typescript/tslint.json

@@ -18,7 +18,7 @@
     "ban-ts-ignore": false,
     "increment-decrement": false,
     "promise-function-async": false,
-    "ban-types": [true, ["async", "Use Promises instead, it add a lot to bundle size."]],
+    "ban-types": [true, ["async", "Use Promises instead, as async/await adds a lot to bundle size."]],
     // These are too strict in tslint:all
     "comment-format": [true, "check-space"],
     "completed-docs": [
@@ -77,7 +77,8 @@
     "variable-name": [true, "check-format", "allow-leading-underscore", "ban-keywords"],
     "naming-convention": [
       true,
-      // this config will apply to properties AND methods, if you only need it for properties, use "property" instead of "member"
+      // This config will apply to properties AND methods. If you only need it for properties, use "property" instead of
+      // "member".
       { "type": "member", "modifiers": "protected", "leadingUnderscore": "require" },
       { "type": "member", "modifiers": "private", "leadingUnderscore": "require" }
     ],

packages/utils/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
   }
 }

packages/vue/tsconfig.json

@@ -1,7 +1,10 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
     "esModuleInterop": true,
   }
 }

packages/wasm/tsconfig.json

@@ -1,7 +1,10 @@
 {
   "extends": "../../tsconfig.json",
+
   "include": ["src/**/*"],
+
   "compilerOptions": {
+    // package-specific options
     "esModuleInterop": true,
   }
 }

tsconfig.json

@@ -4,6 +4,6 @@
   "compilerOptions": {
     "allowSyntheticDefaultImports": true,
     "types": ["node"],
-    "noErrorTruncation": true
+    "noErrorTruncation": true // move me up to @sentry/typescript
   }
 }