@sentry/esbuild-plugin 0.0.1-alpha.0

package/LICENSE

@@ -0,0 +1,29 @@
+# MIT License
+
+Copyright (c) 2022, Sentry
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+- Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,43 @@
+<p align="center">
+  <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
+  </a>
+</p>
+
+# Sentry Esbuild Plugin (WIP)
+
+**WARNING: This package is work in progress! Use with caution and do not yet use it in production. We're happy to receive your feedback!**
+
+A esbuild plugin that provides release management features for Sentry:
+
+- Sourcemap upload
+- Release creation
+- Automatic release name discovery (based on CI environment - Vercel, AWS, Heroku, CircleCI, or current Git SHA)
+- Automatically association of errors with releases (Release injection)
+
+### Configuration
+
+Every plugin takes an options argument with the following properties:
+
+| Option         | Type                                                                                      | Required | Description                                                                                                                                                                                                                                                                         |
+| -------------- | ----------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| include        | `string`                                                                                  | required | A path that the plugin should scan recursively for source maps. It will upload all `.map` files and match associated `.js` files.                                                                                                                                                   |
+| org            | `string`                                                                                  | optional | The slug of the Sentry organization associated with the app.                                                                                                                                                                                                                        |
+| project        | `string`                                                                                  | optional | The slug of the Sentry project associated with the app.                                                                                                                                                                                                                             |
+| authToken      | `string`                                                                                  | optional | The authentication token to use for all communication with Sentry. Can be obtained from https://sentry.io/settings/account/api/auth-tokens/. Required scopes: `project:releases` (and `org:read` if `setCommits` option is used).                                                   |
+| url            | `string`                                                                                  | optional | The base URL of your Sentry instance. Defaults to https://sentry.io/, which is the correct value for SAAS customers.                                                                                                                                                                |
+| release        | `string`                                                                                  | optional | Unique identifier for the release. Defaults to automatically detected values for CI environments like Vercel, AWS, Heroku, CircleCI. If no such CI environment is detected, the plugin uses the git `HEAD`'s commit SHA. (**For `HEAD` option, requires access to the `git` CLI**). |
+| entries        | `(string \| RegExp)[] \| RegExp \| string \| function(absoluteFilePath: string): boolean` | optional | Filter for entry points that should be processed. By default, the release will be injected into all entry points.                                                                                                                                                                   |
+| ext            | `array`                                                                                   | optional | The file extensions to be considered for the sourcemaps upload. By default the following file extensions are processed: `js`, `map`, `jsbundle`, and `bundle`.                                                                                                                      |
+| finalize       | `boolean`                                                                                 | optional | Indicates whether Sentry release record should be automatically finalized (`date_released` timestamp added) after artifact upload. Defaults to `true`                                                                                                                               |
+| debug          | `boolean`                                                                                 | optional | Print useful debug information. Defaults to `false`.                                                                                                                                                                                                                                |
+| cleanArtifacts | `boolean`                                                                                 | optional | Remove all existing artifacts in the Sentry release before uploading sourcemaps. Defaults to `false`.                                                                                                                                                                               |
+| errorHandler   | `function(err: Error): void`                                                              | optional | Function that is called when an error occurs during rlease creation or sourcemaps upload. When this function is provided, thrown errors will not cause the process to abort. If you still want to abort the process you can throw an error in the function.                         |
+
+### More information
+
+- [Sentry Documentation](https://docs.sentry.io/quickstart/)
+- [Troubleshooting Sourcemaps](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/)
+- [Sentry CLI](https://docs.sentry.io/learn/cli/)
+- [Sentry Discord](https://discord.gg/Ww9hbqr)
+- [Sentry Stackoverflow](http://stackoverflow.com/questions/tagged/sentry)

package/dist/cjs/index.js

@@ -0,0 +1,13 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var bundlerPluginCore = require('@sentry/bundler-plugin-core');
+
+
+
+Object.defineProperty(exports, 'default', {
+	enumerable: true,
+	get: function () { return bundlerPluginCore.sentryEsbuildPlugin; }
+});
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export { sentryEsbuildPlugin as default } from '@sentry/bundler-plugin-core';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { sentryEsbuildPlugin as default } from "@sentry/bundler-plugin-core";
+export type { Options } from "@sentry/bundler-plugin-core";

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@sentry/esbuild-plugin",
+  "version": "0.0.1-alpha.0",
+  "description": "Official Sentry esbuild plugin",
+  "repository": "git@github.com:getsentry/sentry-javascript-bundler-plugins.git",
+  "homepage": "https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/esbuild-plugin",
+  "author": "Sentry",
+  "license": "MIT",
+  "keywords": [
+    "Sentry",
+    "esbuild",
+    "bundler",
+    "plugin"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "scripts": {
+    "build": "rimraf ./out && run-p build:rollup build:types",
+    "build:watch": "run-p build:rollup:watch build:types:watch",
+    "build:rollup": "rollup --config rollup.config.js",
+    "build:rollup:watch": "rollup --config rollup.config.js --watch --no-watch.clearScreen",
+    "build:types": "tsc --project types.tsconfig.json",
+    "build:types:watch": "tsc --project types.tsconfig.json --watch --preserveWatchOutput",
+    "build:npm": "npm pack",
+    "check:types": "run-p check:types:src check:types:test",
+    "check:types:src": "tsc --project ./src/tsconfig.json --noEmit",
+    "check:types:test": "tsc --project ./test/tsconfig.json --noEmit",
+    "test": "jest",
+    "lint": "eslint ./src ./test"
+  },
+  "dependencies": {
+    "@sentry/bundler-plugin-core": "0.0.1-alpha.0"
+  },
+  "devDependencies": {
+    "@babel/core": "7.18.5",
+    "@babel/preset-env": "7.18.2",
+    "@babel/preset-typescript": "7.17.12",
+    "@rollup/plugin-babel": "5.3.1",
+    "@rollup/plugin-commonjs": "22.0.1",
+    "@rollup/plugin-json": "4.1.0",
+    "@rollup/plugin-node-resolve": "13.3.0",
+    "@sentry-internal/eslint-config": "0.0.1-alpha.0",
+    "@sentry-internal/sentry-bundler-plugin-tsconfig": "0.0.1-alpha.0",
+    "@swc/core": "^1.2.205",
+    "@swc/jest": "^0.2.21",
+    "@types/jest": "^28.1.3",
+    "@types/node": "^18.6.3",
+    "eslint": "^8.18.0",
+    "jest": "^28.1.1",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^3.0.2",
+    "rollup": "2.75.7",
+    "typescript": "^4.7.4"
+  }
+}