rollbar 3.0.0-alpha.3 → 3.0.0-alpha.5

package/.eslintrc

@@ -3,21 +3,19 @@
   "extends": "eslint:recommended",
   "parserOptions": {
     "ecmafeatures": {
-      "modules": true
-    }
+      "modules": true,
+    },
   },
   "env": {
     // I write for browser
     "browser": true,
     // in CommonJS
-    "node": true
+    "node": true,
   },
-  "plugins": [
-  ],
   "globals": { "Promise": true },
   "rules": {
     "strict": 0,
-    "camelcase": [2, {"properties": "never"}],
+    "camelcase": [2, { "properties": "never" }],
     "quotes": [2, "single", "avoid-escape"],
     "no-underscore-dangle": 0,
     "no-useless-escape": 0,

package/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing to Rollbar.js
+
+Thank you for your interest in contributing to Rollbar.js! We welcome contributions from the community.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js version 18 or higher
+- npm
+
+### Setup
+
+1. Fork the repository on GitHub
+2. Clone your fork locally:
+   ```bash
+   git clone https://github.com/your-username/rollbar.js.git
+   cd rollbar.js
+   ```
+3. Install dependencies:
+   ```bash
+   npm install
+   ```
+4. Build the project:
+   ```bash
+   npm run build
+   ```
+
+## Development Workflow
+
+### Running Tests
+
+Run all tests:
+
+```bash
+npm test
+```
+
+Run only browser tests:
+
+```bash
+npm run test-browser
+```
+
+Run only server tests:
+
+```bash
+npm run test-server
+```
+
+### Code Style
+
+- We use ESLint for code quality. Run `npm run lint` before submitting
+- Code should follow the existing style patterns in the codebase
+- Use 2 spaces for indentation
+- Use single quotes for strings
+
+### Making Changes
+
+1. Create a feature branch from `master`:
+
+   ```bash
+   git checkout -b my-feature-name
+   ```
+
+2. Make your changes and ensure:
+   - All tests pass
+   - Code follows our style guidelines
+   - New features include appropriate tests
+   - Documentation is updated if needed
+   - Examples are updated if needed
+
+3. Commit your changes with a clear message:
+   ```bash
+   git commit -m "Add feature: description of what you added"
+   ```
+
+## Submitting a Pull Request
+
+1. Push your changes to your fork:
+
+   ```bash
+   git push origin my-feature-name
+   ```
+
+2. Open a pull request on GitHub against the `master` branch
+
+3. In your pull request description:
+   - Clearly describe what changes you've made
+   - Reference any related issues
+   - Include testing steps if applicable
+
+4. Wait for review and address any feedback
+
+## Reporting Issues
+
+- Use GitHub Issues to report bugs
+- Include as much detail as possible:
+  - Steps to reproduce
+  - Expected behavior
+  - Actual behavior
+  - Environment details (browser, Node.js version, etc.)
+
+## Questions?
+
+If you have questions, please:
+
+- Check existing issues and documentation
+- Open a GitHub issue for clarification
+- Email support@rollbar.com for urgent matters
+
+Thank you for contributing to Rollbar.js!

package/Gruntfile.cjs

@@ -7,9 +7,6 @@
 var glob = require('glob');
 var path = require('path');
 var pkg = require('./package.json');
-var fs = require('fs');
-
-var webpackConfig = require('./webpack.config.cjs');
 
 function findTests(context) {
   if (context !== 'browser') {
@@ -60,6 +57,13 @@ function buildGruntKarmaConfig(singleRun, tests, reporters) {
           served: true,
           watched: false,
         },
+        // Test fixture HTML files
+        {
+          pattern: 'test/fixtures/**/*.html',
+          included: true,
+          served: true,
+          watched: false,
+        },
       ],
     },
   };
@@ -110,70 +114,12 @@ module.exports = function (grunt) {
   }
 
   grunt.loadNpmTasks('grunt-karma');
-  grunt.loadNpmTasks('grunt-webpack');
-  grunt.loadNpmTasks('grunt-text-replace');
-
-  var rollbarJsSnippet = fs.readFileSync('dist/rollbar.snippet.js');
-  var rollbarjQuerySnippet = fs.readFileSync('dist/plugins/jquery.min.js');
 
   grunt.initConfig({
     pkg: pkg,
-    webpack: webpackConfig,
-
     karma: buildGruntKarmaConfig(singleRun, browserTests, reporters),
-
-    replace: {
-      snippets: {
-        src: [
-          '*.md',
-          'src/**/*.js',
-          'examples/*.+(html|js)',
-          'examples/*/*.+(html|js)',
-          'docs/**/*.md',
-        ],
-        overwrite: true,
-        replacements: [
-          // Main rollbar snippet
-          {
-            from: new RegExp(
-              '^(.*// Rollbar Snippet)[\n\r]+(.*[\n\r])*(.*// End Rollbar Snippet)',
-              'm',
-            ),
-            to: function (match, index, fullText, captures) {
-              captures[1] = rollbarJsSnippet;
-              return captures.join('\n');
-            },
-          },
-          // jQuery rollbar plugin snippet
-          {
-            from: new RegExp(
-              '^(.*// Rollbar jQuery Snippet)[\n\r]+(.*[\n\r])*(.*// End Rollbar jQuery Snippet)',
-              'm',
-            ),
-            to: function (match, index, fullText, captures) {
-              captures[1] = rollbarjQuerySnippet;
-              return captures.join('\n');
-            },
-          },
-          // README CI link
-          {
-            from: new RegExp(
-              '(https://github\\.com/rollbar/rollbar\\.js/workflows/Rollbar\\.js%20CI/badge\\.svg\\?branch=v)([0-9a-zA-Z.-]+)',
-            ),
-            to: function (match, index, fullText, captures) {
-              captures[1] = pkg.version;
-              return captures.join('');
-            },
-          },
-        ],
-      },
-    },
   });
-
-  grunt.registerTask('build', ['webpack', 'replace:snippets']);
-  grunt.registerTask('default', ['build']);
   grunt.registerTask('test', ['test-browser']);
-  grunt.registerTask('release', ['build', 'copyrelease']);
 
   grunt.registerTask('test-browser', function (target) {
     var karmaTask = 'karma' + (target ? ':' + target : '');
@@ -236,21 +182,4 @@ module.exports = function (grunt) {
       grunt.task.run('karma:' + testName);
     });
   });
-
-  grunt.registerTask('copyrelease', function createRelease() {
-    var version = pkg.version;
-    var builds = ['', '.umd'];
-
-    builds.forEach(function (buildName) {
-      var js = 'dist/rollbar' + buildName + '.js';
-      var minJs = 'dist/rollbar' + buildName + '.min.js';
-
-      var releaseJs = 'release/rollbar' + buildName + '-' + version + '.js';
-      var releaseMinJs =
-        'release/rollbar' + buildName + '-' + version + '.min.js';
-
-      grunt.file.copy(js, releaseJs);
-      grunt.file.copy(minJs, releaseMinJs);
-    });
-  });
 };

package/README.md

@@ -9,8 +9,8 @@
 </p>
 
 ![Build Status](https://github.com/rollbar/rollbar.js/workflows/Rollbar.js%20CI/badge.svg?tag=latest)
-[![Code Quality: Javascript](https://img.shields.io/lgtm/grade/javascript/g/rollbar/rollbar.js.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/rollbar/rollbar.js/context:javascript)
-[![Total Alerts](https://img.shields.io/lgtm/alerts/g/rollbar/rollbar.js.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/rollbar/rollbar.js/alerts)
+[![npm version](https://img.shields.io/npm/v/rollbar.svg)](https://www.npmjs.com/package/rollbar)
+[![npm downloads](https://img.shields.io/npm/dm/rollbar.svg)](https://www.npmjs.com/package/rollbar)
 
 ---
 
@@ -22,15 +22,56 @@
 - **Advanced search:** Filter items by many different properties. <a href="https://docs.rollbar.com/docs/search-items">Learn more about search</a>.
 - **Customizable notifications:** Rollbar supports several messaging and incident management tools where your team can get notified about errors and important events by real-time alerts. <a href="https://docs.rollbar.com/docs/notifications">Learn more about Rollbar notifications</a>.
 
-## Setup Instructions
+## Installation
 
-1. [Sign up for a Rollbar account](https://rollbar.com/signup).
-2. For client-side Javascript, follow the [Browser Quick Start](https://docs.rollbar.com/docs/javascript#section-quick-start-browser) instructions. For Node.js, follow the [Server Quick Start](https://docs.rollbar.com/docs/javascript#section-quick-start-server).
+Using npm:
+
+```bash
+npm install --save rollbar
+```
+
+Using yarn:
+
+```bash
+yarn add rollbar
+```
+
+For CDN/script tag installation, see [Quick Start → Browser](#browser)
+
+## Quick Start
+
+First, [**sign up for a Rollbar account**](https://rollbar.com/signup) if you haven't already.
+
+### Browser
+
+For the recommended snippet-based installation with automatic error capture and telemetry, see our [Browser JS – Quick Start documentation](https://docs.rollbar.com/docs/browser-js#quick-start).
+
+### Node.js
+
+```javascript
+const Rollbar = require('rollbar');
+
+const rollbar = new Rollbar({
+  accessToken: 'POST_SERVER_ITEM_ACCESS_TOKEN',
+  captureUncaught: true,
+  captureUnhandledRejections: true,
+  payload: { code_version: '1.0.0' },
+});
+
+// log a generic message and send to rollbar
+rollbar.log('Hello world!');
+```
+
+For **framework** integrations (**Express**, **Koa**, **Hapi**, and more), custom error handlers, and advanced configuration, see our [Node.js server configuration documentation](https://docs.rollbar.com/docs/nodejs#server-configuration).
 
 ## Usage and Reference
 
 For complete usage instructions and configuration reference, see our [Javascript SDK docs](https://docs.rollbar.com/docs/javascript).
 
+### Examples
+
+See the [examples directory](./examples/) for detailed integration examples with various frameworks and build tools including **React**, **Angular**, **Vue.js**, **Next.js**, and more.
+
 ## Release History & Changelog
 
 See our [Releases](https://github.com/rollbar/rollbar.js/releases) page for a list of all releases, including changes.
@@ -41,19 +82,6 @@ If you run into any issues, please email us at [support@rollbar.com](mailto:supp
 
 For bug reports, please [open an issue on GitHub](https://github.com/rollbar/rollbar.js/issues/new).
 
-## Developing
-
-To set up a development environment, you'll need Node.js and npm.
-
-2. `npm install -D`
-3. `make`
-
-To run the tests, run `make test`.
-
-## Contributing
+## Developing and Contributing
 
-1. [Fork it](https://github.com/rollbar/rollbar.js).
-2. Create your feature branch (`git checkout -b my-new-feature`).
-3. Commit your changes (`git commit -am 'Added some feature'`).
-4. Push to the branch (`git push origin my-new-feature`).
-5. Create a new Pull Request.
+For development setup, guidelines, and instructions on submitting pull requests, please see our [Contributing Guide](CONTRIBUTING.md).

package/bower.json

@@ -3,7 +3,6 @@
   "dependencies": {},
   "main": ["dist/rollbar.umd.js"],
   "ignore": [
-    "dist/*.nojson*",
     "dist/*.named-amd*",
     "docs",
     "src",